diff options
author | Gian Mario Tagliaretti <gianmt@gnome.org> | 2009-03-01 23:48:10 +0000 |
---|---|---|
committer | Gian Mario Tagliaretti <gianmt@src.gnome.org> | 2009-03-01 23:48:10 +0000 |
commit | d2e1b7cd9d26254bbfe26de8fbee37de12cf424e (patch) | |
tree | 84cd0384f2c0b393303fe007212d3b77f064802c /docs | |
parent | c04ddb4ec409a8ee2d8389219c5c587f6482c2fc (diff) | |
download | pygtk-d2e1b7cd9d26254bbfe26de8fbee37de12cf424e.tar.gz |
Update docs to 2.14
2009-03-01 Gian Mario Tagliaretti <gianmt@gnome.org>
* pygtk-gtktoolitem.xml:
* pygtk-gtktooltip.xml:
* pygtk-gtk-stock-items.xml:
* pygtk-gtkselectiondata.xml: Update docs to 2.14
svn path=/trunk/; revision=3101
Diffstat (limited to 'docs')
-rw-r--r-- | docs/icons/stock_page_setup_24.png | bin | 0 -> 1081 bytes | |||
-rw-r--r-- | docs/icons/stock_print_error_24.png | bin | 0 -> 1130 bytes | |||
-rw-r--r-- | docs/icons/stock_print_paused_24.png | bin | 0 -> 1096 bytes | |||
-rw-r--r-- | docs/icons/stock_print_report_24.png | bin | 0 -> 1154 bytes | |||
-rw-r--r-- | docs/icons/stock_print_warning_24.png | bin | 0 -> 1099 bytes | |||
-rw-r--r-- | docs/reference/ChangeLog | 7 | ||||
-rw-r--r-- | docs/reference/pygtk-gtk-stock-items.xml | 55 | ||||
-rw-r--r-- | docs/reference/pygtk-gtkselectiondata.xml | 142 | ||||
-rw-r--r-- | docs/reference/pygtk-gtktoolitem.xml | 30 | ||||
-rw-r--r-- | docs/reference/pygtk-gtktooltip.xml | 37 |
10 files changed, 271 insertions, 0 deletions
diff --git a/docs/icons/stock_page_setup_24.png b/docs/icons/stock_page_setup_24.png Binary files differnew file mode 100644 index 00000000..9acf0d5f --- /dev/null +++ b/docs/icons/stock_page_setup_24.png diff --git a/docs/icons/stock_print_error_24.png b/docs/icons/stock_print_error_24.png Binary files differnew file mode 100644 index 00000000..28517473 --- /dev/null +++ b/docs/icons/stock_print_error_24.png diff --git a/docs/icons/stock_print_paused_24.png b/docs/icons/stock_print_paused_24.png Binary files differnew file mode 100644 index 00000000..da6df48a --- /dev/null +++ b/docs/icons/stock_print_paused_24.png diff --git a/docs/icons/stock_print_report_24.png b/docs/icons/stock_print_report_24.png Binary files differnew file mode 100644 index 00000000..13304368 --- /dev/null +++ b/docs/icons/stock_print_report_24.png diff --git a/docs/icons/stock_print_warning_24.png b/docs/icons/stock_print_warning_24.png Binary files differnew file mode 100644 index 00000000..dd70e0be --- /dev/null +++ b/docs/icons/stock_print_warning_24.png diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 5d036b23..1f7a5457 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,10 @@ +2009-03-01 Gian Mario Tagliaretti <gianmt@gnome.org> + + * pygtk-gtktoolitem.xml: + * pygtk-gtktooltip.xml: + * pygtk-gtk-stock-items.xml: + * pygtk-gtkselectiondata.xml: Update docs to 2.14 + 2009-02-28 Gian Mario Tagliaretti <gianmt@gnome.org> * pygtk-gtkprintsettings.xml: diff --git a/docs/reference/pygtk-gtk-stock-items.xml b/docs/reference/pygtk-gtk-stock-items.xml index e68128f8..aa7abcc3 100644 --- a/docs/reference/pygtk-gtk-stock-items.xml +++ b/docs/reference/pygtk-gtk-stock-items.xml @@ -768,6 +768,17 @@ Available in GTK+ 2.4 and above.</simpara> </varlistentry> <varlistentry> + <term><literal>gtk.STOCK_PAGE_SETUP</literal></term> + <listitem> + <simpara><inlinemediaobject> + <imageobject> + <imagedata fileref="icons/stock_page_setup_24.png" format="png"/> + </imageobject> + </inlinemediaobject>Available in GTK+ 2.14 and above.</simpara> + </listitem> + </varlistentry> + + <varlistentry> <term><literal>gtk.STOCK_PASTE</literal></term> <listitem> <simpara><inlinemediaobject> @@ -801,6 +812,28 @@ Available in GTK+ 2.4 and above.</simpara> </varlistentry> <varlistentry> + <term><literal>gtk.STOCK_PRINT_ERROR</literal></term> + <listitem> + <simpara><inlinemediaobject> + <imageobject> + <imagedata fileref="icons/stock_print_error_24.png" format="png"/> + </imageobject> + </inlinemediaobject>Available in GTK+ 2.14 and above.</simpara> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>gtk.STOCK_PRINT_PAUSED</literal></term> + <listitem> + <simpara><inlinemediaobject> + <imageobject> + <imagedata fileref="icons/stock_print_paused_24.png" format="png"/> + </imageobject> + </inlinemediaobject>Available in GTK+ 2.14 and above.</simpara> + </listitem> + </varlistentry> + + <varlistentry> <term><literal>gtk.STOCK_PRINT_PREVIEW</literal></term> <listitem> <simpara><inlinemediaobject> @@ -812,6 +845,28 @@ Available in GTK+ 2.4 and above.</simpara> </varlistentry> <varlistentry> + <term><literal>gtk.STOCK_PRINT_REPORT</literal></term> + <listitem> + <simpara><inlinemediaobject> + <imageobject> + <imagedata fileref="icons/stock_print_report_24.png" format="png"/> + </imageobject> + </inlinemediaobject>Available in GTK+ 2.14 and above.</simpara> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>gtk.STOCK_PRINT_WARNING</literal></term> + <listitem> + <simpara><inlinemediaobject> + <imageobject> + <imagedata fileref="icons/stock_print_warning_24.png" format="png"/> + </imageobject> + </inlinemediaobject>Available in GTK+ 2.14 and above.</simpara> + </listitem> + </varlistentry> + + <varlistentry> <term><literal>gtk.STOCK_PROPERTIES</literal></term> <listitem> <simpara><inlinemediaobject> diff --git a/docs/reference/pygtk-gtkselectiondata.xml b/docs/reference/pygtk-gtkselectiondata.xml index 5fa5e4d8..39857bec 100644 --- a/docs/reference/pygtk-gtkselectiondata.xml +++ b/docs/reference/pygtk-gtkselectiondata.xml @@ -91,6 +91,33 @@ linkend="method-gtkselectiondata--targets-include-image">targets_include_image</ <methodname><link linkend="method-gtkselectiondata--targets-include-uri">targets_include_uri</link></methodname> <methodparam></methodparam> </methodsynopsis> + + <!-- NOT IMPLEMENTED + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkselectiondata- -get-data">get_data</link></methodname> + <methodparam></methodparam> + </methodsynopsis> + --> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkselectiondata--get-data-type">get_data_type</link></methodname> + <methodparam></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkselectiondata--get-display">get_display</link></methodname> + <methodparam></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkselectiondata--get-format">get_format</link></methodname> + <methodparam></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkselectiondata--get-length">get_length</link></methodname> + <methodparam></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkselectiondata--get-target">get_target</link></methodname> + <methodparam></methodparam> + </methodsynopsis> </classsynopsis> <programlisting> @@ -638,6 +665,121 @@ target.</para> </refsect2> + <refsect2 id="method-gtkselectiondata--get-data-type"> + <title>gtk.SelectionData.get_data_type</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_data_type</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>the data type of the selection.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.14 and above.</para> + </note> + + <para>Retrieves the data type of the selection.</para> + + </refsect2> + + <refsect2 id="method-gtkselectiondata--get-display"> + <title>gtk.SelectionData.get_display</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_display</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>the display of the selection.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.14 and above.</para> + </note> + + <para>Retrieves the display of the selection.</para> + + </refsect2> + + <refsect2 id="method-gtkselectiondata--get-format"> + <title>gtk.SelectionData.get_format</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_format</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>the format of the selection.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.14 and above.</para> + </note> + + <para>Retrieves the format of the selection.</para> + + </refsect2> + + <refsect2 id="method-gtkselectiondata--get-length"> + <title>gtk.SelectionData.get_length</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_length</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>the length of the data of the selection.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.14 and above.</para> + </note> + + <para>Retrieves the length of the data of the selection.</para> + + </refsect2> + + <refsect2 id="method-gtkselectiondata--get-target"> + <title>gtk.SelectionData.get_targets</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_target</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>the target of the selection.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.14 and above.</para> + </note> + + <para>Retrieves the target of the selection.</para> + + </refsect2> + </refsect1> <refsect1> diff --git a/docs/reference/pygtk-gtktoolitem.xml b/docs/reference/pygtk-gtktoolitem.xml index e49406a7..35f9acd9 100644 --- a/docs/reference/pygtk-gtktoolitem.xml +++ b/docs/reference/pygtk-gtktoolitem.xml @@ -113,6 +113,10 @@ <methodname><link linkend="method-gtktoolitem--set-tooltip-text">set_tooltip_text</link></methodname> <methodparam><parameter role="keyword">text</parameter></methodparam> </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtktoolitem--toolbar-reconfigured">toolbar_reconfigured</link></methodname> + <methodparam></methodparam> + </methodsynopsis> </classsynopsis> </refsect1> @@ -1024,6 +1028,32 @@ must be called when the tool item changes what it will do in response to the <methodname><link linkend="method-gtkwidget--set-tooltip-text">gtk.Widget.set_tooltip_text</link></methodname>().</para> </refsect2> + + <refsect2 id="method-gtktoolitem--toolbar-reconfigured"> + <title>gtk.ToolItem.toolbar_reconfigured</title> + + <programlisting><methodsynopsis language="python"> + <methodname>toolbar_reconfigured</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + <variablelist> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.14 and above.</para> + </note> + + <para> + The <methodname>toolbar_reconfigured</methodname>() method emits the signal + "<link linkend="signal-gtktoolitem--toolbar-reconfigured">toolbar-reconfigured</link>" + on tool_item. + <link linkend="class-gtktoolbar"><classname>gtk.ToolBar</classname></link> + and other + <link linkend="class-gtktoolshell"><classname>gtk.ToolShell</classname></link> + implementations use this function to notify children, when some aspect of their configuration changes. + </para> + + </refsect2> </refsect1> diff --git a/docs/reference/pygtk-gtktooltip.xml b/docs/reference/pygtk-gtktooltip.xml index 437e5bf1..1b2f47cb 100644 --- a/docs/reference/pygtk-gtktooltip.xml +++ b/docs/reference/pygtk-gtktooltip.xml @@ -24,6 +24,11 @@ <methodparam><parameter role="keyword">pixbuf</parameter></methodparam> </methodsynopsis> <methodsynopsis language="python"> + <methodname><link linkend="method-gtktooltip--set-icon-from-stock">set_icon_from_icon_name</link></methodname> + <methodparam><parameter role="keyword">icon_name</parameter></methodparam> + <methodparam><parameter role="keyword">size</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> <methodname><link linkend="method-gtktooltip--set-icon-from-stock">set_icon_from_stock</link></methodname> <methodparam><parameter role="keyword">stock_id</parameter></methodparam> <methodparam><parameter role="keyword">size</parameter></methodparam> @@ -200,6 +205,38 @@ </para> </refsect2> + <refsect2 id="method-gtktooltip--set-icon-from-icon-name"> + <title>gtk.Tooltip.set_icon_from_icon_name</title> + + <programlisting><methodsynopsis language="python"> + <methodname>set_icon_from_icon_name</methodname> + <methodparam><parameter>icon_name</parameter></methodparam> + <methodparam><parameter>size</parameter></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><parameter role="keyword">icon_name</parameter> :</term> + <listitem><simpara>an icon name, or <literal>None</literal>.</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter role="keyword">size</parameter> :</term> + <listitem><simpara>A stock icon size.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.14 and above.</para> + </note> + + <para> + The <methodname>set_icon_from_icon_name</methodname>() method sets + the icon of the tooltip (which is in front of the text) to be the + icon indicated by icon_name with the size indicated by size. If icon_name + is <literal>None</literal>, the image will be hidden. + </para> + </refsect2> + <refsect2 id="method-gtktooltip--set-icon-from-stock"> <title>gtk.Tooltip.set_icon_from_stock</title> |