[pygtk] reference: pygtk-gtktoolitem.xml: add missing methods
- From: Dieter Verfaillie <dieterv src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [pygtk] reference: pygtk-gtktoolitem.xml: add missing methods
- Date: Thu, 10 Mar 2011 21:19:01 +0000 (UTC)
commit 7720713691f335ebf28bd18f4519539074d6c818
Author: Dieter Verfaillie <dieterv optionexplicit be>
Date: Wed Mar 9 07:36:21 2011 +0100
reference: pygtk-gtktoolitem.xml: add missing methods
docs/reference/pygtk-gtktoolitem.xml | 115 +++++++++++++++++++++++++++++++++-
1 files changed, 114 insertions(+), 1 deletions(-)
---
diff --git a/docs/reference/pygtk-gtktoolitem.xml b/docs/reference/pygtk-gtktoolitem.xml
index 35f9acd..e763035 100644
--- a/docs/reference/pygtk-gtktoolitem.xml
+++ b/docs/reference/pygtk-gtktoolitem.xml
@@ -117,6 +117,22 @@
<methodname><link linkend="method-gtktoolitem--toolbar-reconfigured">toolbar_reconfigured</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolitem--get-ellipsize-mode">get_ellipsize_mode</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolitem--get-text-alignment">get_text_alignment</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolitem--get-text-orientation">get_text_orientation</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtktoolitem--get-text-size-group">get_text_size_group</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
</classsynopsis>
</refsect1>
@@ -1050,11 +1066,108 @@ must be called when the tool item changes what it will do in response to the
<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.
+ implementations use this method to notify children, when some aspect of their configuration changes.
</para>
</refsect2>
+ <refsect2 id="method-gtktoolitem--get-ellipsize-mode">
+ <title>gtk.ToolItem.get_ellipsize_mode</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_ellipsize_mode</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>one of the <xref linkend="pango-ellipsize-mode-constants" endterm="pango-ellipsize-mode-constants-title"></xref>
+ indicating how text should be ellipsized.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.20 and above.</para>
+ </note>
+
+ <para>The <methodname>get_ellipsize_mode</methodname>() method returns the ellipsize mode used
+ for the tool item. Custom subclasses of <link linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link>
+ should call this method to find out how text should be ellipsized.</para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtktoolitem--get-text-alignment">
+ <title>gtk.ToolItem.get_text_alignment</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_text_alignment</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the horizontal text alignment used for the tool item.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.20 and above.</para>
+ </note>
+
+ <para>The <methodname>get_text_alignment</methodname>() method returns the text alignment used
+ for the tool item. Custom subclasses of <link linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link>
+ should call this method to find out how text should be aligned.</para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtktoolitem--get-text-orientation">
+ <title>gtk.ToolItem.get_text_orientation</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_text_orientation</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the text orientation used for the tool item.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.20 and above.</para>
+ </note>
+
+ <para>The <methodname>get_text_orientation</methodname>() method returns the text orientation used
+ for the tool item. Custom subclasses of <link linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link>
+ should call this method to find out how text should be orientated.</para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtktoolitem--get-text-size-group">
+ <title>gtk.ToolItem.get_text_size_group</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_text_size_group</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>a <link linkend="class-gtksizegroup"><classname>gtk.SizeGroup</classname></link>.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.20 and above.</para>
+ </note>
+
+ <para>The <methodname>get_text_size_group</methodname>() method returns the size group used for labels
+ in the tool item. Custom subclasses of <link linkend="class-gtktoolitem"><classname>gtk.ToolItem</classname></link>
+ should call this method and use the size group for labels.</para>
+
+ </refsect2>
+
</refsect1>
<refsect1>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]