pygtk r3096 - in trunk/docs: . reference
- From: gianmt svn gnome org
- To: svn-commits-list gnome org
- Subject: pygtk r3096 - in trunk/docs: . reference
- Date: Sat, 28 Feb 2009 21:48:14 +0000 (UTC)
Author: gianmt
Date: Sat Feb 28 21:48:14 2009
New Revision: 3096
URL: http://svn.gnome.org/viewvc/pygtk?rev=3096&view=rev
Log:
2009-02-27 Gian Mario Tagliaretti <gianmt gnome org>
* pygtk-gtkmessagedialog.xml:
* pygtk-gtklayout.xml:
* pygtk-gtkimage.xml:
* pygtk-gtkicontheme.xml:
* pygtk-gtkiconinfo.xml:
* pygtk-gtkhandlebox.xml:
* pygtk-gtkfontselection.xml:
* pygtk-gtkfontselectiondialog.xml: Update docs to 2.14
* pygtk-gtktooltips.xml: Add deprecation warnings.
* Makefile.am:
* pygtk-gtk-classes.xml:
* pygtk-gtkmountoperation.xml: Add new class gtk.MountOperation.
Added:
trunk/docs/reference/pygtk-gtkmountoperation.xml
Modified:
trunk/docs/Makefile.am
trunk/docs/reference/ChangeLog
trunk/docs/reference/pygtk-gtk-classes.xml
trunk/docs/reference/pygtk-gtkfontselection.xml
trunk/docs/reference/pygtk-gtkfontselectiondialog.xml
trunk/docs/reference/pygtk-gtkhandlebox.xml
trunk/docs/reference/pygtk-gtkiconinfo.xml
trunk/docs/reference/pygtk-gtkicontheme.xml
trunk/docs/reference/pygtk-gtkimage.xml
trunk/docs/reference/pygtk-gtklayout.xml
trunk/docs/reference/pygtk-gtkmessagedialog.xml
trunk/docs/reference/pygtk-gtktooltips.xml
Modified: trunk/docs/Makefile.am
==============================================================================
--- trunk/docs/Makefile.am (original)
+++ trunk/docs/Makefile.am Sat Feb 28 21:48:14 2009
@@ -162,6 +162,7 @@
reference/pygtk-gtkmenu.xml \
reference/pygtk-gtkmessagedialog.xml \
reference/pygtk-gtkmisc.xml \
+ reference/pygtk-gtkmountoperation.xml \
reference/pygtk-gtknotebook.xml \
reference/pygtk-gtkobject.xml \
reference/pygtk-gtkoptionmenu.xml \
@@ -439,6 +440,7 @@
html/class-gtkmenutoolbutton.html \
html/class-gtkmessagedialog.html \
html/class-gtkmisc.html \
+ html/class-gtkmountoperation.html \
html/class-gtknotebook.html \
html/class-gtkobject.html \
html/class-gtkoptionmenu.html \
Modified: trunk/docs/reference/pygtk-gtk-classes.xml
==============================================================================
--- trunk/docs/reference/pygtk-gtk-classes.xml (original)
+++ trunk/docs/reference/pygtk-gtk-classes.xml Sat Feb 28 21:48:14 2009
@@ -103,6 +103,7 @@
<xi:include href="pygtk-gtkmenutoolbutton.xml"/>
<xi:include href="pygtk-gtkmessagedialog.xml"/>
<xi:include href="pygtk-gtkmisc.xml"/>
+ <xi:include href="pygtk-gtkmountoperation.xml"/>
<xi:include href="pygtk-gtknotebook.xml"/>
<xi:include href="pygtk-gtkobject.xml"/>
<xi:include href="pygtk-gtkoptionmenu.xml"/>
Modified: trunk/docs/reference/pygtk-gtkfontselection.xml
==============================================================================
--- trunk/docs/reference/pygtk-gtkfontselection.xml (original)
+++ trunk/docs/reference/pygtk-gtkfontselection.xml Sat Feb 28 21:48:14 2009
@@ -39,6 +39,40 @@
<methodparam><parameter
role="keyword">text</parameter></methodparam>
</methodsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkfontselection--get-face">get_face</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkfontselection--get-face-list">get_face_list</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkfontselection--get-family">get_family</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkfontselection--get-family-list">get_family_list</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkfontselection--get-preview-entry">get_preview_entry</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkfontselection--get-size">get_size</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkfontselection--get-size-entry">get_size_entry</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkfontselection--get-size-list">get_size_list</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+
</classsynopsis>
</refsect1>
@@ -282,6 +316,225 @@
</refsect2>
+ <refsect2 id="method-gtkfontselection--get-face">
+ <title>gtk.FontSelection.get_face</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_face</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>A <link linkend="class-pangofontface"><classname>pango.FontFace</classname></link>
+ representing the selected font group details.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_face</methodname>() method gets the
+ <link linkend="class-pangofontface"><classname>pango.FontFace</classname></link>
+ representing the selected font group details (i.e. family, slant, weight, width, etc).
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkfontselection--get-face-list">
+ <title>gtk.FontSelection.get_face_list</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_face_list</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>A
+ <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
+ that is part of fontsel.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_face_list</methodname>() method returns the
+ <link linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
+ which lists all styles available for the selected font. For example, 'Regular', 'Bold', etc.
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkfontselection--get-family">
+ <title>gtk.FontSelection.get_family</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_family</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>A <link linkend="class-pangofontselection"><classname>pango.FontSelection</classname></link>
+ representing the selected font family. Font families are a collection of font faces.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_family</methodname>() method gets the
+ <link linkend="class-pangofontselection"><classname>pango.FontSelection</classname></link>
+ representing the selected font family.
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkfontselection--get-family-list">
+ <title>gtk.FontSelection.get_family_list</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_family_list</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>A
+ <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
+ that is part of fontsel.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_family_list</methodname>() method returns the
+ <link linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
+ that lists font families, for example, 'Sans', 'Serif', etc.
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkfontselection--get-preview-entry">
+ <title>gtk.FontSelection.get_preview_entry</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_preview_entry</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>A
+ <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
+ that is part of fontsel.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_preview_entry</methodname>() method returns the
+ <link linkend="class-gtkentry"><classname>gtk.Entry</classname></link>
+ used to display the font as a preview.
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkfontselection--get-size">
+ <title>gtk.FontSelection.get_size</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_size</methodname>
+ <methodparam></methodparam> </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>A n integer representing the selected font size,
+ or -1 if no font size is selected. </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_size</methodname>() method returns the selected font size.
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkfontselection--get-size-entry">
+ <title>gtk.FontSelection.get_size_entry</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_size_entry</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>A
+ <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
+ that is part of fontsel.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_preview_entry</methodname>() method returns the
+ <link linkend="class-gtkentry"><classname>gtk.Entry</classname></link>
+ used to allow the user to edit the font number manually instead of
+ selecting it from the list of font sizes.
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkfontselection--get-size-list">
+ <title>gtk.FontSelection.get_size_list</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_size_list</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>A
+ <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>
+ that is part of fontsel.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_size_list</methodname>() method returns the
+ <link linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>
+ used to list font sizes.
+ </para>
+
+ </refsect2>
+
</refsect1>
</refentry>
Modified: trunk/docs/reference/pygtk-gtkfontselectiondialog.xml
==============================================================================
--- trunk/docs/reference/pygtk-gtkfontselectiondialog.xml (original)
+++ trunk/docs/reference/pygtk-gtkfontselectiondialog.xml Sat Feb 28 21:48:14 2009
@@ -41,6 +41,20 @@
<methodparam><parameter
role="keyword">text</parameter></methodparam>
</methodsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkfontselectiondialog--get-apply-button">get_apply_button</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkfontselectiondialog--get-cancel-button">get_cancel_button</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkfontselectiondialog--get-ok-button">get_ok_button</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+
</classsynopsis>
</refsect1>
@@ -323,6 +337,80 @@
</refsect2>
+ <refsect2 id="method-gtkfontselectiondialog--get-apply-button">
+ <title>gtk.FontSelectionDialog.get_apply_button</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_apply_button</methodname>
+ <methodparam></methodparam> </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>a <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above but it will be deprecated in 2.16
+ don't use this method.</para>
+ </note>
+
+ <para>
+ The <methodname>get_apply_button</methodname>() method obtains a button.
+ The button doesn't have any function.
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkfontselectiondialog--get-cancel-button">
+ <title>gtk.FontSelectionDialog.get_cancel_button</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_cancel_button</methodname>
+ <methodparam></methodparam> </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>.
+ used in the dialog for the 'Cancel' button.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_cancel_button</methodname>() method gets the 'Cancel' button.
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkfontselectiondialog--get-ok-button">
+ <title>gtk.FontSelectionDialog.get_ok_button</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_ok_button</methodname>
+ <methodparam></methodparam> </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the <link linkend="class-gtkwidget"><classname>gtk.Widget</classname></link>.
+ used in the dialog for the 'OK' button.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_ok_button</methodname>() method gets the 'OK' button.
+ </para>
+
+ </refsect2>
+
</refsect1>
</refentry>
Modified: trunk/docs/reference/pygtk-gtkhandlebox.xml
==============================================================================
--- trunk/docs/reference/pygtk-gtkhandlebox.xml (original)
+++ trunk/docs/reference/pygtk-gtkhandlebox.xml Sat Feb 28 21:48:14 2009
@@ -49,6 +49,12 @@
<methodname><link
linkend="method-gtkhandlebox--get-snap-edge">get_snap_edge</link></methodname>
<methodparam></methodparam> </methodsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkhandlebox--get-child-detached">get_child_detached</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+
</classsynopsis>
</refsect1>
@@ -394,6 +400,31 @@
</refsect2>
+ <refsect2 id="method-gtkhandlebox--get-child-detached">
+ <title>gtk.HandleBox.get_child_detached</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_child_detached</methodname>
+ <methodparam></methodparam> </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara><literal>True</literal> if the child is currently detached,
+ otherwise <literal>False</literal></simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_child_detached</methodname>() method gets
+ whether the handlebox's child is currently detached.
+ </para>
+
+ </refsect2>
+
</refsect1>
<refsect1>
Modified: trunk/docs/reference/pygtk-gtkiconinfo.xml
==============================================================================
--- trunk/docs/reference/pygtk-gtkiconinfo.xml (original)
+++ trunk/docs/reference/pygtk-gtkiconinfo.xml Sat Feb 28 21:48:14 2009
@@ -52,6 +52,13 @@
</methodsynopsis>
</classsynopsis>
+<programlisting>
+<emphasis role="bold">Functions</emphasis>
+<methodsynopsis language="python">
+ <methodname><link linkend="function-gtk--iconinfo-new-from-pixbuf">gtk.icon_info_new_from_pixbuf</link></methodname>
+ <methodparam><parameter role="keyword">pixbuf</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
</refsect1>
<refsect1>
@@ -388,4 +395,35 @@
</refsect1>
+
+ <refsect1>
+ <title>Functions</title>
+
+ <refsect2 id="function-gtk--iconinfo-new-from-pixbuf">
+ <title>gtk.icon_info_new_from_pixbuf</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>gtk.icon_info_new_from_pixbuf</methodname>
+ <methodparam><parameter role="keyword">pixbuf</parameter></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">pixbuf</parameter> :</term>
+ <listitem><simpara>the <link linkend="class-gtkpixbuf"><classname>gtk.Pixbuf</classname></link>
+ to wrap in a <link linkend="class-gtkiconinfo"><classname>gtk.IconInfo</classname></link>.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This function is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ Creates a <link linkend="class-gtkiconinfo"><classname>gtk.IconInfo</classname></link>
+ for a <link linkend="class-gtkpixbuf"><classname>gtk.Pixbuf</classname></link>.
+ </para>
+
+ </refsect2>
+ </refsect1>
</refentry>
Modified: trunk/docs/reference/pygtk-gtkicontheme.xml
==============================================================================
--- trunk/docs/reference/pygtk-gtkicontheme.xml (original)
+++ trunk/docs/reference/pygtk-gtkicontheme.xml Sat Feb 28 21:48:14 2009
@@ -81,6 +81,12 @@
<methodname><link linkend="method-gtkicontheme--get-icon-sizes">get_icon_sizes</link></methodname>
<methodparam><parameter role="keyword">icon_name</parameter></methodparam>
</methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkicontheme--lookup-by-gicon">lookup_by_gicon</link></methodname>
+ <methodparam><parameter role="keyword">icon</parameter></methodparam>
+ <methodparam><parameter role="keyword">size</parameter></methodparam>
+ <methodparam><parameter role="keyword">flags</parameter></methodparam>
+ </methodsynopsis>
</classsynopsis>
<programlisting>
@@ -783,6 +789,51 @@
</refsect2>
+ <refsect2 id="method-gtkicontheme--lookup-by-gicon">
+ <title>gtk.IconTheme.lookup_by_gicon</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>lookup_by_gicon</methodname>
+ <methodparam><parameter role="keyword">icon</parameter></methodparam>
+ <methodparam><parameter role="keyword">size</parameter></methodparam>
+ <methodparam><parameter role="keyword">flags</parameter></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">icon</parameter> :</term>
+ <listitem><simpara>the <link linkend="class-gioicon"><classname>gio.Icon</classname></link>
+ to lookup</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">size</parameter> :</term>
+ <listitem><simpara>The desired icon size.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">flags</parameter> :</term>
+ <listitem><simpara>the flags modifying the behavior of the icon
+ lookup</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>A <link linkend="class-gtkiconinfo"><classname>gtk.IconInfo</classname></link>.
+ structure containing information about the icon, or <literal>None</literal>
+ if the icon wasn't found.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>lookup_by_gicon</methodname>() method Looks up an icon
+ and returns a structure containing information such as the filename of
+ the icon. The icon can then be rendered into a pixbuf using
+ <methodname><link linkend="method-gtkiconinfo--load-icon">gtk.IconInfo.load_icon</link></methodname>().
+ </para>
+
+ </refsect2>
+
</refsect1>
<refsect1>
Modified: trunk/docs/reference/pygtk-gtkimage.xml
==============================================================================
--- trunk/docs/reference/pygtk-gtkimage.xml (original)
+++ trunk/docs/reference/pygtk-gtkimage.xml Sat Feb 28 21:48:14 2009
@@ -128,6 +128,12 @@
linkend="method-gtkimage--clear">clear</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkimage--set-from-gicon">set_from_gicon</link></methodname>
+ <methodparam><parameter role="keyword">gicon</parameter></methodparam>
+ <methodparam><parameter role="keyword">size</parameter></methodparam>
+ </methodsynopsis>
</classsynopsis>
<programlisting>
@@ -162,6 +168,10 @@
</methodsynopsis><methodsynopsis language="python">
<methodname><link linkend="function-gtk--image-new-from-pixbuf">gtk.image_new_from_pixbuf</link></methodname>
<methodparam><parameter role="keyword">pixbuf</parameter></methodparam>
+ </methodsynopsis><methodsynopsis language="python">
+ <methodname><link linkend="function-gtk--image-new-from-gicon">gtk.image_new_from_gicon</link></methodname>
+ <methodparam><parameter role="keyword">gicon</parameter></methodparam>
+ <methodparam><parameter role="keyword">size</parameter></methodparam>
</methodsynopsis></programlisting>
</refsect1>
@@ -1008,6 +1018,37 @@
</refsect2>
+ <refsect2 id="method-gtkimage--set-from-gicon">
+ <title>gtk.Image.set_from_gicon</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_from_gicon</methodname>
+ <methodparam><parameter role="keyword">icon</parameter></methodparam>
+ <methodparam><parameter role="keyword">size</parameter></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">icon</parameter> :</term>
+ <listitem><simpara>an icon</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">size</parameter> :</term>
+ <listitem><simpara>an icon size</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ For the <methodname>set_from_gicon</methodname>() method see
+ <methodname><link linkend="function-gtk--image-new-from-gicon">gtk.image_new_from_gicon</link></methodname>()
+ for details.
+ </para>
+
+ </refsect2>
+
</refsect1>
<refsect1>
@@ -1354,6 +1395,44 @@
<link linkend="function-gtk--image-new-from-icon-set">gtk.image_new_from_icon_set</link>
</para>
</refsect2>
+
+ <refsect2 id="function-gtk--image-new-from-gicon">
+ <title>gtk.image_new_from_gicon</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>gtk.image_new_from_gicon</methodname>
+ <methodparam><parameter role="keyword">gicon</parameter></methodparam>
+ <methodparam><parameter role="keyword">size</parameter></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">gicon</parameter> :</term>
+ <listitem><simpara>a <link linkend="class-gioicon"><classname>gio.Icon</classname></link>
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">size</parameter> :</term>
+ <listitem><simpara>a stock icon size.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>a new <link linkend="class-gtkimage"><classname>gtk.Image</classname></link>
+ displaying the themed icon.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This function is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>The <function>gtk.image_new_from_pixbuf</function>() function returns
+ a new <link linkend="class-gtkimage"><classname>gtk.Image</classname></link>
+ displaying an icon from the current icon theme. If the icon name isn't known,
+ a "broken image" icon will be displayed instead. If the current icon theme is
+ changed, the icon will be updated appropriately.
+ </para>
+ </refsect2>
</refsect1>
Modified: trunk/docs/reference/pygtk-gtklayout.xml
==============================================================================
--- trunk/docs/reference/pygtk-gtklayout.xml (original)
+++ trunk/docs/reference/pygtk-gtklayout.xml Sat Feb 28 21:48:14 2009
@@ -73,6 +73,11 @@
<methodparam><parameter
role="keyword">adjustment</parameter></methodparam>
</methodsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtklayout--get-bin-window">get_bin_window</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
</classsynopsis>
</refsect1>
@@ -556,6 +561,32 @@
</refsect2>
+ <refsect2 id="method-gtklayout--get-bin-window">
+ <title>gtk.Layout.get_bin_window</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_bin_window</methodname>
+ <methodparam></methodparam> </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>a
+ <link linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_bin_window</methodname>() method retrieve the bin window
+ of the layout used for drawing operations.
+ </para>
+
+ </refsect2>
+
</refsect1>
<refsect1>
Modified: trunk/docs/reference/pygtk-gtkmessagedialog.xml
==============================================================================
--- trunk/docs/reference/pygtk-gtkmessagedialog.xml (original)
+++ trunk/docs/reference/pygtk-gtkmessagedialog.xml Sat Feb 28 21:48:14 2009
@@ -48,6 +48,10 @@
<methodname><link linkend="method-gtkmessagedialog--set-image">set_image</link></methodname>
<methodparam><parameter role="keyword">image</parameter></methodparam>
</methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkmessagedialog--get-image">get_image</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
</classsynopsis>
</refsect1>
@@ -474,6 +478,31 @@
</refsect2>
+ <refsect2 id="method-gtkmessagedialog--get-image">
+ <title>gtk.MessageDialog.get_image</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_image</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the dialog's image.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_image</methodname>() method gets the dialog's image.
+ </para>
+
+ </refsect2>
+
</refsect1>
</refentry>
Added: trunk/docs/reference/pygtk-gtkmountoperation.xml
==============================================================================
--- (empty file)
+++ trunk/docs/reference/pygtk-gtkmountoperation.xml Sat Feb 28 21:48:14 2009
@@ -0,0 +1,344 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd";>
+
+<refentry id="class-gtkmountoperation">
+ <refnamediv>
+ <refname>gtk.MountOperation</refname>
+ <refpurpose>Functions for working with GIO (new in PyGTK 2.14)</refpurpose>
+ </refnamediv>
+
+ <refsect1>
+ <title>Synopsis</title>
+
+ <classsynopsis language="python">
+ <ooclass><classname>gtk.MountOperation</classname></ooclass>
+ <ooclass><classname><link linkend="class-giomountoperation">gio.MountOperation</link></classname></ooclass>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkmountoperation--get-parent">get_parent</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkmountoperation--get-screen">get_screen</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkmountoperation--is-showing">is_showing</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkmountoperation--set-parent">set_parent</link></methodname>
+ <methodparam><parameter role="keyword">parent</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkmountoperation--set-screen">set_screen</link></methodname>
+ <methodparam><parameter role="keyword">screen</parameter></methodparam>
+ </methodsynopsis>
+
+ </classsynopsis>
+
+<programlisting>
+<emphasis role="bold">Functions</emphasis>
+
+<methodsynopsis language="python">
+ <methodname><link linkend="function-gtk--show-uri">gtk.show_uri</link></methodname>
+ <methodparam><parameter role="keyword">screen</parameter></methodparam>
+ <methodparam><parameter role="keyword">uri</parameter></methodparam>
+ <methodparam><parameter role="keyword">timestamp</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ </refsect1>
+
+ <refsect1>
+ <title>Ancestry</title>
+
+<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+ +-- <link linkend="class-giomountoperation">gio.MountOperation</link>
+ +-- <link linkend="class-gtkmountoperation">gtk.MountOperation</link>
+</synopsis>
+
+ </refsect1>
+
+ <refsect1 id="properties-gtkmountoperation">
+ <title>gtk.MountOperation Properties</title>
+
+ <blockquote role="properties">
+ <informaltable pgwide="1" frame="none">
+ <tgroup cols="3">
+ <colspec column="1" colwidth="1in"/>
+ <colspec column="2" colwidth="1in"/>
+ <colspec column="3" colwidth="3.5in"/>
+ <tbody>
+
+ <row valign="top">
+ <entry>"is-showing"</entry>
+ <entry>Read</entry>
+ <entry>Are we showing a dialog. Default value: <literal>False</literal>.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"parent"</entry>
+ <entry>Read/Write</entry>
+ <entry>The parent window.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"screen"</entry>
+ <entry>Read/Write</entry>
+ <entry>The screen where this window will be displayed.</entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </blockquote>
+
+ </refsect1>
+
+ <refsect1>
+ <title>Description</title>
+ <para>
+ The functions and objects described here make working with GTK+ and GIO more convenient.
+ <link linkend="class-gtkmountoperation"><classname>gtk.MountOperation</classname></link>
+ is needed when mounting volumes and
+ <methodname><link linkend="function-gtk--show-uri">gtk.show_uri</link></methodname>()
+ is a convenient way to launch applications for URIs. Another object that is worth
+ mentioning in this context is
+ <link linkend="class-gdkapplaunchcontext"><classname>gtk.gdk.AppLaunchContext</classname></link>,
+ which provides visual feedback when lauching applications.
+ </para>
+ </refsect1>
+
+ <refsect1 id="constructor-gtkmountoperation">
+ <title>Constructor</title>
+
+ <programlisting><constructorsynopsis language="python">
+ <methodname>gtk.MountOperation</methodname>
+ <methodparam><parameter role="keyword">parent</parameter><initializer>None</initializer></methodparam>
+ </constructorsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">parent</parameter> :</term>
+ <listitem><simpara>transient parent of the window, or
+ <literal>None</literal>.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>a new
+ <link linkend="class-gtkmountoperation"><classname>gtk.MountOperation</classname></link>.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ Creates a new <link linkend="class-gtkmountoperation"><classname>gtk.MountOperation</classname></link>.
+ </para>
+
+ </refsect1>
+
+ <refsect1>
+ <title>Methods</title>
+
+ <refsect2 id="method-gtkmountoperation--get-parent">
+ <title>gtk.MountOperation.get_parent</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_parent</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>a new
+ <link linkend="class-gtkmountoperation"><classname>gtk.MountOperation</classname></link>.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_parent</methodname>() method gets the transient
+ parent used by the
+ <link linkend="class-gtkmountoperation"><classname>gtk.MountOperation</classname></link>.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-gtkmountoperation--get-screen">
+ <title>gtk.MountOperation.get_screen</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_screen</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the screen on which windows of op are shown.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_screen</methodname>() method gets the screen
+ on which windows of the
+ <link linkend="class-gtkmountoperation"><classname>gtk.MountOperation</classname></link>
+ will be shown.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-gtkmountoperation--is-showing">
+ <title>gtk.MountOperation.is_showing</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>is_showing</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara><literal>True</literal> if op is currently displaying a window.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>is_showing</methodname>() method returns whetherthe
+ <link linkend="class-gtkmountoperation"><classname>gtk.MountOperation</classname></link>
+ is currently displaying a window.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-gtkmountoperation--set-parent">
+ <title>gtk.MountOperation.set_parent</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_parent</methodname>
+ <methodparam><parameter>parent</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">parent</parameter> :</term>
+ <listitem><simpara>transient parent of the window,
+ 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>set_parent</methodname>() method sets the
+ transient parent for windows shown by the
+ <link linkend="class-gtkmountoperation"><classname>gtk.MountOperation</classname></link>.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-gtkmountoperation--set-screen">
+ <title>gtk.MountOperation.set_screen</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_screen</methodname>
+ <methodparam><parameter>screen</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">screen</parameter> :</term>
+ <listitem><simpara>a
+ <link linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>set_screen</methodname>() method gets the screen
+ on which windows of the
+ <link linkend="class-gtkmountoperation"><classname>gtk.MountOperation</classname></link>
+ will be shown.
+ </para>
+ </refsect2>
+ </refsect1>
+ <refsect1>
+ <title>Functions</title>
+
+ <refsect2 id="function-gtk--show-uri">
+ <title>gtk.show_uri</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>show_uri</methodname>
+ <methodparam><parameter>screen</parameter></methodparam>
+ <methodparam><parameter>uri</parameter></methodparam>
+ <methodparam><parameter>timestamp</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">screen</parameter> :</term>
+ <listitem><simpara>A
+ <link linkend="class-gdkscreen"><classname>gtk.gdk.Screen</classname></link>
+ to show the uri on or <literal>None</literal> for the default screen.
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">uri</parameter> :</term>
+ <listitem><simpara>the uri to show.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">timestamp</parameter> :</term>
+ <listitem><simpara>a timestamp to prevent focus stealing.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This function is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>show_uri</methodname>() function is a convenience
+ function for launching the default application to show the uri.
+ The uri must be of a form understood by GIO. Typical examples are:
+ </para>
+<programlisting>
+file:///home/gnome/pict.jpg
+http://www.gnome.org
+mailto:me gnome org
+</programlisting>
+
+ <para>
+ Ideally the timestamp is taken from the event triggering the
+ <methodname><link linkend="function-gtk--show-uri">gtk.show_uri</link></methodname>()
+ call. If timestamp is not known you can take gtk.gdk.CURRENT_TIME.
+ </para>
+ <para>
+ This function can be used as a replacement for gnome_vfs_url_show() and gnome_url_show().
+ </para>
+ </refsect2>
+ </refsect1>
+</refentry>
Modified: trunk/docs/reference/pygtk-gtktooltips.xml
==============================================================================
--- trunk/docs/reference/pygtk-gtktooltips.xml (original)
+++ trunk/docs/reference/pygtk-gtktooltips.xml Sat Feb 28 21:48:14 2009
@@ -154,6 +154,10 @@
<refsect1>
<title>Description</title>
+
+ <warning>
+ <para>This method is deprecated in PyGTK 2.12 and above</para>
+ </warning>
<para>Tooltips are the messages that appear next to a widget when the
mouse pointer is held over it for a short amount of time. They are
@@ -203,6 +207,10 @@
object</simpara></listitem>
</varlistentry>
</variablelist>
+
+ <warning>
+ <para>This method is deprecated in PyGTK 2.12 and above</para>
+ </warning>
<para>Creates an empty <link
linkend="class-gtktooltips"><classname>gtk.Tooltips</classname></link>
@@ -219,6 +227,10 @@
<programlisting><methodsynopsis language="python">
<methodname>enable</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
+
+ <warning>
+ <para>This method is deprecated in PyGTK 2.12 and above</para>
+ </warning>
<para>The <methodname>enable</methodname>() method enables a group of
tooltips. A tooltip will be displayed over its associated widget when
@@ -232,6 +244,10 @@
<programlisting><methodsynopsis language="python">
<methodname>disable</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
+
+ <warning>
+ <para>This method is deprecated in PyGTK 2.12 and above</para>
+ </warning>
<para>The <methodname>disable</methodname>() method disables a group
of tooltips. A tooltip will not be displayed over its associated widget when
@@ -262,6 +278,10 @@
<listitem><simpara>the tooltip private text for context sensitive display</simpara></listitem>
</varlistentry>
</variablelist>
+
+ <warning>
+ <para>This method is deprecated in PyGTK 2.12 and above</para>
+ </warning>
<para>The <methodname>set_tips</methodname>() method creates a tooltip
for the specified <parameter>widget</parameter>. The text specified by
@@ -277,6 +297,10 @@
<programlisting><methodsynopsis language="python">
<methodname>force_window</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
+
+ <warning>
+ <para>This method is deprecated in PyGTK 2.12 and above</para>
+ </warning>
<para>The <methodname>force_window</methodname>() method ensures that
the window used for displaying the given tooltips is created. Applications
@@ -310,6 +334,10 @@
<literal>None</literal></simpara></listitem>
</varlistentry>
</variablelist>
+
+ <warning>
+ <para>This method is deprecated in PyGTK 2.12 and above</para>
+ </warning>
<para>The <function>gtk.tooltips_data_get</function>() function
returns a tuple containing the tooltip data associated with
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
