[pygtk] reference: pygtk-gtkcombobox.xml: add new methods and properties



commit 6d07c134cef9995fede537b43aa3ad834ba4872f
Author: Dieter Verfaillie <dieterv optionexplicit be>
Date:   Mon Feb 21 13:59:11 2011 +0100

    reference: pygtk-gtkcombobox.xml: add new methods and properties

 docs/reference/pygtk-gtkcombobox.xml |  115 +++++++++++++++++++++++++++++++---
 1 files changed, 107 insertions(+), 8 deletions(-)
---
diff --git a/docs/reference/pygtk-gtkcombobox.xml b/docs/reference/pygtk-gtkcombobox.xml
index 3846289..b9f4d72 100644
--- a/docs/reference/pygtk-gtkcombobox.xml
+++ b/docs/reference/pygtk-gtkcombobox.xml
@@ -17,7 +17,20 @@
       <ooclass><classname><link linkend="class-gtkcelllayout">gtk.CellLayout</link></classname></ooclass>
       <constructorsynopsis language="python">
 	<methodname><link linkend="constructor-gtkcombobox">gtk.ComboBox</link></methodname>
-	<methodparam><parameter role="keyword">model</parameter><initializer>None</initializer></methodparam>  </constructorsynopsis>
+	<methodparam><parameter role="keyword">model</parameter><initializer>None</initializer></methodparam>
+      </constructorsynopsis>
+      <methodsynopsis language="python">
+	<methodname><link linkend="method-gtkcombobox--get-has-entry">get_has_entry</link></methodname>
+	<methodparam></methodparam>
+      </methodsynopsis>
+      <methodsynopsis language="python">
+	<methodname><link linkend="method-gtkcombobox--get-entry-text-column">get_entry_text_column</link></methodname>
+	<methodparam></methodparam>
+      </methodsynopsis>
+      <methodsynopsis language="python">
+	<methodname><link linkend="method-gtkcombobox--set-entry-text-column">set_entry_text_column</link></methodname>
+	<methodparam><parameter role="keyword">text_column</parameter></methodparam>
+      </methodsynopsis>
       <methodsynopsis language="python">
 	<methodname><link linkend="method-gtkcombobox--get-wrap-width">get_wrap_width</link></methodname>
 	<methodparam></methodparam>
@@ -224,13 +237,28 @@ END NOT IMPLEMENTED -->
 	      This property is available in GTK+ 2.4 and above</entry>
 	    </row>
 
-            <row valign="top">
-              <entry>"focus-on-click"</entry>
-              <entry>Read-Write</entry>
-              <entry>If <literal>True</literal> the combo box grabs focus
-              when it is clicked with the mouse. Default value:
-              <literal>True</literal></entry>
-            </row>
+      <row valign="top">
+        <entry>"entry-text-column"</entry>
+        <entry>Read-Write</entry>
+        <entry>The column in the combo box's model to associate with strings from
+        the entry if the combo was created with "has-entry" = <literal>True</literal>.
+        This property is available in GTK+ 2.24 and above</entry>
+      </row>
+
+      <row valign="top">
+        <entry>"focus-on-click"</entry>
+        <entry>Read-Write</entry>
+        <entry>If <literal>True</literal> the combo box grabs focus
+        when it is clicked with the mouse. Default value:
+        <literal>True</literal></entry>
+      </row>
+
+      <row valign="top">
+        <entry>"has-entry"</entry>
+        <entry>Read-Write-Construct Only</entry>
+        <entry>Whether the combo box has an entry. Default value: <literal>False</literal>.
+        This property is available in GTK+ 2.24 and above</entry>
+      </row>
 
 	    <row valign="top">
 	      <entry>"has-frame"</entry>
@@ -486,6 +514,77 @@ END NOT IMPLEMENTED -->
   <refsect1>
     <title>Methods</title>
 
+    <refsect2 id="method-gtkcombobox--get-has-entry">
+      <title>gtk.ComboBox.get_has_entry</title>
+
+      <programlisting><methodsynopsis language="python">
+	  <methodname>get_has_entry</methodname>
+	  <methodparam></methodparam>
+	</methodsynopsis></programlisting>
+      <variablelist>
+	<varlistentry>
+	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
+	  <listitem><simpara>Whether there is an entry in the combo box.</simpara></listitem>
+	</varlistentry>
+      </variablelist>
+
+      <note>
+	<para>This method is available in PyGTK 2.24 and above.</para>
+      </note>
+
+      <para>The <methodname>get_has_entry</methodname>() method returns
+      whether the combo box has an entry.</para>
+
+    </refsect2>
+
+    <refsect2 id="method-gtkcombobox--get-entry-text-column">
+      <title>gtk.ComboBox.get_entry_text_column</title>
+
+      <programlisting><methodsynopsis language="python">
+	  <methodname>get_entry_text_column</methodname>
+	  <methodparam></methodparam>
+	</methodsynopsis></programlisting>
+      <variablelist>
+	<varlistentry>
+	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
+	  <listitem><simpara>A column in the data source model of the combo box.</simpara></listitem>
+	</varlistentry>
+      </variablelist>
+
+      <note>
+	<para>This method is available in PyGTK 2.24 and above.</para>
+      </note>
+
+      <para>The <methodname>get_entry_text_column</methodname>() method returns
+      the columns which the combo box is using to get the strings
+      from to display in the internal entry.</para>
+
+    </refsect2>
+
+    <refsect2 id="method-gtkcombobox--set-entry-text-column">
+      <title>gtk.ComboBox.set_entry_text_column</title>
+
+      <programlisting><methodsynopsis language="python">
+	  <methodname>set_entry_text_column</methodname>
+	  <methodparam><parameter role="keyword">text_column</parameter></methodparam>
+	</methodsynopsis></programlisting>
+      <variablelist>
+	<varlistentry>
+	  <term><parameter role="keyword">text_column</parameter>&nbsp;:</term>
+	  <listitem><simpara>A column in the data source model to get the strings from for the internal entry.</simpara></listitem>
+	</varlistentry>
+      </variablelist>
+
+      <note>
+	<para>This method is available in PyGTK 2.24 and above.</para>
+      </note>
+
+      <para>The <methodname>set_entry_text_column</methodname>() method sets the model column
+      which the combo box should use to get strings from to be text_column. The column text_column
+      in the model of combo box must be of type G_TYPE_STRING.</para>
+
+    </refsect2>
+
     <refsect2 id="method-gtkcombobox--get-wrap-width">
       <title>gtk.ComboBox.get_wrap_width</title>
 



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