[pygtk] Bug 595824 - gtk.Style.lookup_color missing in documentation



commit 935ee3d0f28e3527812e95fd98bd7d1c6eb74a82
Author: Gian Mario Tagliaretti <gianmt gnome org>
Date:   Fri Dec 25 18:36:29 2009 +0100

    Bug 595824 - gtk.Style.lookup_color missing in documentation

 docs/reference/pygtk-gtkstyle.xml |   35 +++++++++++++++++++++++++++++++++++
 1 files changed, 35 insertions(+), 0 deletions(-)
---
diff --git a/docs/reference/pygtk-gtkstyle.xml b/docs/reference/pygtk-gtkstyle.xml
index 689c1f8..9036945 100644
--- a/docs/reference/pygtk-gtkstyle.xml
+++ b/docs/reference/pygtk-gtkstyle.xml
@@ -65,6 +65,12 @@ linkend="method-gtkstyle--lookup-icon-set">lookup_icon_set</link></methodname>
 	<methodparam><parameter
 		       role="keyword">stock_id</parameter></methodparam>
       </methodsynopsis>
+
+      <methodsynopsis language="python">
+	<methodname><link linkend="method-gtkstyle--lookup-color">lookup_color</link></methodname>
+	<methodparam><parameter role="keyword">color_name</parameter></methodparam>
+      </methodsynopsis>
+
       <methodsynopsis language="python">
 	<methodname><link
 linkend="method-gtkstyle--render-icon">render_icon</link></methodname>
@@ -1069,6 +1075,35 @@ is found it is returned.</para>
 
     </refsect2>
 
+    <refsect2 id="method-gtkstyle--lookup-color">
+      <title>gtk.Style.lookup_color</title>
+
+      <programlisting><methodsynopsis language="python">
+	  <methodname>lookup_color</methodname>
+	  <methodparam><parameter role="keyword">color_name</parameter></methodparam>
+	</methodsynopsis></programlisting>
+      <variablelist>
+	<varlistentry>
+	  <term><parameter role="keyword">color_name</parameter>&nbsp;:</term>
+	  <listitem><simpara>the name of the logical color to look up</simpara></listitem>
+	</varlistentry>
+	<varlistentry>
+	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
+	  <listitem><simpara>a <link linkend="class-gdkcolor"><classname>gtk.gdk.Color</classname></link>
+	  on succes, <literal>None</literal> otherwise.</simpara></listitem>
+	</varlistentry>
+      </variablelist>
+
+      <para>
+	The <methodname>lookup_color</methodname>() method looks up <parameter>color_name</parameter>
+	in the style's logical color mappings, filling in color and returning <literal>True</literal>
+	if found, otherwise returning <literal>Flase</literal>.
+	Do not cache the found mapping, because it depends on the GtkStyle and might
+	change when a theme switch occurs.
+      </para>
+
+    </refsect2>
+
     <refsect2 id="method-gtkstyle--render-icon">
       <title>gtk.Style.render_icon</title>
 



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]