pygtk r3099 - in trunk/docs: . images reference
- From: gianmt svn gnome org
- To: svn-commits-list gnome org
- Subject: pygtk r3099 - in trunk/docs: . images reference
- Date: Sun, 1 Mar 2009 21:56:24 +0000 (UTC)
Author: gianmt
Date: Sun Mar 1 21:56:24 2009
New Revision: 3099
URL: http://svn.gnome.org/viewvc/pygtk?rev=3099&view=rev
Log:
2009-02-28 Gian Mario Tagliaretti <gianmt gnome org>
* pygtk-gtkprintsettings.xml:
* pygtk-gtksocket.xml:
* pygtk-gtkplug.xml:
* pygtk-gtkpagesetup.xml: Update docs to 2.14
* imaegs/*:
* Makefile.am:
* pygtk-gtk-constants.xml: Add new constants with new images.
Added:
trunk/docs/images/
trunk/docs/images/layout-btlr.png (contents, props changed)
trunk/docs/images/layout-btrl.png (contents, props changed)
trunk/docs/images/layout-lrbt.png (contents, props changed)
trunk/docs/images/layout-lrtb.png (contents, props changed)
trunk/docs/images/layout-rlbt.png (contents, props changed)
trunk/docs/images/layout-rltb.png (contents, props changed)
trunk/docs/images/layout-tblr.png (contents, props changed)
trunk/docs/images/layout-tbrl.png (contents, props changed)
Modified:
trunk/docs/Makefile.am
trunk/docs/reference/ChangeLog
trunk/docs/reference/pygtk-gtk-constants.xml
trunk/docs/reference/pygtk-gtkpagesetup.xml
trunk/docs/reference/pygtk-gtkplug.xml
trunk/docs/reference/pygtk-gtkprintsettings.xml
trunk/docs/reference/pygtk-gtksocket.xml
Modified: trunk/docs/Makefile.am
==============================================================================
--- trunk/docs/Makefile.am (original)
+++ trunk/docs/Makefile.am Sun Mar 1 21:56:24 2009
@@ -589,7 +589,7 @@
CSSdir = $(TARGET_DIR)
EXTRA_DIST = \
- cursors icons \
+ cursors icons images \
$(HTML_FILES) \
$(XMLFILES) \
$(XSLFILES) \
@@ -598,6 +598,7 @@
dist-hook:
rm -rf `find $(distdir)/cursors -name .svn`
rm -rf `find $(distdir)/icons -name .svn`
+ rm -rf `find $(distdir)/images -name .svn`
install-data-local:
installfiles=`echo $(srcdir)/html/*`; \
@@ -606,6 +607,7 @@
else \
$(mkinstalldirs) $(DESTDIR)$(TARGET_DIR) \
$(DESTDIR)$(TARGET_DIR)/icons \
+ $(DESTDIR)$(TARGET_DIR)/images \
$(DESTDIR)$(TARGET_DIR)/cursors; \
for i in $$installfiles; do \
echo '-- Installing '$$i ; \
@@ -617,6 +619,10 @@
echo '-- Installing '$$i ; \
$(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR)/icons; \
done; \
+ for i in $(srcdir)/images/*; do \
+ echo '-- Installing '$$i ; \
+ $(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR)/images; \
+ done; \
for i in $(srcdir)/cursors/*; do \
echo '-- Installing '$$i ; \
$(INSTALL_DATA) $$i $(DESTDIR)$(TARGET_DIR)/cursors; \
Added: trunk/docs/images/layout-btlr.png
==============================================================================
Binary file. No diff available.
Added: trunk/docs/images/layout-btrl.png
==============================================================================
Binary file. No diff available.
Added: trunk/docs/images/layout-lrbt.png
==============================================================================
Binary file. No diff available.
Added: trunk/docs/images/layout-lrtb.png
==============================================================================
Binary file. No diff available.
Added: trunk/docs/images/layout-rlbt.png
==============================================================================
Binary file. No diff available.
Added: trunk/docs/images/layout-rltb.png
==============================================================================
Binary file. No diff available.
Added: trunk/docs/images/layout-tblr.png
==============================================================================
Binary file. No diff available.
Added: trunk/docs/images/layout-tbrl.png
==============================================================================
Binary file. No diff available.
Modified: trunk/docs/reference/pygtk-gtk-constants.xml
==============================================================================
--- trunk/docs/reference/pygtk-gtk-constants.xml (original)
+++ trunk/docs/reference/pygtk-gtk-constants.xml Sun Mar 1 21:56:24 2009
@@ -48,6 +48,7 @@
<xref linkend="gtk-metric-type-constants" endterm="gtk-metric-type-constants-title"></xref>
<xref linkend="gtk-movement-step-constants" endterm="gtk-movement-step-constants-title"></xref>
<xref linkend="gtk-notebook-tab-constants" endterm="gtk-notebook-tab-constants-title"></xref>
+<xref linkend="gtk-number-up-layout-constants" endterm="gtk-number-up-layout-constants-title"></xref>
<xref linkend="gtk-object-flags-constants" endterm="gtk-object-flags-constants-title"></xref>
<xref linkend="gtk-orientation-constants" endterm="gtk-orientation-constants-title"></xref>
<xref linkend="gtk-pack-direction-constants" endterm="gtk-pack-direction-constants-title"></xref>
@@ -1635,6 +1636,113 @@
</refsect2>
+ <refsect2 id="gtk-number-up-layout-constants">
+ <title id="gtk-number-up-layout-constants-title">GTK Number Up Layout Constants</title>
+
+ <para>Used to determine the layout of pages on a sheet when printing
+ multiple pages per sheet.</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><literal>gtk.NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_TOP_TO_BOTTOM</literal></term>
+ <listitem>
+ <simpara>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/layout-lrtb.png" format="png"/>
+ </imageobject>
+ </inlinemediaobject>
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gtk.NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_BOTTOM_TO_TOP</literal></term>
+ <listitem>
+ <simpara>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/layout-lrbt.png" format="png"/>
+ </imageobject>
+ </inlinemediaobject>
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gtk.NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_TOP_TO_BOTTOM</literal></term>
+ <listitem>
+ <simpara>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/layout-rltb.png" format="png"/>
+ </imageobject>
+ </inlinemediaobject>
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gtk.NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_BOTTOM_TO_TOP</literal></term>
+ <listitem>
+ <simpara>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/layout-lrbt.png" format="png"/>
+ </imageobject>
+ </inlinemediaobject>
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gtk.NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_LEFT_TO_RIGHT</literal></term>
+ <listitem>
+ <simpara>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/layout-tblr.png" format="png"/>
+ </imageobject>
+ </inlinemediaobject>
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gtk.NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_RIGHT_TO_LEFT</literal></term>
+ <listitem>
+ <simpara>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/layout-tbrl.png" format="png"/>
+ </imageobject>
+ </inlinemediaobject>
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gtk.NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_LEFT_TO_RIGHT</literal></term>
+ <listitem>
+ <simpara>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/layout-btlr.png" format="png"/>
+ </imageobject>
+ </inlinemediaobject>
+ </simpara>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><literal>gtk.NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_RIGHT_TO_LEFT</literal></term>
+ <listitem>
+ <simpara>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/layout-btrl.png" format="png"/>
+ </imageobject>
+ </inlinemediaobject>
+ </simpara>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ </refsect2>
+
<refsect2 id="gtk-object-flags-constants">
<title id="gtk-object-flags-constants-title">GTK Object Flags Constants</title>
Modified: trunk/docs/reference/pygtk-gtkpagesetup.xml
==============================================================================
--- trunk/docs/reference/pygtk-gtkpagesetup.xml (original)
+++ trunk/docs/reference/pygtk-gtkpagesetup.xml Sun Mar 1 21:56:24 2009
@@ -100,6 +100,10 @@
<methodname><link linkend="method-gtkpagesetup--to-file">to_file</link></methodname>
<methodparam><parameter role="keyword">file_name</parameter></methodparam>
</methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkpagesetup--load-file">load_file</link></methodname>
+ <methodparam><parameter role="keyword">file_name</parameter></methodparam>
+ </methodsynopsis>
</classsynopsis>
<programlisting>
@@ -795,6 +799,37 @@
</refsect2>
+ <refsect2 id="method-gtkpagesetup--laod-file">
+ <title>gtk.PageSetup.load_file</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>load_file</methodname>
+ <methodparam><parameter role="keyword">file_name</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">file_name</parameter> :</term>
+ <listitem><simpara>the filename to read the page setup from.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>True on success.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>load_file</methodname>() method
+ Reads the page setup from the file file_name. See
+ <methodname><link linkend="method-gtkpagesetup--to-file">to_file</link></methodname>.
+ </para>
+
+ </refsect2>
+
</refsect1>
<refsect1>
Modified: trunk/docs/reference/pygtk-gtkplug.xml
==============================================================================
--- trunk/docs/reference/pygtk-gtkplug.xml (original)
+++ trunk/docs/reference/pygtk-gtkplug.xml Sun Mar 1 21:56:24 2009
@@ -34,7 +34,11 @@
<methodparam></methodparam> </methodsynopsis>
<methodsynopsis language="python">
- <methodname><link linkend="method-gtksocket--get-plug-window">get_plug_window</link></methodname>
+ <methodname><link linkend="method-gtksocket--get-embedded">get_embedded</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtksocket--get-socket-window">get_socket_window</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
</classsynopsis>
@@ -240,25 +244,54 @@
linkend="method-gtksocket--add-id"><methodname>gtk.Socket.add_id</methodname>()</link>.</para>
</refsect2>
+
+ <refsect2 id="method-gtksocket--get-embedded">
+ <title>gtk.Socket.get_embedded</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_embedded</methodname>
+ <methodparam></methodparam> </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara><literal>True</literal> if the plug is embedded in
+ a socket.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_embedded</methodname>() method determines whether
+ the plug is embedded in a socket.
+ </para>
+
+ </refsect2>
+
- <refsect2 id="method-gtksocket--get-plug-window">
- <title>gtk.Socket.get_plug_window</title>
+ <refsect2 id="method-gtksocket--get-socket-window">
+ <title>gtk.Socket.get_socket_window</title>
<programlisting><methodsynopsis language="python">
- <methodname>get_plug_window</methodname>
+ <methodname>get_socket_window</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
- <listitem><simpara>the window of the plug if available, or
+ <listitem><simpara>the window of the socket if available, or
<literal>None</literal>.</simpara></listitem>
</varlistentry>
</variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
<para>
- The <methodname>get_plug_window</methodname>() method retrieves the
- window of the plug. Use this to check if the plug has been created
- inside of the socket.
+ The <methodname>get_socket_window</methodname>() method retrieves the
+ socket the plug is embedded in.
</para>
</refsect2>
Modified: trunk/docs/reference/pygtk-gtkprintsettings.xml
==============================================================================
--- trunk/docs/reference/pygtk-gtkprintsettings.xml (original)
+++ trunk/docs/reference/pygtk-gtkprintsettings.xml Sun Mar 1 21:56:24 2009
@@ -276,6 +276,18 @@
<methodname><link linkend="method-gtkprintsettings--to-file">to_file</link></methodname>
<methodparam><parameter role="keyword">file_name</parameter></methodparam>
</methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkprintsettings--get-number-up-layout">get_number_up_layout</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkprintsettings--set-number-up-layout">set_number_up_layout</link></methodname>
+ <methodparam><parameter role="keyword">number_up_layout</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkprintsettings--load-file">load_file</link></methodname>
+ <methodparam><parameter role="keyword">file_name</parameter></methodparam>
+ </methodsynopsis>
</classsynopsis>
<programlisting>
@@ -1988,6 +2000,84 @@
</refsect2>
+ <refsect2 id="method-gtkprintsettings--get-number-up-layout">
+ <title>gtk.PrintSettings.get_number_up_layout</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_number_up_layout</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>layout of page in number-up mode.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.16 and above.</para>
+ </note>
+
+ <para></para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkprintsettings--set-number-up-layout">
+ <title>gtk.PrintSettings.set_number_up_layout</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_number_up_layout</methodname>
+ <methodparam><parameter role="keyword">number_up_layout</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">number_up_layout</parameter> :</term>
+ <listitem><simpara>a
+ <methodname><link linkend="gtk-number-up-layout-constants">GtkNumberUpLayout</link></methodname>
+ constant value.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.16 and above.</para>
+ </note>
+
+ <para>Sets the value of <link linkend="gtk-number-up-layout-constants">GtkNumberUpLayout</link>.</para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkprintsettings--load-file">
+ <title>gtk.PrintSettings.load_file</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>load_file</methodname>
+ <methodparam><parameter role="keyword">file_name</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">file_name</parameter> :</term>
+ <listitem><simpara>the filename to read the settings from.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara><literal>True</literal> on success.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.16 and above.</para>
+ </note>
+
+ <para>
+ Reads the print settings from file_name. See
+ <methodname><link linkend="method-gtkprintsettings--to-file">gtk.PrintSettings.to_file</link></methodname>.
+ </para>
+
+ </refsect2>
+
</refsect1>
<refsect1>
Modified: trunk/docs/reference/pygtk-gtksocket.xml
==============================================================================
--- trunk/docs/reference/pygtk-gtksocket.xml (original)
+++ trunk/docs/reference/pygtk-gtksocket.xml Sun Mar 1 21:56:24 2009
@@ -29,6 +29,12 @@
<methodname><link
linkend="method-gtksocket--get-id">get_id</link></methodname>
<methodparam></methodparam> </methodsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtksocket--get-plug-window">get_plug_window</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+
</classsynopsis>
</refsect1>
@@ -236,6 +242,28 @@
</refsect2>
+ <refsect2 id="method-gtksocket--get-plug-window">
+ <title>gtk.Socket.get_plug_window</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_plug_window</methodname>
+ <methodparam></methodparam> </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the window of the plug if available, or
+ <literal>None</literal>.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>get_plug_window</methodname>() method retrieves the
+ window of the plug. Use this to check if the plug has been created
+ inside of the socket.
+ </para>
+
+ </refsect2>
+
</refsect1>
<refsect1>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
