pygtk r3069 - in branches/pygtk-2-14: . docs/reference
- From: paulp svn gnome org
- To: svn-commits-list gnome org
- Subject: pygtk r3069 - in branches/pygtk-2-14: . docs/reference
- Date: Tue, 6 Jan 2009 21:17:48 +0000 (UTC)
Author: paulp
Date: Tue Jan 6 21:17:48 2009
New Revision: 3069
URL: http://svn.gnome.org/viewvc/pygtk?rev=3069&view=rev
Log:
Merge from trunk:
2008-11-28 Gian Mario Tagliaretti <gianmt gnome org>
* pygtk-gtkstatusicon.xml:
* pygtk-gtksettings.xml:
* pygtk-gtkscalebutton.xml:
* pygtk-gtkrange.xml:
* pygtk-gtkprogressbar.xml: Update docs to 2.14
2008-11-23 Gian Mario Tagliaretti <gianmt gnome org>
* pygtk-gtkplug.xml: Update docs to 2.14
2008-11-20 Gian Mario Tagliaretti <gianmt gnome org>
* pygtk-gtklinkbutton.xml:
* pygtk-gtkmenuitem.xml:
* pygtk-gtkmenu.xml: Update docs to 2.14
Modified:
branches/pygtk-2-14/ (props changed)
branches/pygtk-2-14/docs/reference/ChangeLog
branches/pygtk-2-14/docs/reference/pygtk-gtklinkbutton.xml
branches/pygtk-2-14/docs/reference/pygtk-gtkmenu.xml
branches/pygtk-2-14/docs/reference/pygtk-gtkmenuitem.xml
branches/pygtk-2-14/docs/reference/pygtk-gtkplug.xml
branches/pygtk-2-14/docs/reference/pygtk-gtkprogressbar.xml
branches/pygtk-2-14/docs/reference/pygtk-gtkrange.xml
branches/pygtk-2-14/docs/reference/pygtk-gtkscalebutton.xml
branches/pygtk-2-14/docs/reference/pygtk-gtksettings.xml
branches/pygtk-2-14/docs/reference/pygtk-gtkstatusicon.xml
Modified: branches/pygtk-2-14/docs/reference/pygtk-gtklinkbutton.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtklinkbutton.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtklinkbutton.xml Tue Jan 6 21:17:48 2009
@@ -25,9 +25,17 @@
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
+ <methodname><link linkend="method-gtklinkbutton--get-visited">get_visited</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
<methodname><link linkend="method-gtklinkbutton--set-uri">set_uri</link></methodname>
<methodparam><parameter role="keyword">uri</parameter></methodparam>
</methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtklinkbutton--set-visited">set_visited</link></methodname>
+ <methodparam><parameter role="keyword">visited</parameter></methodparam>
+ </methodsynopsis>
</classsynopsis>
@@ -87,6 +95,14 @@
<entry>The URI bound to this button. Available in GTK+
2.10.</entry>
</row>
+
+ <row valign="top">
+ <entry>"visited"</entry>
+ <entry>Read-Write</entry>
+ <entry>The 'visited' state of this button. A visited link is drawn
+ in a different color. Default value: <literal>False</literal>.
+ Available in GTK+ 2.14.</entry>
+ </row>
</tbody>
</tgroup>
@@ -225,6 +241,35 @@
constructor.</para>
</refsect2>
+
+ <refsect2 id="method-gtklinkbutton--get-visited">
+ <title>gtk.LinkButton.get_visited</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_visited</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara><literal>True</literal> if the link has been visited,
+ <literal>False</literal> otherwise </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_visited</methodname>() method retrieves the 'visited'
+ state of the URI where the GtkLinkButton points. The button becomes visited
+ when it is clicked. If the URI is changed on the button, the 'visited'
+ state is unset again.
+ </para>
+
+ </refsect2>
<refsect2 id="method-gtklinkbutton--set-uri">
<title>gtk.LinkButton.set_uri</title>
@@ -252,6 +297,36 @@
</refsect2>
+ <refsect2 id="method-gtklinkbutton--set-visited">
+ <title>gtk.LinkButton.set_visited</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_visited</methodname>
+ <methodparam><parameter role="keyword">visited</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">visited</parameter> :</term>
+ <listitem><simpara>the new 'visited' state.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>set_visited</methodname>() method setsthe 'visited' state
+ of the URI where the
+ <link linkend="class-gtklinkbutton"><classname>gtk.LinkButton</classname></link>
+ points. See
+ <methodname><link linkend="method-gtklinkbutton--get-visited">gtk.LinkButton.get_visited</link></methodname>()
+ for more details.
+ </para>
+
+ </refsect2>
+
</refsect1>
<refsect1>
Modified: branches/pygtk-2-14/docs/reference/pygtk-gtkmenu.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtkmenu.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtkmenu.xml Tue Jan 6 21:17:48 2009
@@ -69,6 +69,12 @@
<methodparam><parameter
role="keyword">accel_path</parameter></methodparam>
</methodsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkmenu--get-accel-path">get_accel_path</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+
<methodsynopsis language="python">
<methodname><link
linkend="method-gtkmenu--attach-to-widget">attach_to_widget</link></methodname>
@@ -137,6 +143,12 @@
<methodparam><parameter
role="keyword">monitor_num</parameter></methodparam>
</methodsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkmenu--get-monitor">get_monitor</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+
</classsynopsis>
</refsect1>
@@ -181,6 +193,47 @@
<tbody>
<row valign="top">
+ <entry>"accel-group"</entry>
+ <entry>Read/Write</entry>
+ <entry>The accel group holding accelerators for the menu.
+ Available in GTK+ 2.14.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"accel-path"</entry>
+ <entry>Read/Write</entry>
+ <entry>An accel path used to conveniently construct accel paths of
+ child items. Default value: <literal>None</literal>.
+ Available in GTK+ 2.14.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"active"</entry>
+ <entry>Read/Write</entry>
+ <entry>The index of the currently selected menu item, or -1 if no menu
+ item is selected. Allowed values: >= -1. Default value: -1.
+ Available in GTK+ 2.14.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"attach-widget"</entry>
+ <entry>Read/Write</entry>
+ <entry>The widget the menu is attached to. Setting this property attaches
+ the menu without a GtkMenuDetachFunc. If you need to use a detacher,
+ use <methodname><link linkend="method-gtkmenu--attach-to-widget">gtk.Menu.attach_to_widget</link></methodname>()
+ directly.
+ Available in GTK+ 2.14.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"monitor"</entry>
+ <entry>Read/Write</entry>
+ <entry>The monitor the menu will be popped up on.
+ Allowed values: >= -1. Default value: -1.
+ Available in GTK+ 2.14.</entry>
+ </row>
+
+ <row valign="top">
<entry>"tearoff-state"</entry>
<entry>Read-Write</entry>
<entry>If <literal>True</literal> the menu is torn-off. Default
@@ -635,6 +688,30 @@
</refsect2>
+ <refsect2 id="method-gtkmenu--get-accel-path">
+ <title>gtk.Menu.get_accel_path</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_accel_path</methodname>
+ <methodparam></methodparam> </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the accelerator path set on the menu.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_accel_path</methodname>() method returns
+ the accelerator path set on the menu.
+ </para>
+
+ </refsect2>
+
<refsect2 id="method-gtkmenu--attach-to-widget">
<title>gtk.Menu.attach_to_widget</title>
@@ -966,6 +1043,31 @@
</refsect2>
+ <refsect2 id="method-gtkmenu--get-monitor">
+ <title>gtk.Menu.get_monitor</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_monitor</methodname>
+ <methodparam></methodparam> </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the number of the monitor on which the menu should
+ be popped up or -1, if no monitor has been set </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_monitor</methodname>() method returns
+ the number of the monitor on which to show the menu.
+ </para>
+
+ </refsect2>
+
</refsect1>
<refsect1>
Modified: branches/pygtk-2-14/docs/reference/pygtk-gtkmenuitem.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtkmenuitem.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtkmenuitem.xml Tue Jan 6 21:17:48 2009
@@ -82,6 +82,11 @@
<methodparam><parameter
role="keyword">accel_path</parameter></methodparam>
</methodsynopsis>
+
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkmenuitem--get-accel-path">get_accel_path</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
</classsynopsis>
</refsect1>
@@ -124,6 +129,25 @@
<colspec column="3" colwidth="4in"/>
<tbody>
<row valign="top">
+ <entry>"accel-path"</entry>
+ <entry>Read-Write</entry>
+ <entry>Sets the accelerator path of the menu item, through
+ which runtime changes of the menu item's accelerator caused
+ by the user can be identified and saved to persistant storage.
+ Default value: <literal>None</literal>.
+ Available in GTK+ 2.14.
+ </entry>
+ </row>
+ <row valign="top">
+ <entry>"right-justified"</entry>
+ <entry>Read-Write</entry>
+ <entry>Sets whether the menu item appears justified at the
+ right side of a menu bar.
+ Default value: <literal>False</literal>.
+ Available in GTK+ 2.14.
+ </entry>
+ </row>
+ <row valign="top">
<entry>"submenu"</entry>
<entry>Read-Write</entry>
<entry>The submenu attached to the menu item, or
@@ -178,6 +202,15 @@
Default value: 5</entry>
</row>
+ <row valign="top">
+ <entry>"width-chars"</entry>
+ <entry>Read</entry>
+ <entry>The minimum desired width of the menu item in characters.
+ Allowed values: >= 0. Default value: 12.
+ Available in GTK+ 2.14.
+ </entry>
+ </row>
+
</tbody>
</tgroup>
</informaltable>
@@ -563,6 +596,28 @@
</refsect2>
+ <refsect2 id="method-gtkmenuitem--get-accel-path">
+ <title>gtk.MenuItem.get_accel_path</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_accel_path</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the accelerator path corresponding to this menu
+ item's functionality, or <literal>None</literal> if not set </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The <methodname>get_accel_path</methodname>() method gets the accelerator
+ path that was previously set on menu_item.
+ </para>
+
+ </refsect2>
+
</refsect1>
<refsect1>
Modified: branches/pygtk-2-14/docs/reference/pygtk-gtkplug.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtkplug.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtkplug.xml Tue Jan 6 21:17:48 2009
@@ -32,7 +32,14 @@
<methodname><link
linkend="method-gtkplug--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>
+
+
<programlisting>
<emphasis role="bold">Functions</emphasis>
@@ -82,6 +89,13 @@
Default value: <literal>False</literal>
Available in GTK+ 2.12.</entry>
</row>
+ <row valign="top">
+ <entry>"socket-window"</entry>
+ <entry>Read</entry>
+ <entry>The window of the socket the plug is embedded in.
+ Available in GTK+ 2.14.
+ </entry>
+ </row>
</tbody>
</tgroup>
</informaltable>
@@ -227,6 +241,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>
Modified: branches/pygtk-2-14/docs/reference/pygtk-gtkprogressbar.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtkprogressbar.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtkprogressbar.xml Tue Jan 6 21:17:48 2009
@@ -186,7 +186,77 @@
<title>gtk.ProgressBar Style Properties</title>
<para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>
-
+
+ <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="4in"/>
+ <tbody>
+
+ <row valign="top">
+ <entry>"min-horizontal-bar-height"</entry>
+ <entry>Read</entry>
+ <entry>
+ Minimum horizontal height of the progress bar.
+ Allowed values: >= 1. Default value: 20.
+ Available in GTK+ 2.14 and above.
+ </entry>
+ </row>
+
+ <row valign="top">
+ <entry>"min-horizontal-bar-width"</entry>
+ <entry>Read</entry>
+ <entry>
+ The minimum horizontal width of the progress bar.
+ Allowed values: >= 1. Default value: 150.
+ Available in GTK+ 2.14 and above.
+ </entry>
+ </row>
+
+ <row valign="top">
+ <entry>"min-vertical-bar-height"</entry>
+ <entry>Read</entry>
+ <entry>
+ The minimum vertical height of the progress bar.
+ Allowed values: >= 1. Default value: 80.
+ Available in GTK+ 2.14 and above.
+ </entry>
+ </row>
+
+ <row valign="top">
+ <entry>"min-vertical-bar-width"</entry>
+ <entry>Read</entry>
+ <entry>
+ The minimum vertical width of the progress bar.
+ Allowed values: >= 1. Default value: 22.
+ Available in GTK+ 2.14 and above.
+ </entry>
+ </row>
+
+ <row valign="top">
+ <entry>"xspacing"</entry>
+ <entry>Read</entry>
+ <entry>
+ Extra spacing applied to the width of a progress bar.
+ Allowed values: >= 0. Default value: 7.
+ </entry>
+ </row>
+
+ <row valign="top">
+ <entry>"yspacing"</entry>
+ <entry>Read</entry>
+ <entry>
+ Extra spacing applied to the width of a progress bar.
+ Allowed values: >= 0. Default value: 7.
+ </entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </blockquote>
</refsect1>
<refsect1 id="signal-prototypes-gtkprogressbar">
Modified: branches/pygtk-2-14/docs/reference/pygtk-gtkrange.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtkrange.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtkrange.xml Tue Jan 6 21:17:48 2009
@@ -233,6 +233,14 @@
</row>
<row valign="top">
+ <entry>"arrow-scaling"</entry>
+ <entry>Read</entry>
+ <entry>The arrow size proportion relative to the scroll button size.
+ Allowed values: [0,1]. Default value: 0.5.
+ Available from GTK+ 2.14.</entry>
+ </row>
+
+ <row valign="top">
<entry>"slider-width"</entry>
<entry>Read</entry>
<entry>The width of scrollbar or scale thumb</entry>
Modified: branches/pygtk-2-14/docs/reference/pygtk-gtkscalebutton.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtkscalebutton.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtkscalebutton.xml Tue Jan 6 21:17:48 2009
@@ -28,6 +28,22 @@
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
+ <methodname><link linkend="method-gtkscalebutton--get-minus-button">get_minus_button</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkscalebutton--get-orientation">get_orientation</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkscalebutton--get-plus-button">get_plus_button</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkscalebutton--get-popup">get_popup</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
<methodname><link linkend="method-gtkscalebutton--get-value">get_value</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
@@ -40,6 +56,10 @@
<methodparam><parameter role="keyword">icons</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
+ <methodname><link linkend="method-gtkscalebutton--set-orientation">set_orientation</link></methodname>
+ <methodparam><parameter role="keyword">icons</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
<methodname><link linkend="method-gtkscalebutton--set-value">set_value</link></methodname>
<methodparam><parameter role="keyword">value</parameter></methodparam>
</methodsynopsis>
@@ -112,6 +132,17 @@
</row>
<row valign="top">
+ <entry>"orientation"</entry>
+ <entry>Read/Write</entry>
+ <entry>
+ The orientation of the
+ <link linkend="class-gtkscalebutton"><classname>gtk.ScaleButton</classname></link>'s
+ popup window. Default value: gtk.ORIENTATION_VERTICAL.
+ Available from GTK+ 2.14.
+ </entry>
+ </row>
+
+ <row valign="top">
<entry>"size"</entry>
<entry>Read/Write</entry>
<entry>
@@ -285,6 +316,120 @@
</para>
</refsect2>
+ <refsect2 id="method-gtkscalebutton--get-minus-button">
+ <title>gtk.ScaleButton.get_minus_button</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_minus_button</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the minus button of the
+ <link linkend="class-gtkscalebutton"><classname>gtk.ScaleButton</classname></link>.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_minus_button</methodname>() method
+ retrieves the minus button of the
+ <link linkend="class-gtkscalebutton"><classname>gtk.ScaleButton</classname></link>.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-gtkscalebutton--get-orientation">
+ <title>gtk.ScaleButton.get_orientation</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_orientation</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the
+ <link linkend="class-gtkscalebutton"><classname>gtk.ScaleButton</classname></link>'s
+ orientation.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_orientation</methodname>() method
+ gets the orientation of the
+ <link linkend="class-gtkscalebutton"><classname>gtk.ScaleButton</classname></link>'s
+ popup window.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-gtkscalebutton--get-plus-button">
+ <title>gtk.ScaleButton.get_plus_button</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_plus_button</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the plus button of the
+ <link linkend="class-gtkscalebutton"><classname>gtk.ScaleButton</classname></link>.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_plus_button</methodname>() method
+ retrieves the plus button of the
+ <link linkend="class-gtkscalebutton"><classname>gtk.ScaleButton</classname></link>.
+ </para>
+ </refsect2>
+
+ <refsect2 id="method-gtkscalebutton--get-popup">
+ <title>gtk.ScaleButton.get_popup</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_popup</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the popup of the
+ <link linkend="class-gtkscalebutton"><classname>gtk.ScaleButton</classname></link>.
+ </simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_popup</methodname>() method
+ gets the popup of the
+ <link linkend="class-gtkscalebutton"><classname>gtk.ScaleButton</classname></link>.
+ </para>
+ </refsect2>
+
<refsect2 id="method-gtkscalebutton--get-value">
<title>gtk.ScaleButton.get_value</title>
@@ -367,6 +512,33 @@
</para>
</refsect2>
+ <refsect2 id="method-gtkscalebutton--set-orientation">
+ <title>gtk.ScaleButton.set_orientation</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_orientation</methodname>
+ <methodparam><parameter>icons</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">orientation</parameter> :</term>
+ <listitem><simpara>the new orientation.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>set_orientation</methodname>() method sets the
+ orientation of the
+ <link linkend="class-gtkscalebutton"><classname>gtk.ScaleButton</classname></link>'s
+ popup window.
+ </para>
+ </refsect2>
+
<refsect2 id="method-gtkscalebutton--set-value">
<title>gtk.ScaleButton.set_value</title>
Modified: branches/pygtk-2-14/docs/reference/pygtk-gtksettings.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtksettings.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtksettings.xml Tue Jan 6 21:17:48 2009
@@ -254,6 +254,28 @@
</row>
<row valign="top">
+ <entry>"gtk-enable-event-sounds"</entry>
+ <entry>Read-Write</entry>
+ <entry>Whether to play any event sounds at all. See the Sound
+ Theme spec for more information on event sounds and sound themes.
+ GTK+ itself does not support event sounds, you have to use a
+ loadable module like the one that comes with libcanberra.
+ Default value: <literal>True</literal>.
+ This property is available in GTK+ 2.14 and above.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"gtk-enable-input-feedback-sounds"</entry>
+ <entry>Read-Write</entry>
+ <entry>Whether to play event sounds as feedback to user input.
+ See the Sound Theme spec for more information on event sounds
+ and sound themes. GTK+ itself does not support event sounds, you
+ have to use a loadable module like the one that comes
+ with libcanberra. Default value: <literal>True</literal>.
+ This property is available in GTK+ 2.14 and above.</entry>
+ </row>
+
+ <row valign="top">
<entry>"gtk-enable-mnemonics"</entry>
<entry>Read-Write</entry>
<entry>Whether labels and menu items should have visible mnemonics
@@ -261,6 +283,14 @@
Default value: <literal>True</literal>.
This property is available in GTK+ 2.12 and above.</entry>
</row>
+
+ <row valign="top">
+ <entry>"gtk-enable-tooltips"</entry>
+ <entry>Read-Write</entry>
+ <entry>Whether tooltips should be shown on widgets.
+ Default value: <literal>True</literal>.
+ This property is available in GTK+ 2.14 and above.</entry>
+ </row>
<row valign="top">
<entry>"gtk-entry-password-hint-timeout"</entry>
@@ -412,6 +442,17 @@
Allowed values: >= -1. Default value: 50.
This property is available in GTK+ 2.12 and above.</entry>
</row>
+
+ <row valign="top">
+ <entry>"gtk-recent-files-max-age"</entry>
+ <entry>Read-Write</entry>
+ <entry>The maximum age, in days, of the items inside the recently
+ used resources list. Items older than this setting will be excised
+ from the list. If set to 0, the list will always be empty;
+ if set to -1, no item will be removed. Allowed values: >= -1.
+ Default value: 30
+ This property is available in GTK+ 2.14 and above.</entry>
+ </row>
<row valign="top">
<entry>"gtk-scrolled-window-placement"</entry>
@@ -437,6 +478,17 @@
and text views should offer to insert control
characters. Default value: <literal>True</literal>.</entry>
</row>
+
+ <row valign="top">
+ <entry>"gtk-sound-theme-name"</entry>
+ <entry>Read-Write</entry>
+ <entry>The XDG sound theme to use for event sounds. See the Sound
+ Theme spec for more information on event sounds and sound themes.
+ GTK+ itself does not support event sounds, you have to use a
+ loadable module like the one that comes with libcanberra.
+ Default value: "freedesktop".
+ This property is available in GTK+ 2.14 and above.</entry>
+ </row>
<row valign="top">
<entry>"gtk-split-cursor"</entry>
Modified: branches/pygtk-2-14/docs/reference/pygtk-gtkstatusicon.xml
==============================================================================
--- branches/pygtk-2-14/docs/reference/pygtk-gtkstatusicon.xml (original)
+++ branches/pygtk-2-14/docs/reference/pygtk-gtkstatusicon.xml Tue Jan 6 21:17:48 2009
@@ -21,23 +21,11 @@
<methodparam></methodparam>
</constructorsynopsis>
<methodsynopsis language="python">
- <methodname><link linkend="method-gtkstatusicon--set-from-pixbuf">set_from_pixbuf</link></methodname>
- <methodparam><parameter role="keyword">pixbuf</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkstatusicon--set-from-file">set_from_file</link></methodname>
- <methodparam><parameter role="keyword">filename</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkstatusicon--set-from-stock">set_from_stock</link></methodname>
- <methodparam><parameter role="keyword">stock_id</parameter></methodparam>
- </methodsynopsis>
- <methodsynopsis language="python">
- <methodname><link linkend="method-gtkstatusicon--set-from-icon-name">set_from_icon_name</link></methodname>
- <methodparam><parameter role="keyword">icon_name</parameter></methodparam>
+ <methodname><link linkend="method-gtkstatusicon--get-storage-type">get_storage_type</link></methodname>
+ <methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
- <methodname><link linkend="method-gtkstatusicon--get-storage-type">get_storage_type</link></methodname>
+ <methodname><link linkend="method-gtkstatusicon--get-gicon">get_gicon</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
@@ -57,6 +45,10 @@
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
+ <methodname><link linkend="method-gtkstatusicon--get-x11-window-id">get_x11_window_id</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
<methodname><link linkend="method-gtkstatusicon--set-tooltip">set_tooltip</link></methodname>
<methodparam><parameter role="keyword">tooltip_text</parameter></methodparam>
</methodsynopsis>
@@ -94,6 +86,26 @@
<methodname><link linkend="method-gtkstatusicon--set-screen">set_screen</link></methodname>
<methodparam><parameter role="keyword">screen</parameter></methodparam>
</methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkstatusicon--set-from-pixbuf">set_from_pixbuf</link></methodname>
+ <methodparam><parameter role="keyword">pixbuf</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkstatusicon--set-from-file">set_from_file</link></methodname>
+ <methodparam><parameter role="keyword">filename</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkstatusicon--set-from-stock">set_from_stock</link></methodname>
+ <methodparam><parameter role="keyword">stock_id</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkstatusicon--set-from-icon-name">set_from_icon_name</link></methodname>
+ <methodparam><parameter role="keyword">icon_name</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkstatusicon--set-from-gicon">set_from_gicon</link></methodname>
+ <methodparam><parameter role="keyword">gicon</parameter></methodparam>
+ </methodsynopsis>
</classsynopsis>
<programlisting>
@@ -106,6 +118,9 @@
<methodname><link linkend="function-gtk--status-icon-new-from-file">gtk.status_icon_new_from_file</link></methodname>
<methodparam><parameter role="keyword">filename</parameter></methodparam>
</methodsynopsis><methodsynopsis language="python">
+ <methodname><link linkend="function-gtk--status-icon-new-from-gicon">gtk.status_icon_new_from_gicon</link></methodname>
+ <methodparam><parameter role="keyword">filename</parameter></methodparam>
+ </methodsynopsis><methodsynopsis language="python">
<methodname><link linkend="function-gtk--status-icon-new-from-stock">gtk.status_icon_new_from_stock</link></methodname>
<methodparam><parameter role="keyword">stock_id</parameter></methodparam>
</methodsynopsis><methodsynopsis language="python">
@@ -163,6 +178,14 @@
</row>
<row valign="top">
+ <entry>"gicon"</entry>
+ <entry>Read-Write</entry>
+ <entry>The GIcon displayed in the GtkStatusIcon. For themed icons,
+ the image will be updated automatically if the theme changes.</entry>
+ Available from GTK+ 2.14.
+ </row>
+
+ <row valign="top">
<entry>"icon-name"</entry>
<entry>Read-Write</entry>
<entry>The name of the icon from the icon theme. Default value:
@@ -438,6 +461,31 @@
</refsect2>
+ <refsect2 id="method-gtkstatusicon--set-from-gicon">
+ <title>gtk.StatusIcon.set_from_gicon</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_from_gicon</methodname>
+ <methodparam><parameter role="keyword">gicon</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">gicon</parameter> :</term>
+ <listitem><simpara>a gio.Icon()</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>Makes <parameter>status_icon</parameter> display the <parameter>gio.Icon()</parameter>
+ See <methodname><link linkend="function-gtk--status-icon-new-from-gicon">gtk.status_icon_new_from_gicon</link></methodname>()
+ for details</para>
+
+ </refsect2>
+
<refsect2 id="method-gtkstatusicon--get-storage-type">
<title>gtk.StatusIcon.get_storage_type</title>
@@ -468,6 +516,71 @@
</refsect2>
+ <refsect2 id="method-gtkstatusicon--get-gicon">
+ <title>gtk.StatusIcon.get_gicon</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_gicon</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the displayed icon, or <literal>None</literal>
+ if the image is empty.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ Retrieves the gio.Icon() being displayed by the
+ <link linkend="class-gtkstatusicon"><classname>gtk.StatusIcon</classname></link>.
+ The storage type of the status icon must be gtk.IMAGE_EMPTY or gtk.IMAGE_GICON.
+ If this method fails, icon is left unchanged;
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkstatusicon--get-x11-window-id">
+ <title>gtk.StatusIcon.get_x11_window_id</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_x11_window_id</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>An 32 bit unsigned integer identifier for the
+ underlying X11 Window.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ This function is only useful on the X11/freedesktop.org platform. It
+ returns a window ID for the widget in the underlying status icon
+ implementation. This is useful for the Galago notification service,
+ which can send a window ID in the protocol in order for the server
+ to position notification windows pointing to a status icon reliably.
+ </para>
+ <para>
+ This function is not intended for other use cases which are more likely
+ to be met by one of the non-X11 specific methods,
+ such as
+ <methodname><link linkend="function-gtk--status-icon-position-menu">gtk.status_icon_position_menu</link></methodname>().
+ </para>
+
+ </refsect2>
+
<refsect2 id="method-gtkstatusicon--get-pixbuf">
<title>gtk.StatusIcon.get_pixbuf</title>
@@ -891,6 +1004,33 @@
</refsect2>
+ <refsect2 id="function-gtk--status-icon-new-from-gicon">
+ <title>gtk.status_icon_new_from_gicon</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>gtk.status_icon_new_from_gicon</methodname>
+ <methodparam><parameter
+ role="keyword">gicon</parameter></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">gicon</parameter> :</term>
+ <listitem><simpara></simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>a new <link
+ linkend="class-gtkstatusicon"><classname>gtk.StatusIcon</classname></link></simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ Creates a status icon displaying a gio.Icon(). If the icon is a
+ themed icon, it will be updated when the theme changes.
+ </para>
+
+ </refsect2>
+
<refsect2 id="function-gtk--status-icon-new-from-stock">
<title>gtk.status_icon_new_from_stock</title>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
