[pygtk] Add new properties and signals of gtk.Entry added in 2.16
- From: Gian Mario Tagliaretti <gianmt src gnome org>
- To: svn-commits-list gnome org
- Cc:
- Subject: [pygtk] Add new properties and signals of gtk.Entry added in 2.16
- Date: Sun, 23 Aug 2009 16:21:59 +0000 (UTC)
commit 6722d7038bb0bf7f5e7d6e7152ad12251a570afc
Author: Gian Mario Tagliaretti <gianmt gnome org>
Date: Sun Aug 23 18:18:39 2009 +0200
Add new properties and signals of gtk.Entry added in 2.16
docs/reference/pygtk-gtkentry.xml | 398 ++++++++++++++++++++++++++++++++++++-
1 files changed, 397 insertions(+), 1 deletions(-)
---
diff --git a/docs/reference/pygtk-gtkentry.xml b/docs/reference/pygtk-gtkentry.xml
index c879fda..98968be 100644
--- a/docs/reference/pygtk-gtkentry.xml
+++ b/docs/reference/pygtk-gtkentry.xml
@@ -211,6 +211,16 @@ linkend="method-gtkentry--get-completion">get_completion</link></methodname>
</row>
<row valign="top">
+ <entry>"caps-lock-warning"</entry>
+ <entry>Read/Write</entry>
+ <entry>Whether password entries will show a warning when Caps Lock is on.
+ Note that the warning is shown using a secondary icon, and thus does not work
+ if you are using the secondary icon position for some other purpose. Default value: <literal>True</literal>.
+ This property is available in GTK+ 2.16 and above.
+ </entry>
+ </row>
+
+ <row valign="top">
<entry>"cursor-position"</entry>
<entry>Read</entry>
<entry>The current position of the insertion cursor as a
@@ -218,7 +228,6 @@ linkend="method-gtkentry--get-completion">get_completion</link></methodname>
0</entry>
</row>
-
<row valign="top">
<entry>"editable"</entry>
<entry>Read/Write</entry>
@@ -234,6 +243,17 @@ linkend="method-gtkentry--get-completion">get_completion</link></methodname>
</row>
<row valign="top">
+ <entry>"im-module"</entry>
+ <entry>Read/Write</entry>
+ <entry>Which IM (input method) module should be used for this entry. See
+ <link linkend="class-gtkimcontext"><classname>gtk.IMContext</classname></link>.
+ Setting this to a non-<literal>None</literal> value overrides the system-wide
+ IM module setting. See the <link linkend="class-gtksettings"><classname>gtk.Settings</classname></link>
+ "gtk-im-module" property. Default value: <literal>None</literal>.
+ This property is available in GTK+ 2.16 and above.</entry>
+ </row>
+
+ <row valign="top">
<entry>"inner-border"</entry>
<entry>Read/Write</entry>
<entry>The text area's border between the text and the frame
@@ -249,6 +269,15 @@ linkend="method-gtkentry--get-completion">get_completion</link></methodname>
</row>
<row valign="top">
+ <entry>"invisible-char-set"</entry>
+ <entry>Read/Write</entry>
+ <entry>
+ Whether the invisible char has been set for the GtkEntry.
+ Default value: <literal>False</literal> This property is available in GTK+ 2.16 and above.
+ </entry>
+ </row>
+
+ <row valign="top">
<entry>"max-length"</entry>
<entry>Read/Write</entry>
<entry>The maximum number of characters for this entry. Zero
@@ -265,6 +294,124 @@ linkend="method-gtkentry--get-completion">get_completion</link></methodname>
</row>
<row valign="top">
+ <entry>"primary-icon-activatable"</entry>
+ <entry>Read/Write</entry>
+ <entry>
+ Whether the primary icon is activatable.
+ GTK+ emits the "icon-press" and "icon-release" signals only on sensitive, activatable icons.
+ Sensitive, but non-activatable icons can be used for purely informational purposes.
+ Default value: <literal>False</literal>
+ This property is available in GTK+ 2.16 and above.
+ </entry>
+ </row>
+
+ <row valign="top">
+ <entry>"primary-icon-gicon"</entry>
+ <entry>Read/Write</entry>
+ <entry>
+ The <link linkend="class-gioicon"><classname>gio.Icon</classname></link>
+ to use for the primary icon for the entry.
+ This property is available in GTK+ 2.16 and above.
+ </entry>
+ </row>
+
+ <row valign="top">
+ <entry>"primary-icon-name"</entry>
+ <entry>Read/Write</entry>
+ <entry>
+ The icon name to use for the primary icon for the entry.
+ Default value: <literal>None</literal>
+ This property is available in GTK+ 2.16 and above.
+ </entry>
+ </row>
+
+ <row valign="top">
+ <entry>"primary-icon-pixbuf"</entry>
+ <entry>Read/Write</entry>
+ <entry>
+ A pixbuf to use as the primary icon for the entry.
+ This property is available in GTK+ 2.16 and above.
+ </entry>
+ </row>
+
+ <row valign="top">
+ <entry>"primary-icon-sensitive"</entry>
+ <entry>Read/Write</entry>
+ <entry>
+ Whether the primary icon is sensitive.
+ An insensitive icon appears grayed out. GTK+ does not emit the
+ "icon-press" and "icon-release" signals and does not allow DND from insensitive icons.
+ An icon should be set insensitive if the action that would trigger when
+ clicked is currently not available. Default value: <literal>True</literal>
+ This property is available in GTK+ 2.16 and above.
+ </entry>
+ </row>
+
+ <row valign="top">
+ <entry>"primary-icon-stock"</entry>
+ <entry>Read/Write</entry>
+ <entry>
+ The stock id to use for the primary icon for the entry.
+ Default value: <literal>None</literal>
+ This property is available in GTK+ 2.16 and above.
+ </entry>
+ </row>
+
+ <row valign="top">
+ <entry>"primary-icon-storage-type"</entry>
+ <entry>Read/Write</entry>
+ <entry>
+ The representation which is used for the primary icon of the entry.
+ Default value: gtk.IMAGE_EMPTY
+ This property is available in GTK+ 2.16 and above.
+ </entry>
+ </row>
+
+ <row valign="top">
+ <entry>"primary-icon-tooltip-markup"</entry>
+ <entry>Read/Write</entry>
+ <entry>
+ The contents of the tooltip on the primary icon, which is marked
+ up with the Pango text markup language.
+ Also see gtk_entry_set_icon_tooltip_markup(). ##FIXME
+ Default value: <literal>None</literal>.
+ This property is available in GTK+ 2.16 and above.
+ </entry>
+ </row>
+
+ <row valign="top">
+ <entry>"primary-icon-tooltip-text"</entry>
+ <entry>Read/Write</entry>
+ <entry>
+ The contents of the tooltip on the primary icon.
+ Also see gtk_entry_set_icon_tooltip_text(). ##FIXME
+ Default value: <literal>None</literal>.
+ This property is available in GTK+ 2.16 and above.
+ </entry>
+ </row>
+
+ <row valign="top">
+ <entry>"progress-fraction"</entry>
+ <entry>Read/Write</entry>
+ <entry>
+ The current fraction of the task that's been completed.
+ Allowed values: [0,1] Default value: 0
+ This property is available in GTK+ 2.16 and above.
+ </entry>
+ </row>
+
+ <row valign="top">
+ <entry>"progress-pulse-step"</entry>
+ <entry>Read/Write</entry>
+ <entry>
+ The fraction of total entry width to move the progress bouncing block
+ for each call to gtk_entry_progress_pulse(). ##FIXME
+ Allowed values: [0,1] Default value: 0.1
+ This property is available in GTK+ 2.16 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
@@ -273,6 +420,104 @@ linkend="method-gtkentry--get-completion">get_completion</link></methodname>
</row>
<row valign="top">
+ <entry>"secondary-icon-activatable"</entry>
+ <entry>Read/Write</entry>
+ <entry>
+ Whether the secondary icon is activatable.
+ GTK+ emits the "icon-press" and "icon-release" signals only on sensitive, activatable icons.
+ Sensitive, but non-activatable icons can be used for purely informational purposes.
+ Default value: <literal>False</literal>
+ This property is available in GTK+ 2.16 and above.
+ </entry>
+ </row>
+
+ <row valign="top">
+ <entry>"secondary-icon-gicon"</entry>
+ <entry>Read/Write</entry>
+ <entry>
+ The <link linkend="class-gioicon"><classname>gio.Icon</classname></link>
+ to use for the secondary icon for the entry.
+ This property is available in GTK+ 2.16 and above.
+ </entry>
+ </row>
+
+ <row valign="top">
+ <entry>"secondary-icon-name"</entry>
+ <entry>Read/Write</entry>
+ <entry>
+ The icon name to use for the secondary icon for the entry.
+ Default value: <literal>None</literal>.
+ This property is available in GTK+ 2.16 and above.
+ </entry>
+ </row>
+
+ <row valign="top">
+ <entry>"secondary-icon-pixbuf"</entry>
+ <entry>Read/Write</entry>
+ <entry>
+ A pixbuf to use as the secondary icon for the entry.
+ This property is available in GTK+ 2.16 and above.
+ </entry>
+ </row>
+
+ <row valign="top">
+ <entry>"secondary-icon-sensitive"</entry>
+ <entry>Read/Write</entry>
+ <entry>
+ Whether the secondary icon is sensitive.
+ An insensitive icon appears grayed out. GTK+ does not emit the
+ "icon-press" and "icon-release" signals and does not allow DND from insensitive icons.
+ An icon should be set insensitive if the action that would trigger when
+ clicked is currently not available.
+ Default value: <literal>True</literal>.
+ This property is available in GTK+ 2.16 and above.
+ </entry>
+ </row>
+
+ <row valign="top">
+ <entry>"secondary-icon-stock"</entry>
+ <entry>Read/Write</entry>
+ <entry>
+ The stock id to use for the secondary icon for the entry.
+ Default value: <literal>None</literal>.
+ This property is available in GTK+ 2.16 and above.
+ </entry>
+ </row>
+
+ <row valign="top">
+ <entry>"secondary-icon-storage-type"</entry>
+ <entry>Read/Write</entry>
+ <entry>
+ The representation which is used for the secondary icon of the entry.
+ Default value: gtk.IMAGE_EMPTY
+ This property is available in GTK+ 2.16 and above.
+ </entry>
+ </row>
+
+ <row valign="top">
+ <entry>"secondary-icon-tooltip-markup"</entry>
+ <entry>Read/Write</entry>
+ <entry>
+ The contents of the tooltip on the secondary icon, which is marked
+ up with the Pango text markup language.
+ Also see gtk_entry_set_icon_tooltip_markup(). ##FIXME
+ Default value: <literal>None</literal>.
+ This property is available in GTK+ 2.16 and above.
+ </entry>
+ </row>
+
+ <row valign="top">
+ <entry>"secondary-icon-tooltip-text"</entry>
+ <entry>Read/Write</entry>
+ <entry>
+ The contents of the tooltip on the secondary icon.
+ Also see gtk_entry_set_icon_tooltip_text(). #Ã FIXME
+ Default value: <literal>None</literal>.
+ This property is available in GTK+ 2.16 and above.
+ </entry>
+ </row>
+
+ <row valign="top">
<entry>"selection-bound"</entry>
<entry>Read</entry>
<entry>The position of the opposite end of the selection from
@@ -356,12 +601,30 @@ linkend="method-gtkentry--get-completion">get_completion</link></methodname>
<tbody>
<row valign="top">
+ <entry>"icon-prelight"</entry>
+ <entry>Read</entry>
+ <entry>The prelight style property determines whether activatable icons
+ prelight on mouseover. Default value: <literal>True</literal>
+ This property is available in GTK+ 2.16 and above.</entry>
+ </row>
+
+ <row valign="top">
<entry>"inner-border"</entry>
<entry>Read</entry>
<entry>Sets the text area's border between the text and the frame
This property is available in GTK+ 2.10 and above.</entry>
</row>
+ <row valign="top">
+ <entry>"state-hint"</entry>
+ <entry>Read</entry>
+ <entry>
+ Indicates whether to pass a proper widget state when drawing the shadow
+ and the widget background. Default value: <literal>False</literal>.
+ This property is available in GTK+ 2.16 and above.
+ </entry>
+ </row>
+
</tbody>
</tgroup>
</informaltable>
@@ -455,6 +718,44 @@ linkend="signal-gtkentry--delete-from-cursor">delete-from-cursor</link>"</term>
</varlistentry>
<varlistentry>
<term>"<link
+linkend="signal-gtkentry--icon-press">icon-press</link>"</term>
+ <listitem>
+ <methodsynopsis
+ language="python"><methodname>callback</methodname>
+ <methodparam><parameter>entry</parameter>
+ </methodparam>
+ <methodparam><parameter>icon_pos</parameter>
+ </methodparam>
+ <methodparam><parameter>event</parameter>
+ </methodparam>
+ <methodparam><parameter>user_param1</parameter>
+ </methodparam>
+ <methodparam><parameter>...</parameter>
+ </methodparam>
+ </methodsynopsis>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>"<link
+linkend="signal-gtkentry--icon-press">icon-release</link>"</term>
+ <listitem>
+ <methodsynopsis
+ language="python"><methodname>callback</methodname>
+ <methodparam><parameter>entry</parameter>
+ </methodparam>
+ <methodparam><parameter>icon_pos</parameter>
+ </methodparam>
+ <methodparam><parameter>event</parameter>
+ </methodparam>
+ <methodparam><parameter>user_param1</parameter>
+ </methodparam>
+ <methodparam><parameter>...</parameter>
+ </methodparam>
+ </methodsynopsis>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>"<link
linkend="signal-gtkentry--insert-at-cursor">insert-at-cursor</link>"</term>
<listitem>
<methodsynopsis
@@ -1515,6 +1816,101 @@ any)</simpara></listitem>
</refsect2>
+ <refsect2 id="signal-gtkentry--icon-press">
+ <title>The "icon-press" gtk.Entry Signal</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>callback</methodname>
+ <methodparam><parameter>entry</parameter></methodparam>
+ <methodparam><parameter>icon_pos</parameter></methodparam>
+ <methodparam><parameter>event</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter>entry</parameter> :</term>
+ <listitem><simpara>the entry that received the
+signal</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>icon_pos</parameter> :</term>
+ <listitem><simpara>The position of the clicked icon.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>event</parameter> :</term>
+ <listitem>The button press event.<simpara>
+ </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 "icon-press" signal is emitted when an activatable icon is clicked.
+ </para>
+
+ </refsect2>
+
+ <refsect2 id="signal-gtkentry--icon-release">
+ <title>The "icon-release" gtk.Entry Signal</title>
+
+ <programlisting><methodsynopsis language="python">
+ <methodname>callback</methodname>
+ <methodparam><parameter>entry</parameter></methodparam>
+ <methodparam><parameter>icon_pos</parameter></methodparam>
+ <methodparam><parameter>event</parameter></methodparam>
+ <methodparam><parameter>user_param1</parameter></methodparam>
+ <methodparam><parameter>...</parameter></methodparam>
+ </methodsynopsis></programlisting>
+
+ <variablelist>
+ <varlistentry>
+ <term><parameter>entry</parameter> :</term>
+ <listitem><simpara>the entry that received the
+signal</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>icon_pos</parameter> :</term>
+ <listitem><simpara>The position of the clicked icon.</simpara></listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>event</parameter> :</term>
+ <listitem>The button press event.<simpara>
+ </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 "icon-press" signal is emitted when the button release from a mouse
+ click over an activatable icon.
+ </para>
+
+ </refsect2>
+
<refsect2 id="signal-gtkentry--insert-at-cursor">
<title>The "insert-at-cursor" gtk.Entry Signal</title>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
