pygtk r3047 - trunk/docs/reference
- From: gianmt svn gnome org
- To: svn-commits-list gnome org
- Subject: pygtk r3047 - trunk/docs/reference
- Date: Mon, 17 Nov 2008 21:38:00 +0000 (UTC)
Author: gianmt
Date: Mon Nov 17 21:38:00 2008
New Revision: 3047
URL: http://svn.gnome.org/viewvc/pygtk?rev=3047&view=rev
Log:
Update docs to 2.14 and fix #560509
Modified:
trunk/docs/reference/ChangeLog
trunk/docs/reference/pygtk-gtkcalendar.xml
trunk/docs/reference/pygtk-gtkcellrenderercombo.xml
trunk/docs/reference/pygtk-gtkcellrendererpixbuf.xml
trunk/docs/reference/pygtk-gtkcombobox.xml
trunk/docs/reference/pygtk-gtkentry.xml
trunk/docs/reference/pygtk-gtkimage.xml
Modified: trunk/docs/reference/pygtk-gtkcalendar.xml
==============================================================================
--- trunk/docs/reference/pygtk-gtkcalendar.xml (original)
+++ trunk/docs/reference/pygtk-gtkcalendar.xml Mon Nov 17 21:38:00 2008
@@ -60,6 +60,28 @@
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
+linkend="method-gtkcalendar--get-detail-height-rows">get_detail_height_rows</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link
+linkend="method-gtkcalendar--set-detail-height-rows">set_detail_height_rows</link></methodname>
+ <methodparam><parameter
+ role="keyword">rows</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link
+linkend="method-gtkcalendar--get-detail-width-chars">get_detail_width_chars</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link
+linkend="method-gtkcalendar--set-detail-width-chars">set_detail_width_chars</link></methodname>
+ <methodparam><parameter
+ role="keyword">chars</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link
linkend="method-gtkcalendar--display-options">display_options</link></methodname>
<methodparam><parameter
role="keyword">flags</parameter></methodparam>
@@ -128,6 +150,22 @@
</row>
<row valign="top">
+ <entry>"detail-height-rows"</entry>
+ <entry>Read-Write</entry>
+ <entry>Height of a detail cell, in rows. A value of 0 allows any width.
+ See gtk_calendar_set_detail_func(). Allowed values: [0,127].
+ Default value: 0 .This property is available in GTK+ 2.14 and above.</entry>
+ </row>
+
+ <row valign="top">
+ <entry>"detail-width-chars"</entry>
+ <entry>Read-Write</entry>
+ <entry>Width of a detail cell, in characters. A value of 0 allows any width.
+ See gtk_calendar_set_detail_func(). Allowed values: [0,127] Default value: 0.
+ This property is available in GTK+ 2.14 and above.</entry>
+ </row>
+
+ <row valign="top">
<entry>"month"</entry>
<entry>Read-Write</entry>
<entry>The selected month (as a number between 0 and 11).</entry>
@@ -148,6 +186,15 @@
</row>
<row valign="top">
+ <entry>"show-details"</entry>
+ <entry>Read-Write</entry>
+ <entry>Determines whether details are shown directly in the widget,
+ or if they are available only as tooltip. When this property is set days
+ with details are marked. Default value: <literal>True</literal>.
+ This property is available in GTK+ 2.14 and above.</entry>
+ </row>
+
+ <row valign="top">
<entry>"show-heading"</entry>
<entry>Read-Write</entry>
<entry>If <literal>True</literal>, a heading is
@@ -618,6 +665,108 @@
</refsect2>
+ <refsect2 id="method-gtkcalendar--get-detail-height-rows">
+ <title>gtk.Calendar.get_detail_height_rows</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_detail_height_rows</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>The height of detail cells, in rows.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_detail_height_rows</methodname>() method
+ queries the height of detail cells, in rows. See the "detail-width-chars" property.
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkcalendar--set-detail-height-rows">
+ <title>gtk.Calendar.set_detail_height_rows</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_detail_height_rows</methodname>
+ <methodparam><parameter
+ role="keyword">rows</parameter></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">rows</parameter> :</term>
+ <listitem><simpara>detail height in rows.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>set_detail_height_rows</methodname>() method
+ updates the height of detail cells. See the "detail-height-rows" property.
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkcalendar--get-detail-width-chars">
+ <title>gtk.Calendar.get_detail_width_chars</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_detail_width_chars</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>The width of detail cells, in characters.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_detail_width_chars</methodname>() method
+ queries the width of detail cells, in characters. See the "detail-width-chars" property.
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkcalendar--set-detail-width-chars">
+ <title>gtk.Calendar.set_detail_width_chars</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_detail_width_chars</methodname>
+ <methodparam><parameter
+ role="keyword">chars</parameter></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">chars</parameter> :</term>
+ <listitem><simpara>detail width in characters.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>set_detail_width_chars</methodname>() method
+ updates the width of detail cells. See the "detail-width-chars" property.
+ </para>
+
+ </refsect2>
+
<refsect2 id="method-gtkcalendar--display-options">
<title>gtk.Calendar.display_options</title>
Modified: trunk/docs/reference/pygtk-gtkcellrenderercombo.xml
==============================================================================
--- trunk/docs/reference/pygtk-gtkcellrenderercombo.xml (original)
+++ trunk/docs/reference/pygtk-gtkcellrenderercombo.xml Mon Nov 17 21:38:00 2008
@@ -92,7 +92,26 @@
<para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkcellrenderer">gtk.CellRenderer Signal Prototypes</link></para>
<para><link linkend="signal-prototypes-gtkcellrenderertext">gtk.CellRendererText Signal Prototypes</link></para>
-</refsect1>
+
+ <variablelist>
+ <varlistentry>
+ <term>"<link
+linkend="signal-gtkcellrenderercombo--changed">changed</link>"</term>
+ <listitem>
+ <methodsynopsis
+ language="python"><methodname>callback</methodname>
+ <methodparam><parameter>combo</parameter></methodparam>
+ <methodparam><parameter>path_string</parameter></methodparam>
+ <methodparam><parameter>new_iter</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter>
+ </methodparam>
+ <methodparam><parameter>...</parameter>
+ </methodparam>
+ </methodsynopsis>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect1>
<refsect1>
<title>Description</title>
@@ -143,5 +162,65 @@
linkend="class-gtktreeview"><classname>gtk.TreeView</classname></link>.</para>
</refsect1>
+<refsect1>
+ <title>Signals</title>
+
+ <refsect2 id="signal-gtkcellrenderercombo--changed">
+ <title>The "changed" gtk.Calendar Signal</title>
+ <programlisting><methodsynopsis language="python">
+ <methodname>callback</methodname>
+ <methodparam><parameter>combo</parameter></methodparam>
+ <methodparam><parameter>path_string</parameter></methodparam>
+ <methodparam><parameter>new_iter</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter>combo</parameter> :</term>
+ <listitem><simpara>the object on which the signal is emitted </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>path_string</parameter> :</term>
+ <listitem><simpara>a string of the path identifying the edited cell
+ (relative to the tree view model) </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>new_iter</parameter> :</term>
+ <listitem><simpara>the new iter selected in the combo box
+ (relative to the combo box model) </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_param1</parameter> :</term>
+ <listitem><simpara>the first user parameter (if any) specified
+with the <link
+linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
+method</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>...</parameter> :</term>
+ <listitem><simpara>additional user parameters (if
+any)</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>
+ The "changed" signal is emitted each time after the user selected an item in
+ the combo box, either by using the mouse or the arrow keys. Contrary to GtkComboBox,
+ GtkCellRendererCombo::changed is not emitted for changes made to a selected item in
+ the entry. The argument new_iter corresponds to the newly selected item in the combo
+ box and it is relative to the GtkTreeModel set via the model property on GtkCellRendererCombo.
+ </para>
+ <para>
+ Note that as soon as you change the model displayed in the tree view, the tree view will
+ immediately cease the editing operating. This means that you most probably want to refrain
+ from changing the model until the combo cell renderer emits the edited or editing_canceled signal.
+ </para>
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+ </refsect2>
+ </refsect1>
</refentry>
Modified: trunk/docs/reference/pygtk-gtkcellrendererpixbuf.xml
==============================================================================
--- trunk/docs/reference/pygtk-gtkcellrendererpixbuf.xml (original)
+++ trunk/docs/reference/pygtk-gtkcellrendererpixbuf.xml Mon Nov 17 21:38:00 2008
@@ -60,6 +60,14 @@
endterm="gtk-cellrenderer-state-constants-title"></xref>. This
property is available in GTK+ 2.8 and above.</entry>
</row>
+
+ <row valign="top">
+ <entry>"gicon"</entry>
+ <entry>Read-Write</entry>
+ <entry>If <literal>True</literal> the GIcon representing the icon to display.
+ If the icon theme is changed, the image will be updated automatically. This
+ property is available in GTK+ 2.14 and above.</entry>
+ </row>
<row valign="top">
<entry>"icon-name"</entry>
Modified: trunk/docs/reference/pygtk-gtkcombobox.xml
==============================================================================
--- trunk/docs/reference/pygtk-gtkcombobox.xml (original)
+++ trunk/docs/reference/pygtk-gtkcombobox.xml Mon Nov 17 21:38:00 2008
@@ -43,6 +43,14 @@
<methodparam><parameter role="keyword">column_span</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
+ <methodname><link linkend="method-gtkcombobox--get-button-sensitivity">get_button_sensitivity</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkcombobox--set-button-sensitivity">set_button_sensitivity</link></methodname>
+ <methodparam><parameter role="keyword">sensitivity</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
<methodname><link linkend="method-gtkcombobox--get-active">get_active</link></methodname>
<methodparam></methodparam> </methodsynopsis>
<methodsynopsis language="python">
@@ -202,6 +210,14 @@
</row>
<row valign="top">
+ <entry>"button-sensitivity"</entry>
+ <entry>Read-Write</entry>
+ <entry>Whether the dropdown button is sensitive when the model is empty.
+ Default value: gtk.SENSITIVITY_AUTO. Available in
+ GTK+ 2.14 and above.</entry>
+ </row>
+
+ <row valign="top">
<entry>"column-span-column"</entry>
<entry>Read-Write</entry>
<entry>The TreeModel column containing the column span values.
@@ -338,6 +354,37 @@
</methodsynopsis>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>"<link linkend="signal-gtkcombobox--move-active">move-active</link>"</term>
+ <listitem>
+ <methodsynopsis language="python"><methodname>callback</methodname>
+ <methodparam><parameter>combobox</parameter></methodparam>
+ <methodparam><parameter>scroll_type</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>"<link linkend="signal-gtkcombobox--popdown">popdown</link>"</term>
+ <listitem>
+ <methodsynopsis language="python"><methodname>callback</methodname>
+ <methodparam><parameter>combobox</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>"<link linkend="signal-gtkcombobox--popup">popup</link>"</term>
+ <listitem>
+ <methodsynopsis language="python"><methodname>callback</methodname>
+ <methodparam><parameter>combobox</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis>
+ </listitem>
+ </varlistentry>
</variablelist>
</refsect1>
@@ -603,6 +650,61 @@
</refsect2>
+ <refsect2 id="method-gtkcombobox--get-button-sensitivity">
+ <title>gtk.ComboBox.get_button_sensitivity</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_button_sensitivity</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>gtk.SENSITIVITY_ON if the dropdown button is sensitive when
+ the model is empty, gtk.SENSITIVITY_OFF if the button is always insensitive
+ or gtk.SENSITIVITY_AUTO if it is only sensitive as long as the model
+ has one item to be selected.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_button_sensitivity</methodname>() method returns whether
+ the combo box sets the dropdown button sensitive or not when there are no items in the model.
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkcombobox--set-button-sensitivity">
+ <title>gtk.ComboBox.set_button_sensitivity</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_button_sensitivity</methodname>
+ <methodparam><parameter role="keyword">sensitivity</parameter></methodparam>
+ </methodsynopsis></programlisting>
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">sensitivity</parameter> :</term>
+ <listitem><simpara>specify the sensitivity of the dropdown button.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>set_button_sensitivity</methodname>() method sets whether the
+ dropdown button of the combo box should be always sensitive (gtk.SENSITIVITY_ON),
+ never sensitive (gtk.SENSITIVITY_OFF) or only if there is at least one item to
+ display (gtk.SENSITIVITY_AUTO).
+ </para>
+
+ </refsect2>
+
<refsect2 id="method-gtkcombobox--get-active">
<title>gtk.ComboBox.get_active</title>
@@ -1309,6 +1411,123 @@
is selected.</para>
</refsect2>
+
+ <refsect2 id="signal-gtkcombobox--move-active">
+ <title>The "move-active" gtk.ComboBox Signal</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>callback</methodname>
+ <methodparam><parameter>combobox</parameter></methodparam>
+ <methodparam><parameter>scroll_type</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter>combobox</parameter> :</term>
+ <listitem><simpara>the combo box that received the
+ signal</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>scroll_type</parameter> :</term>
+ <listitem><simpara>a
+ <xref linkend="gtk-scroll-type-constants" endterm="gtk-scroll-type-constants-title">GtkScrollType</xref>
+ </simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_param1</parameter> :</term>
+ <listitem><simpara>the first user parameter (if any) specified
+ with the <link linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
+ method</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>...</parameter> :</term>
+ <listitem><simpara>additional user parameters (if any)</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This signal is available in PyGTK 2.12 and above.</para>
+ </note>
+
+ <para>The "move-active" signal is a keybinding signal which gets emitted to move the active selection.</para>
+
+ </refsect2>
+
+ <refsect2 id="signal-gtkcombobox--popdown">
+ <title>The "popdown" gtk.ComboBox Signal</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>callback</methodname>
+ <methodparam><parameter>combobox</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter>combobox</parameter> :</term>
+ <listitem><simpara>the combo box that received the
+ signal</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_param1</parameter> :</term>
+ <listitem><simpara>the first user parameter (if any) specified
+ with the <link linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
+ method</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>...</parameter> :</term>
+ <listitem><simpara>additional user parameters (if any)</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This signal is available in PyGTK 2.12 and above.</para>
+ </note>
+
+ <para>The "popdown" signal is a keybinding signal which gets emitted to popdown
+ the combo box list. The default bindings for this signal are Alt+Up and Escape.</para>
+
+ </refsect2>
+
+ <refsect2 id="signal-gtkcombobox--popup">
+ <title>The "popup" gtk.ComboBox Signal</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>callback</methodname>
+ <methodparam><parameter>combobox</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter>combobox</parameter> :</term>
+ <listitem><simpara>the combo box that received the
+ signal</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>user_param1</parameter> :</term>
+ <listitem><simpara>the first user parameter (if any) specified
+ with the <link linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
+ method</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>...</parameter> :</term>
+ <listitem><simpara>additional user parameters (if any)</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This signal is available in PyGTK 2.12 and above.</para>
+ </note>
+
+ <para>The "popup" signal is a keybinding signal which gets emitted to popup
+ the combo box list. The default bindings for this signal are Alt+Down.</para>
+
+ </refsect2>
</refsect1>
Modified: trunk/docs/reference/pygtk-gtkentry.xml
==============================================================================
--- trunk/docs/reference/pygtk-gtkentry.xml (original)
+++ trunk/docs/reference/pygtk-gtkentry.xml Mon Nov 17 21:38:00 2008
@@ -141,13 +141,25 @@
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
+ <methodname><link linkend="method-gtkentry--get-cursor-hadjustment">get_cursor_hadjustment</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
<methodname><link linkend="method-gtkentry--set-cursor-hadjustment">set_cursor_hadjustment</link></methodname>
<methodparam><parameter role="keyword">adjustment</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
- <methodname><link linkend="method-gtkentry--get-cursor-hadjustment">get_cursor_hadjustment</link></methodname>
+ <methodname><link linkend="method-gtkentry--get-override-mode">get_override_mode</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkentry--set-override-mode">set_override_mode</link></methodname>
+ <methodparam><parameter role="keyword">override</parameter></methodparam>
+ </methodsynopsis>
+ <methodsynopsis language="python">
+ <methodname><link linkend="method-gtkentry--get-text-length">get_text_length</link></methodname>
+ <methodparam></methodparam>
+ </methodsynopsis>
</classsynopsis>
</refsect1>
@@ -245,6 +257,14 @@
</row>
<row valign="top">
+ <entry>"override-mode"</entry>
+ <entry>Read/Write</entry>
+ <entry>If text is overwritten when typing in the GtkEntry.
+ Default value: <literal>False</literal>.
+ Available in GTK+ 2.14 and above.</entry>
+ </row>
+
+ <row valign="top">
<entry>"scroll-offset"</entry>
<entry>Read</entry>
<entry>The number of pixels of the entry scrolled off the
@@ -276,6 +296,13 @@
</row>
<row valign="top">
+ <entry>"text-length"</entry>
+ <entry>Read</entry>
+ <entry>The length of the text in the GtkEntry. Allowed values: [0,65535].
+ Default value: 0. Available in GTK+ 2.14 and above.</entry>
+ </row>
+
+ <row valign="top">
<entry>"truncate-multiline"</entry>
<entry>Read/Write</entry>
<entry>If <literal>True</literal>, pasted multi-line text is
@@ -1188,6 +1215,83 @@
</para>
</refsect2>
+
+ <refsect2 id="method-gtkentry--set-override-mode">
+ <title>gtk.Entry.set_override_mode</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>set_override_mode</methodname>
+ <methodparam><parameter role="keyword">override</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter role="keyword">override</parameter> :</term>
+ <listitem><simpara>new value.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>set_override_mode</methodname>() method sets whether the text
+ is overwritten when typing in the GtkEntry.
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkentry--get-override-mode">
+ <title>gtk.Entry.get_override_mode</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_override_mode</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>whether the text is overwritten when typing.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_override_mode</methodname>() method gets the value set by
+ <methodname><link linkend="method-gtkentry--set-override-mode">gtk.Entry.set_override_mode</link></methodname>().
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="method-gtkentry--get-text-length">
+ <title>gtk.Entry.get_text_length</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>get_text_length</methodname>
+ <methodparam></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><emphasis>Returns</emphasis> :</term>
+ <listitem><simpara>the current number of characters in GtkEntry, or 0 if there are none.</simpara></listitem>
+ </varlistentry>
+ </variablelist>
+
+ <note>
+ <para>This method is available in PyGTK 2.14 and above.</para>
+ </note>
+
+ <para>
+ The <methodname>get_text_length</methodname>() method retrieves the current length of the text in entry.
+ </para>
+
+ </refsect2>
</refsect1>
Modified: trunk/docs/reference/pygtk-gtkimage.xml
==============================================================================
--- trunk/docs/reference/pygtk-gtkimage.xml (original)
+++ trunk/docs/reference/pygtk-gtkimage.xml Mon Nov 17 21:38:00 2008
@@ -211,6 +211,15 @@
</row>
<row valign="top">
+ <entry>"gicon"</entry>
+ <entry>Read-Write</entry>
+
+ <entry>The GIcon displayed in the GtkImage. For themed icons,
+ If the icon theme is changed, the image will be updated automatically.
+ Available in GTK 2.14 and above.</entry>
+ </row>
+
+ <row valign="top">
<entry>"icon-name"</entry>
<entry>Read-Write</entry>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
