pygtk r3049 - trunk/docs/reference
- From: gianmt svn gnome org
- To: svn-commits-list gnome org
- Subject: pygtk r3049 - trunk/docs/reference
- Date: Wed, 19 Nov 2008 23:37:08 +0000 (UTC)
Author: gianmt
Date: Wed Nov 19 23:37:08 2008
New Revision: 3049
URL: http://svn.gnome.org/viewvc/pygtk?rev=3049&view=rev
Log:
Update docs to 2.14
Modified:
trunk/docs/reference/ChangeLog
trunk/docs/reference/pygtk-gtklinkbutton.xml
trunk/docs/reference/pygtk-gtkmenu.xml
trunk/docs/reference/pygtk-gtkmenuitem.xml
Modified: trunk/docs/reference/pygtk-gtklinkbutton.xml
==============================================================================
--- trunk/docs/reference/pygtk-gtklinkbutton.xml (original)
+++ trunk/docs/reference/pygtk-gtklinkbutton.xml Wed Nov 19 23:37:08 2008
@@ -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: trunk/docs/reference/pygtk-gtkmenu.xml
==============================================================================
--- trunk/docs/reference/pygtk-gtkmenu.xml (original)
+++ trunk/docs/reference/pygtk-gtkmenu.xml Wed Nov 19 23:37:08 2008
@@ -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: trunk/docs/reference/pygtk-gtkmenuitem.xml
==============================================================================
--- trunk/docs/reference/pygtk-gtkmenuitem.xml (original)
+++ trunk/docs/reference/pygtk-gtkmenuitem.xml Wed Nov 19 23:37:08 2008
@@ -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>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
