[pygtk] reference: pygtk-gtktooltip.xml: add missing set_icon_from_gicon method and add parameter markup
- From: Dieter Verfaillie <dieterv src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [pygtk] reference: pygtk-gtktooltip.xml: add missing set_icon_from_gicon method and add parameter markup
- Date: Thu, 10 Mar 2011 21:19:06 +0000 (UTC)
commit ea0c3a3c2cfd308488f1eb8de87663cebf286574
Author: Dieter Verfaillie <dieterv optionexplicit be>
Date: Wed Mar 9 07:56:10 2011 +0100
reference: pygtk-gtktooltip.xml: add missing set_icon_from_gicon method and add parameter markup
docs/reference/pygtk-gtktooltip.xml | 48 ++++++++++++++++++++++++++++++----
1 files changed, 42 insertions(+), 6 deletions(-)
---
diff --git a/docs/reference/pygtk-gtktooltip.xml b/docs/reference/pygtk-gtktooltip.xml
index 1b2f47c..5a41e26 100644
--- a/docs/reference/pygtk-gtktooltip.xml
+++ b/docs/reference/pygtk-gtktooltip.xml
@@ -34,6 +34,11 @@
<methodparam><parameter role="keyword">size</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
+ <methodname><link linkend="method-gtktooltip--set-icon-from-gicon">set_icon_from_gicon</link></methodname>
+ <methodparam><parameter role="keyword">gicon</parameter></methodparam>
+ <methodparam><parameter role="keyword">size</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
<methodname><link linkend="method-gtktooltip--set-markup">set_markup</link></methodname>
<methodparam><parameter role="keyword">markup</parameter></methodparam>
</methodsynopsis>
@@ -230,10 +235,10 @@
</note>
<para>
- The <methodname>set_icon_from_icon_name</methodname>() method sets
- the icon of the tooltip (which is in front of the text) to be the
- icon indicated by icon_name with the size indicated by size. If icon_name
- is <literal>None</literal>, the image will be hidden.
+ The <methodname>set_icon_from_icon_name</methodname>() method sets the icon of the tooltip
+ (which is in front of the text) to be the icon indicated by <parameter>icon_name</parameter>
+ with the size indicated by <parameter>size</parameter>. If icon_name is <literal>None</literal>,
+ the image will be hidden.
</para>
</refsect2>
@@ -263,11 +268,42 @@
<para>
The <methodname>set_icon_from_stock</methodname>() method sets the icon of the tooltip
- (which is in front of the text) to be the stock item indicated by stock_id with the size
- indicated by size. If stock_id is <literal>None</literal>, the image will be hidden.
+ (which is in front of the text) to be the stock item indicated by <parameter>stock_id</parameter>
+ with the size indicated by <parameter>size</parameter>. If stock_id is <literal>None</literal>,
+ the image will be hidden.
</para>
</refsect2>
+ <refsect2 id="method-gtktooltip--set-icon-from-gicon">
+ <title>gtk.Tooltip.set_icon_from_gicon</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_icon_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>the icon to set, or <literal>None</literal>..</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter role="keyword">size</parameter> :</term>
+ <listitem><simpara>a stock icon size.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.20 and above.</para>
+ </note>
+
+ <para>The <methodname>set_icon_from_gicon</methodname>() method sets the icon of the
+ tooltip (which is in front of the text) to be the icon indicated by <parameter>gicon</parameter>
+ with the size indicated by <parameter>size</parameter>. If gicon is <literal>None</literal>,
+ the image will be hidden.</para>
+
+ </refsect2>
+
<refsect2 id="method-gtktooltip--set-markup">
<title>gtk.Tooltip.set_markup</title>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]