diff options
| author | Dieter Verfaillie <dieterv@optionexplicit.be> | 2011-02-24 07:10:02 +0100 |
|---|---|---|
| committer | Dieter Verfaillie <dieterv@optionexplicit.be> | 2011-02-24 07:10:02 +0100 |
| commit | 2283f7b5bcd8c128fc1e7c5c05c9fa3625e27dfa (patch) | |
| tree | 486ad31a1eee84049f6e20696d5c765f4c32eac3 | |
| parent | 263fe7ee199e5504101b549d5dcc8017a9b6bded (diff) | |
| download | pygtk-2283f7b5bcd8c128fc1e7c5c05c9fa3625e27dfa.tar.gz | |
reference: pygtk-gtkentry.xml: add new methods, properties and signals and mark deprecated stuff as such
| -rw-r--r-- | docs/reference/pygtk-gtkentry.xml | 1459 |
1 files changed, 1300 insertions, 159 deletions
diff --git a/docs/reference/pygtk-gtkentry.xml b/docs/reference/pygtk-gtkentry.xml index 98968be5..6a7eb51a 100644 --- a/docs/reference/pygtk-gtkentry.xml +++ b/docs/reference/pygtk-gtkentry.xml @@ -13,124 +13,100 @@ <classsynopsis language="python"> <ooclass><classname>gtk.Entry</classname></ooclass> - <ooclass><classname><link -linkend="class-gtkwidget">gtk.Widget</link></classname></ooclass> - <ooclass><classname><link -linkend="class-gtkeditable">gtk.Editable</link></classname></ooclass> - <ooclass><classname><link -linkend="class-gtkcelleditable">gtk.CellEditable</link></classname></ooclass> + <ooclass><classname><link linkend="class-gtkwidget">gtk.Widget</link></classname></ooclass> + <ooclass><classname><link linkend="class-gtkeditable">gtk.Editable</link></classname></ooclass> + <ooclass><classname><link linkend="class-gtkcelleditable">gtk.CellEditable</link></classname></ooclass> <constructorsynopsis language="python"> - <methodname><link -linkend="constructor-gtkentry">gtk.Entry</link></methodname> - <methodparam><parameter - role="keyword">max</parameter><initializer>0</initializer></methodparam> + <methodname><link linkend="constructor-gtkentry">gtk.Entry</link></methodname> + <methodparam><parameter role="keyword">max</parameter><initializer>0</initializer></methodparam> </constructorsynopsis> <methodsynopsis language="python"> - <methodname><link -linkend="method-gtkentry--set-visibility">set_visibility</link></methodname> - <methodparam><parameter - role="keyword">visible</parameter></methodparam> + <methodname><link linkend="method-gtkentry--set-visibility">set_visibility</link></methodname> + <methodparam><parameter role="keyword">visible</parameter></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link -linkend="method-gtkentry--get-visibility">get_visibility</link></methodname> - <methodparam></methodparam> + <methodname><link linkend="method-gtkentry--get-visibility">get_visibility</link></methodname> + <methodparam></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link -linkend="method-gtkentry--set-invisible-char">set_invisible_char</link></methodname> - <methodparam><parameter role="keyword">ch</parameter></methodparam> + <methodname><link linkend="method-gtkentry--set-invisible-char">set_invisible_char</link></methodname> + <methodparam><parameter role="keyword">ch</parameter></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link -linkend="method-gtkentry--get-invisible-char">get_invisible_char</link></methodname> - <methodparam></methodparam> + <methodname><link linkend="method-gtkentry--get-invisible-char">get_invisible_char</link></methodname> + <methodparam></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link -linkend="method-gtkentry--set-has-frame">set_has_frame</link></methodname> - <methodparam><parameter - role="keyword">setting</parameter></methodparam> + <methodname><link linkend="method-gtkentry--unset-invisible-char">unset_invisible_char</link></methodname> + <methodparam><parameter role="keyword"></parameter></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link -linkend="method-gtkentry--get-has-frame">get_has_frame</link></methodname> - <methodparam></methodparam> + <methodname><link linkend="method-gtkentry--set-has-frame">set_has_frame</link></methodname> + <methodparam><parameter role="keyword">setting</parameter></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link -linkend="method-gtkentry--set-max-length">set_max_length</link></methodname> - <methodparam><parameter role="keyword">max</parameter></methodparam> + <methodname><link linkend="method-gtkentry--get-has-frame">get_has_frame</link></methodname> + <methodparam></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link -linkend="method-gtkentry--get-max-length">get_max_length</link></methodname> - <methodparam></methodparam> + <methodname><link linkend="method-gtkentry--set-max-length">set_max_length</link></methodname> + <methodparam><parameter role="keyword">max</parameter></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link -linkend="method-gtkentry--set-activates-default">set_activates_default</link></methodname> - <methodparam><parameter - role="keyword">setting</parameter></methodparam> + <methodname><link linkend="method-gtkentry--get-max-length">get_max_length</link></methodname> + <methodparam></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link -linkend="method-gtkentry--get-activates-default">get_activates_default</link></methodname> - <methodparam></methodparam> + <methodname><link linkend="method-gtkentry--set-activates-default">set_activates_default</link></methodname> + <methodparam><parameter role="keyword">setting</parameter></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link -linkend="method-gtkentry--set-width-chars">set_width_chars</link></methodname> - <methodparam><parameter - role="keyword">n_chars</parameter></methodparam> + <methodname><link linkend="method-gtkentry--get-activates-default">get_activates_default</link></methodname> + <methodparam></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link -linkend="method-gtkentry--get-width-chars">get_width_chars</link></methodname> - <methodparam></methodparam> + <methodname><link linkend="method-gtkentry--set-width-chars">set_width_chars</link></methodname> + <methodparam><parameter role="keyword">n_chars</parameter></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link -linkend="method-gtkentry--set-text">set_text</link></methodname> - <methodparam><parameter - role="keyword">text</parameter></methodparam> + <methodname><link linkend="method-gtkentry--get-width-chars">get_width_chars</link></methodname> + <methodparam></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link -linkend="method-gtkentry--get-text">get_text</link></methodname> - <methodparam></methodparam> + <methodname><link linkend="method-gtkentry--set-text">set_text</link></methodname> + <methodparam><parameter role="keyword">text</parameter></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link -linkend="method-gtkentry--get-layout">get_layout</link></methodname> - <methodparam></methodparam> + <methodname><link linkend="method-gtkentry--get-text">get_text</link></methodname> + <methodparam></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link -linkend="method-gtkentry--get-layout-offsets">get_layout_offsets</link></methodname> - <methodparam></methodparam> + <methodname><link linkend="method-gtkentry--get-text-length">get_text_length</link></methodname> + <methodparam></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link -linkend="method-gtkentry--set-alignment">set_alignment</link></methodname> - <methodparam><parameter - role="keyword">xalign</parameter></methodparam> + <methodname><link linkend="method-gtkentry--get-layout">get_layout</link></methodname> + <methodparam></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link -linkend="method-gtkentry--get-alignment">get_alignment</link></methodname> - <methodparam></methodparam> + <methodname><link linkend="method-gtkentry--get-layout-offsets">get_layout_offsets</link></methodname> + <methodparam></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link -linkend="method-gtkentry--set-completion">set_completion</link></methodname> - <methodparam><parameter - role="keyword">width_chars</parameter></methodparam> + <methodname><link linkend="method-gtkentry--set-alignment">set_alignment</link></methodname> + <methodparam><parameter role="keyword">xalign</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkentry--get-alignment">get_alignment</link></methodname> + <methodparam></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkentry--set-completion">set_completion</link></methodname> + <methodparam><parameter role="keyword">width_chars</parameter></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link -linkend="method-gtkentry--get-completion">get_completion</link></methodname> - <methodparam></methodparam> + <methodname><link linkend="method-gtkentry--get-completion">get_completion</link></methodname> + <methodparam></methodparam> </methodsynopsis> <methodsynopsis language="python"> <methodname><link linkend="method-gtkentry--set-inner-border">set_inner_border</link></methodname> @@ -141,25 +117,164 @@ linkend="method-gtkentry--get-completion">get_completion</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> <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> + <methodname><link linkend="method-gtkentry--set-overwrite-mode">set_overwrite_mode</link></methodname> + <methodparam><parameter role="keyword">overwrite</parameter></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link linkend="method-gtkentry--get-override-mode">get_override_mode</link></methodname> - <methodparam></methodparam> + <methodname><link linkend="method-gtkentry--get-overwrite-mode">get_overwrite_mode</link></methodname> + <methodparam><parameter role="keyword"></parameter></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> + <methodname><link linkend="method-gtkentry--set-buffer">set_buffer</link></methodname> + <methodparam><parameter role="keyword">buffer</parameter></methodparam> </methodsynopsis> <methodsynopsis language="python"> - <methodname><link linkend="method-gtkentry--get-text-length">get_text_length</link></methodname> - <methodparam></methodparam> - </methodsynopsis> + <methodname><link linkend="method-gtkentry--get-buffer">get_buffer</link></methodname> + <methodparam><parameter role="keyword"></parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkentry--set-progress-fraction">set_progress_fraction</link></methodname> + <methodparam><parameter role="keyword">fraction</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkentry--get-progress-fraction">get_progress_fraction</link></methodname> + <methodparam><parameter role="keyword"></parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkentry--set-progress-pulse-step">set_progress_pulse_step</link></methodname> + <methodparam><parameter role="keyword">fraction</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkentry--get-progress-pulse-step">get_progress_pulse_step</link></methodname> + <methodparam><parameter role="keyword"></parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkentry--progress-pulse">progress_pulse</link></methodname> + <methodparam><parameter role="keyword"></parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkentry--set-icon-from-pixbuf">set_icon_from_pixbuf</link></methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + <methodparam><parameter role="keyword">pixbuf</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkentry--set-icon-from-stock">set_icon_from_stock</link></methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + <methodparam><parameter role="keyword">stock_id</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkentry--set-icon-from-icon-name">set_icon_from_icon_name</link></methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + <methodparam><parameter role="keyword">icon_name</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkentry--set-icon-from-gicon">set_icon_from_gicon</link></methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + <methodparam><parameter role="keyword">icon</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkentry--get-icon-storage-type">get_icon_storage_type</link></methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkentry--get-icon-pixbuf">get_icon_pixbuf</link></methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkentry--get-icon-stock">get_icon_stock</link></methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkentry--get-icon-name">get_icon_name</link></methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkentry--get-icon-gicon">get_icon_gicon</link></methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkentry--set-icon-activatable">set_icon_activatable</link></methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + <methodparam><parameter role="keyword">activatable</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkentry--get-icon-activatable">get_icon_activatable</link></methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkentry--set-icon-sensitive">set_icon_sensitive</link></methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + <methodparam><parameter role="keyword">sensitive</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkentry--get-icon-sensitive">get_icon_sensitive</link></methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkentry--get-icon-at-pos">get_icon_at_pos</link></methodname> + <methodparam><parameter role="keyword">x</parameter></methodparam> + <methodparam><parameter role="keyword">y</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkentry--set-icon-tooltip-text">set_icon_tooltip_text</link></methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + <methodparam><parameter role="keyword">tooltip</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkentry--get-icon-tooltip-text">get_icon_tooltip_text</link></methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkentry--set-icon-tooltip-markup">set_icon_tooltip_markup</link></methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + <methodparam><parameter role="keyword">tooltip</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkentry--get-icon-tooltip-markup">get_icon_tooltip_markup</link></methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkentry--set-icon-drag-source">set_icon_drag_source</link></methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + <methodparam><parameter role="keyword">target_list</parameter></methodparam> + <methodparam><parameter role="keyword">actions</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkentry--get-current-icon-drag-source">get_current_icon_drag_source</link></methodname> + <methodparam><parameter role="keyword"></parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkentry--get-icon-window">get_icon_window</link></methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkentry--get-text-window">get_text_window</link></methodname> + <methodparam><parameter role="keyword"></parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkentry--layout-index-to-text-index">layout_index_to_text_index</link></methodname> + <methodparam><parameter role="keyword">layout_index</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkentry--text-index-to-layout-index">text_index_to_layout_index</link></methodname> + <methodparam><parameter role="keyword">text_index</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkentry--im-context-filter-keypress">im_context_filter_keypress</link></methodname> + <methodparam><parameter role="keyword">event</parameter></methodparam> + </methodsynopsis> + <methodsynopsis language="python"> + <methodname><link linkend="method-gtkentry--reset-im-context">reset_im_context</link></methodname> + <methodparam><parameter role="keyword"></parameter></methodparam> + </methodsynopsis> </classsynopsis> </refsect1> @@ -177,7 +292,7 @@ linkend="method-gtkentry--get-completion">get_completion</link></methodname> <title>Implemented Interfaces</title> <para> <link linkend="class-gtkentry"><classname>gtk.Entry</classname></link> - implements + implements <link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link> <link linkend="class-atkimplementor"><classname>atk.ImplementorIFace</classname></link> <link linkend="class-gtkeditable"><classname>gtk.Editable</classname></link> @@ -211,6 +326,12 @@ linkend="method-gtkentry--get-completion">get_completion</link></methodname> </row> <row valign="top"> + <entry>"buffer"</entry> + <entry>Read/Write/Construct</entry> + <entry><link linkend="class-gtkentrybuffer"><classname>gtk.EntryBuffer</classname></link> object which actually stores entry text.</entry> + </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. @@ -286,7 +407,7 @@ linkend="method-gtkentry--get-completion">get_completion</link></methodname> </row> <row valign="top"> - <entry>"override-mode"</entry> + <entry>"overwrite-mode"</entry> <entry>Read/Write</entry> <entry>If text is overwritten when typing in the GtkEntry. Default value: <literal>False</literal>. @@ -611,11 +732,29 @@ linkend="method-gtkentry--get-completion">get_completion</link></methodname> <row valign="top"> <entry>"inner-border"</entry> <entry>Read</entry> - <entry>Sets the text area's border between the text and the frame + <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>"invisible-char"</entry> + <entry>Read</entry> + <entry>The invisible character is used when masking entry contents (in "password mode"). When + it is not explicitly set with the "invisible-char" property, GTK+ determines the character to + use from a list of possible candidates, depending on availability in the current font. + This property is available in GTK+ 2.18 and above.</entry> + </row> + + <row valign="top"> + <entry>"progress-border"</entry> + <entry>Read</entry> + <entry>The invisible character is used when masking entry contents (in "password mode"). When + it is not explicitly set with the "invisible-char" property, GTK+ determines the character to + use from a list of possible candidates, depending on availability in the current font. + This property is available in GTK+ 2.16 and above.</entry> + </row> + + <row valign="top"> <entry>"state-hint"</entry> <entry>Read</entry> <entry> @@ -826,6 +965,23 @@ linkend="signal-gtkentry--populate-popup">populate-popup</link>"</term> </varlistentry> <varlistentry> <term>"<link +linkend="signal-gtkentry--preedit-changed">preedit-changed</link>"</term> + <listitem> + <methodsynopsis + language="python"><methodname>callback</methodname> + <methodparam><parameter>entry</parameter> + </methodparam> + <methodparam><parameter>preedit</parameter> + </methodparam> + <methodparam><parameter>user_param1</parameter> + </methodparam> + <methodparam><parameter>...</parameter> + </methodparam> + </methodsynopsis> + </listitem> + </varlistentry> + <varlistentry> + <term>"<link linkend="signal-gtkentry--toggle-overwrite">toggle-overwrite</link>"</term> <listitem> <methodsynopsis @@ -846,12 +1002,36 @@ linkend="signal-gtkentry--toggle-overwrite">toggle-overwrite</link>"</term> <refsect1> <title>Description</title> - <para>The <link - linkend="class-gtkentry"><classname>gtk.Entry</classname></link> widget - is a single line text entry widget. A fairly large set of key bindings - are supported by default. If the entered text is longer than the - allocation of the widget, the widget will scroll so that the cursor - position is visible.</para> + <para>The <link linkend="class-gtkentry"><classname>gtk.Entry</classname></link> widget is a single line text + entry widget. A fairly large set of key bindings are supported by default. If the entered text is longer than the + allocation of the widget, the widget will scroll so that the cursor position is visible.</para> + + <para>When using an entry for passwords and other sensitive information, it can be put into "password mode" using + <link linkend="method-gtkentry--set-visibility"><methodname>gtk.Entry.set_visibility</methodname></link>(). In this mode, + entered text is displayed using a 'invisible' character. By default, GTK+ picks the best invisible character that is + available in the current font, but it can be changed with + <link linkend="method-gtkentry--set-invisible-char"><methodname>gtk.Entry.set_invisible_char</methodname></link>(). + Since 2.16, GTK+ displays a warning when Caps Lock or input methods might interfere with entering text in a password entry. + The warning can be turned off with the "caps-lock-warning" property.</para> + + <para>Since 2.16, <link linkend="class-gtkentry"><classname>gtk.Entry</classname></link> has the ability to display + progress or activity information behind the text. To make an entry display such information, use + <link linkend="method-gtkentry--set-progress-fraction"><methodname>gtk.Entry.set_progress_fraction</methodname></link>() or + <link linkend="method-gtkentry--set-progress-pulse-step"><methodname>gtk.Entry.set_progress_pulse_step</methodname></link>().</para> + + <para>Additionally, <link linkend="class-gtkentry"><classname>gtk.Entry</classname></link> can show icons at either side of + the entry. These icons can be activatable by clicking, can be set up as drag source and can have tooltips. To add an icon, use + <link linkend="method-gtkentry--set-icon-from-gicon"><methodname>gtk.Entry.set_icon_from_gicon</methodname></link>() or one of + the various other functions that set an icon from a stock id, an icon name or a pixbuf. To trigger an action when the user + clicks an icon, connect to the "icon-press" signal. To allow DND operations from an icon, use + <link linkend="method-gtkentry--set-icon-drag-source"><methodname>gtk.Entry.set_icon_drag_source</methodname></link>(). + To set a tooltip on an icon, use + <link linkend="method-gtkentry--set-icon-tooltip-text"><methodname>gtk.Entry.set_icon_tooltip_text</methodname></link>() + or the corresponding function for markup.</para> + + <para>Note that functionality or information that is only available by clicking on an icon in an entry may not be accessible + at all to users which are not able to use a mouse or other pointing device. It is therefore recommended that any such functionality + should also be available by other means, e.g. via the context menu of the entry.</para> </refsect1> @@ -987,6 +1167,24 @@ does not show invisible text at all.</simpara></listitem> </refsect2> + <refsect2 id="method-gtkentry--unset-invisible-char"> + <title>gtk.Entry.unset_invisible_char</title> + + <programlisting><methodsynopsis language="python"> + <methodname>unset_invisible_char</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para>The <methodname>unset_invisible_char</methodname>() method unsets the invisible char previously set with + <link linkend="method-gtkentry--set-invisible-char"><methodname>set_invisible_char</methodname>()</link> + so that the default invisible char is used again.</para> + + </refsect2> + <refsect2 id="method-gtkentry--set-has-frame"> <title>gtk.Entry.set_has_frame</title> @@ -1228,6 +1426,31 @@ string</simpara></listitem> </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> + <refsect2 id="method-gtkentry--get-layout"> <title>gtk.Entry.get_layout</title> @@ -1398,12 +1621,12 @@ pango layout</simpara></listitem> <refsect2 id="method-gtkentry--set-inner-border"> <title>gtk.Entry.set_inner_border</title> - + <programlisting><methodsynopsis language="python"> <methodname>set_inner_border</methodname> <methodparam><parameter role="keyword">border</parameter></methodparam> </methodsynopsis></programlisting> - + <variablelist> <varlistentry> <term><parameter role="keyword">border</parameter> :</term> @@ -1412,32 +1635,32 @@ pango layout</simpara></listitem> or <literal>None</literal></simpara></listitem> </varlistentry> </variablelist> - + <note> <para>This method is available in PyGTK 2.10 and above.</para> </note> - + <para>The <methodname>set_inner_border</methodname>() method sets the entry's "inner-border" property to the value specified by <parameter>border</parameter>, or clears it if <literal>None</literal> is passed. The "inner-border" is the area around the entry's text, but inside its frame.</para> - + <para>If set, this property overrides the inner-border style property. Overriding the style-provided border is useful when you want to do in-place editing of some text in a canvas or list widget, where pixel-exact positioning of the entry is important.</para> - + </refsect2> - + <refsect2 id="method-gtkentry--get-inner-border"> <title>gtk.Entry.get_inner_border</title> - + <programlisting><methodsynopsis language="python"> <methodname>get_inner_border</methodname> <methodparam></methodparam> </methodsynopsis></programlisting> - + <variablelist> <varlistentry> <term><emphasis>Returns</emphasis> :</term> @@ -1446,26 +1669,26 @@ pango layout</simpara></listitem> or <literal>None</literal> if none was set.</simpara></listitem> </varlistentry> </variablelist> - + <note> <para>This method is available in PyGTK 2.10 and above.</para> </note> - + <para>The <methodname>get_inner_border</methodname>() method returns the value of the entry's "inner-border" property. See <link linkend="method-gtkentry--set-inner-border"><methodname>set_inner_border</methodname>()</link> for more information.</para> - + </refsect2> <refsect2 id="method-gtkentry--set-cursor-hadjustment"> <title>gtk.Entry.set_cursor_hadjustment</title> - + <programlisting><methodsynopsis language="python"> <methodname>set_cursor_hadjustment</methodname> <methodparam><parameter role="keyword">adjustment</parameter></methodparam> </methodsynopsis></programlisting> - + <variablelist> <varlistentry> <term><parameter role="keyword">adjustment</parameter> :</term> @@ -1473,11 +1696,11 @@ pango layout</simpara></listitem> the cursor is moved, or <literal>None</literal>.</simpara></listitem> </varlistentry> </variablelist> - + <note> <para>This method is available in PyGTK 2.12 and above.</para> </note> - + <para> The <methodname>set_cursor_hadjustment</methodname>() method hooks up an adjustment to the cursor position in an entry, so that when the cursor is moved, the adjustment @@ -1486,17 +1709,17 @@ pango layout</simpara></listitem> for a typical way of obtaining the adjustment. The adjustment has to be in pixel units and in the same coordinate system as the entry. </para> - + </refsect2> - + <refsect2 id="method-gtkentry--get-cursor-hadjustment"> <title>gtk.Entry.get_cursor_hadjustment</title> - + <programlisting><methodsynopsis language="python"> <methodname>get_cursor_hadjustment</methodname> <methodparam></methodparam> </methodsynopsis></programlisting> - + <variablelist> <varlistentry> <term><emphasis>Returns</emphasis> :</term> @@ -1504,96 +1727,974 @@ pango layout</simpara></listitem> <literal>None</literal> if none has been set.</simpara></listitem> </varlistentry> </variablelist> - + <note> <para>This method is available in PyGTK 2.12 and above.</para> </note> - + <para> The <methodname>get_cursor_hadjustment</methodname>() method retrieves the horizontal cursor adjustment for the entry. See <link linkend="method-gtkentry--set-cursor-hadjustment">set_cursor_hadjustment</link>. </para> - + </refsect2> - <refsect2 id="method-gtkentry--set-override-mode"> - <title>gtk.Entry.set_override_mode</title> - + <refsect2 id="method-gtkentry--set-overwrite-mode"> + <title>gtk.Entry.set_overwrite_mode</title> + <programlisting><methodsynopsis language="python"> - <methodname>set_override_mode</methodname> - <methodparam><parameter role="keyword">override</parameter></methodparam> + <methodname>set_overwrite_mode</methodname> + <methodparam><parameter role="keyword">overwrite</parameter></methodparam> </methodsynopsis></programlisting> - <variablelist> <varlistentry> - <term><parameter role="keyword">override</parameter> :</term> + <term><parameter role="keyword">overwrite</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> - + + <para>The <methodname>set_overwrite_mode</methodname>() method sets whether the text + is overwritten when typing in the Entry.</para> + </refsect2> - - <refsect2 id="method-gtkentry--get-override-mode"> - <title>gtk.Entry.get_override_mode</title> - + + <refsect2 id="method-gtkentry--get-overwrite-mode"> + <title>gtk.Entry.get_overwrite_mode</title> + <programlisting><methodsynopsis language="python"> - <methodname>get_override_mode</methodname> + <methodname>get_overwrite_mode</methodname> <methodparam></methodparam> </methodsynopsis></programlisting> - <variablelist> <varlistentry> <term><emphasis>Returns</emphasis> :</term> - <listitem><simpara>whether the text is overwritten when typing.</simpara></listitem> + <listitem><simpara>whether text is overwritten when typing in the Entry.</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> - + + <para>The <methodname>get_overwrite_mode</methodname>() method gets the value set by + <methodname><link linkend="method-gtkentry--set-overwrite-mode">gtk.Entry.set_overwrite_mode</link></methodname>().</para> + </refsect2> - - <refsect2 id="method-gtkentry--get-text-length"> - <title>gtk.Entry.get_text_length</title> - + + <refsect2 id="method-gtkentry--set-buffer"> + <title>gtk.Entry.set_buffer</title> + <programlisting><methodsynopsis language="python"> - <methodname>get_text_length</methodname> + <methodname>set_buffer</methodname> + <methodparam><parameter role="keyword">buffer</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">buffer</parameter> :</term> + <listitem><simpara>a <classname><link linkend="class-gtkentrybuffer">gtk.EntryBuffer</link></classname>.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.22 and above.</para> + </note> + + <para>The <methodname>set_buffer</methodname>() method sets the + <classname><link linkend="class-gtkentrybuffer">gtk.EntryBuffer</link></classname> + object which holds the text for this widget.</para> + + </refsect2> + + <refsect2 id="method-gtkentry--get-buffer"> + <title>gtk.Entry.get_buffer</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_buffer</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> + <listitem><simpara>a <classname><link linkend="class-gtkentrybuffer">gtk.EntryBuffer</link></classname> object.</simpara></listitem> </varlistentry> </variablelist> - + <note> - <para>This method is available in PyGTK 2.14 and above.</para> + <para>This method is available in PyGTK 2.22 and above.</para> + </note> + + <para>The <methodname>get_buffer</methodname>() method gets the + <classname><link linkend="class-gtkentrybuffer">gtk.EntryBuffer</link></classname> + which holds the text for this widget.</para> + + </refsect2> + + <refsect2 id="method-gtkentry--set-progress-fraction"> + <title>gtk.Entry.set_progress_fraction</title> + + <programlisting><methodsynopsis language="python"> + <methodname>set_progress_fraction</methodname> + <methodparam><parameter role="keyword">fraction</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">fraction</parameter> :</term> + <listitem><simpara>fraction of the task that's been completed.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para>The <methodname>set_progress_fraction</methodname>() method causes the entry's progress + indicator to "fill in" the given fraction of the bar. The fraction should be between 0.0 and 1.0, inclusive.</para> + + </refsect2> + + <refsect2 id="method-gtkentry--get-progress-fraction"> + <title>gtk.Entry.get_progress_fraction</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_progress_fraction</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>a fraction from 0.0 to 1.0.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para>The <methodname>get_progress_fraction</methodname>() method returns the current fraction of the task that's been + completed. See <methodname><link linkend="method-gtkentry--set-progress-fraction">gtk.Entry.set_progress_fraction</link></methodname>().</para> + + </refsect2> + + <refsect2 id="method-gtkentry--set-progress-pulse-step"> + <title>gtk.Entry.set_progress_pulse_step</title> + + <programlisting><methodsynopsis language="python"> + <methodname>set_progress_pulse_step</methodname> + <methodparam><parameter role="keyword">fraction</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">fraction</parameter> :</term> + <listitem><simpara>fraction between 0.0 and 1.0.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para>The <methodname>set_progress_pulse_step</methodname>() method sets the fraction of + total entry width to move the progress bouncing block for each call to + <methodname><link linkend="method-gtkentry--set-progress-pulse">gtk.Entry.progress_pulse</link></methodname>().</para> + + </refsect2> + + <refsect2 id="method-gtkentry--get-progress-pulse-step"> + <title>gtk.Entry.get_progress_pulse_step</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_progress_pulse_step</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>a fraction from 0.0 to 1.0.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para>The <methodname>get_progress_pulse_step</methodname>() method retrieves the pulse step set with + <methodname><link linkend="method-gtkentry--set-progress-pulse-step">gtk.Entry.set_progress_pulse_step</link></methodname>().</para> + + </refsect2> + + <refsect2 id="method-gtkentry--progress-pulse"> + <title>gtk.Entry.progress_pulse</title> + + <programlisting><methodsynopsis language="python"> + <methodname>progress_pulse</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para>The <methodname>progress_pulse</methodname>() method indicates that some progress is made, but you don't know how + much. Causes the entry's progress indicator to enter "activity mode," where a block bounces back and forth. Each call to + <methodname><link linkend="method-gtkentry--progress-pulse">gtk.Entry.progress_pulse</link></methodname>() + causes the block to move by a little bit (the amount of movement per pulse is determined by + <methodname><link linkend="method-gtkentry--set-progress-pulse-step">gtk.Entry.set_progress_pulse_step</link></methodname>()).</para> + + </refsect2> + + <refsect2 id="method-gtkentry--set-icon-from-pixbuf"> + <title>gtk.Entry.set_icon_from_pixbuf</title> + + <programlisting><methodsynopsis language="python"> + <methodname>set_icon_from_pixbuf</methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + <methodparam><parameter role="keyword">pixbuf</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">icon_pos</parameter> :</term> + <listitem><simpara>The position at which to set the icon.</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter role="keyword">pixbuf</parameter> :</term> + <listitem><simpara>A <link linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>, or <literal>None</literal>.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para>The <methodname>set_icon_from_pixbuf</methodname>() method sets + the icon shown in the specified position using a pixbuf.</para> + + <para>If <parameter>pixbuf</parameter> is <literal>None</literal>, no + icon will be shown in the specified position.</para> + + </refsect2> + + <refsect2 id="method-gtkentry--set-icon-from-stock"> + <title>gtk.Entry.set_icon_from_stock</title> + + <programlisting><methodsynopsis language="python"> + <methodname>set_icon_from_stock</methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + <methodparam><parameter role="keyword">stock_id</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">icon_pos</parameter> :</term> + <listitem><simpara>The position at which to set the icon.</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter role="keyword">stock_id</parameter> :</term> + <listitem><simpara>The name of the stock item, or <literal>None</literal>.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para>The <methodname>set_icon_from_stock</methodname>() method sets + the icon shown in the entry at the specified position from a stock image.</para> + + <para>If <parameter>stock_id</parameter> is <literal>None</literal>, no + icon will be shown in the specified position.</para> + + </refsect2> + + <refsect2 id="method-gtkentry--set-icon-from-icon-name"> + <title>gtk.Entry.set_icon_from_icon_name</title> + + <programlisting><methodsynopsis language="python"> + <methodname>set_icon_from_icon_name</methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + <methodparam><parameter role="keyword">icon_name</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">icon_pos</parameter> :</term> + <listitem><simpara>The position at which to set the icon.</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter role="keyword">icon_name</parameter> :</term> + <listitem><simpara>An icon name, or <literal>None</literal>.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para>The <methodname>set_icon_from_icon_name</methodname>() method sets + the icon shown in the entry at the specified position from the current icon theme.</para> + + <para>If <parameter>icon_name</parameter> is <literal>None</literal>, no + icon will be shown in the specified position.</para> + + </refsect2> + + <refsect2 id="method-gtkentry--set-icon-from-gicon"> + <title>gtk.Entry.set_icon_from_gicon</title> + + <programlisting><methodsynopsis language="python"> + <methodname>set_icon_from_gicon</methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + <methodparam><parameter role="keyword">icon</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">icon_pos</parameter> :</term> + <listitem><simpara>The position at which to set the icon.</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter role="keyword">icon</parameter> :</term> + <listitem><simpara>The icon to set, or <literal>None</literal>.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para>The <methodname>set_icon_from_gicon</methodname>() method sets the icon shown in + the entry at the specified position from the current icon theme. If the icon isn't known, + a "broken image" icon will be displayed instead.</para> + + <para>If <parameter>icon</parameter> is <literal>None</literal>, no + icon will be shown in the specified position.</para> + + </refsect2> + + <refsect2 id="method-gtkentry--get-icon-storage-type"> + <title>gtk.Entry.get_icon_storage_type</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_icon_storage_type</methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">icon_pos</parameter> :</term> + <listitem><simpara>Icon position.</simpara></listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>the image representation being used.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para>The <methodname>get_icon_storage_type</methodname>() method gets the type of + representation being used by the icon to store image data. If the icon has no image + data, the return value will be <literal>gtk.IMAGE_EMPTY</literal>.</para> + + </refsect2> + + <refsect2 id="method-gtkentry--get-icon-pixbuf"> + <title>gtk.Entry.get_icon_pixbuf</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_icon_pixbuf</methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">icon_pos</parameter> :</term> + <listitem><simpara>Icon position.</simpara></listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>A <link linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>, or <literal>None</literal> if no icon is set for this position.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para>The <methodname>get_icon_pixbuf</methodname>() method retrieves the image used for the icon.</para> + + <para>Unlike the other methods of setting and getting icon data, this method will work regardless of whether the icon was set using + a <link linkend="class-gdkpixbuf"><classname>gtk.gdk.Pixbuf</classname></link>, + a <link linkend="class-gioicon"><classname>gio.Icon</classname></link>, a stock item, or an icon name.</para> + + </refsect2> + + <refsect2 id="method-gtkentry--get-icon-stock"> + <title>gtk.Entry.get_icon_stock</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_icon_stock</methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">icon_pos</parameter> :</term> + <listitem><simpara>Icon position.</simpara></listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>A stock id, or <literal>None</literal> if no icon is set or if the icon wasn't set from a stock id.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para>The <methodname>get_icon_stock</methodname>() method retrieves the stock id used for the icon, + or <literal>None</literal> if there is no icon or if the icon was set by some other method + (e.g. by pixbuf, icon name or gicon).</para> + + </refsect2> + + <refsect2 id="method-gtkentry--get-icon-name"> + <title>gtk.Entry.get_icon_name</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_icon_name</methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">icon_pos</parameter> :</term> + <listitem><simpara>Icon position.</simpara></listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>An icon name, or <literal>None</literal> if no icon is set or if the icon wasn't set from an icon name.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para>The <methodname>get_icon_name</methodname>() method retrieves the icon name used for the icon, + or <literal>None</literal> if there is no icon or if the icon was set by some other method + (e.g. by pixbuf, stock or gicon). </para> + + </refsect2> + + <refsect2 id="method-gtkentry--get-icon-gicon"> + <title>gtk.Entry.get_icon_gicon</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_icon_gicon</methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">icon_pos</parameter> :</term> + <listitem><simpara>Icon position.</simpara></listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>A <link linkend="class-gioicon"><classname>gio.Icon</classname></link>, + or <literal>None</literal> if no icon is set or if the icon is not a + <link linkend="class-gioicon"><classname>gio.Icon</classname></link>.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para>The <methodname>get_icon_gicon</methodname>() method retrieves the + <link linkend="class-gioicon"><classname>gio.Icon</classname></link> used for the icon, + or <literal>None</literal> if there is no icon or if the icon was set by some other + method (e.g. by stock, pixbuf, or icon name).</para> + + </refsect2> + + <refsect2 id="method-gtkentry--set-icon-activatable"> + <title>gtk.Entry.set_icon_activatable</title> + + <programlisting><methodsynopsis language="python"> + <methodname>set_icon_activatable</methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + <methodparam><parameter role="keyword">activatable</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">icon_pos</parameter> :</term> + <listitem><simpara>Icon position.</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter role="keyword">activatable</parameter> :</term> + <listitem><simpara><literal>True</literal> if the icon should be activatable.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para>The <methodname>set_icon_activatable</methodname>() method sets whether the icon is activatable.</para> + + </refsect2> + + <refsect2 id="method-gtkentry--get-icon-activatable"> + <title>gtk.Entry.get_icon_activatable</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_icon_activatable</methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">icon_pos</parameter> :</term> + <listitem><simpara>Icon position.</simpara></listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara><literal>True</literal> if the icon is activatable, <literal>False</literal> otherwise.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> </note> - + + <para>The <methodname>get_icon_activatable</methodname>() method returns whether the icon is activatable.</para> + + </refsect2> + + <refsect2 id="method-gtkentry--set-icon-sensitive"> + <title>gtk.Entry.set_icon_sensitive</title> + + <programlisting><methodsynopsis language="python"> + <methodname>set_icon_sensitive</methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + <methodparam><parameter role="keyword">sensitive</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">icon_pos</parameter> :</term> + <listitem><simpara>Icon position.</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter role="keyword">sensitive</parameter> :</term> + <listitem><simpara><literal>True</literal> if the icon should appear sensitive, <literal>False</literal> if the icon should appear insensitive.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para>The <methodname>set_icon_sensitive</methodname>() method sets the sensitivity for the specified icon.</para> + + </refsect2> + + <refsect2 id="method-gtkentry--get-icon-sensitive"> + <title>gtk.Entry.get_icon_sensitive</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_icon_sensitive</methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">icon_pos</parameter> :</term> + <listitem><simpara>Icon position.</simpara></listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara><literal>True</literal> if the icon appears sensitive, <literal>False</literal> if the icon appears insensitive.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para>The <methodname>get_icon_sensitive</methodname>() method returns whether the icon appears sensitive or insensitive. .</para> + + </refsect2> + + <refsect2 id="method-gtkentry--get-icon-at-pos"> + <title>gtk.Entry.get_icon_at_pos</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_icon_at_pos</methodname> + <methodparam><parameter role="keyword">x</parameter></methodparam> + <methodparam><parameter role="keyword">y</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">x</parameter> :</term> + <listitem><simpara>the x coordinate of the position to find.</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter role="keyword">y</parameter> :</term> + <listitem><simpara>the y coordinate of the position to find.</simpara></listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>the index of the icon at the given position, or -1.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para>The <methodname>get_icon_at_pos</methodname>() method finds the icon at the given + position and return its index. If x, y doesn't lie inside an icon, -1 is returned. This + function is intended for use in a "query-tooltip" signal handler.</para> + + </refsect2> + + <refsect2 id="method-gtkentry--set-icon-tooltip-text"> + <title>gtk.Entry.set_icon_tooltip_text</title> + + <programlisting><methodsynopsis language="python"> + <methodname>set_icon_tooltip_text</methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + <methodparam><parameter role="keyword">tooltip</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">icon_pos</parameter> :</term> + <listitem><simpara>the icon position.</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter role="keyword">tooltip</parameter> :</term> + <listitem><simpara>the contents of the tooltip for the icon, or <literal>None</literal>.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para>The <methodname>set_icon_tooltip_text</methodname>() method sets + <parameter>tooltip</parameter> as the contents of the tooltip for the + icon at the specified position.</para> + + </refsect2> + + <refsect2 id="method-gtkentry--get-icon-tooltip-text"> + <title>gtk.Entry.get_icon_tooltip_text</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_icon_tooltip_text</methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">icon_pos</parameter> :</term> + <listitem><simpara>the icon position.</simpara></listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>the tooltip text, or <literal>None</literal>.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para>The <methodname>get_icon_tooltip_text</methodname>() method gets the contents of the tooltip on the icon at the specified position in the entry.</para> + + </refsect2> + + <refsect2 id="method-gtkentry--set-icon-tooltip-markup"> + <title>gtk.Entry.set_icon_tooltip_markup</title> + + <programlisting><methodsynopsis language="python"> + <methodname>set_icon_tooltip_markup</methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + <methodparam><parameter role="keyword">tooltip</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">icon_pos</parameter> :</term> + <listitem><simpara>the icon position.</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter role="keyword">tooltip</parameter> :</term> + <listitem><simpara>the contents of the tooltip for the icon, or <literal>None</literal>.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para>The <methodname>set_icon_tooltip_markup</methodname>() method sets tooltip as the contents of the tooltip for the icon at the specified position. + <parameter>tooltip</parameter> is assumed to be marked up with the Pango text markup language.</para> + + </refsect2> + + <refsect2 id="method-gtkentry--get-icon-tooltip-markup"> + <title>gtk.Entry.get_icon_tooltip_markup</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_icon_tooltip_markup</methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">icon_pos</parameter> :</term> + <listitem><simpara>the icon position.</simpara></listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>the tooltip text, or <literal>None</literal>.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para>The <methodname>get_icon_tooltip_markup</methodname>() method gets the contents of the tooltip on the icon at the specified position in the entry.</para> + + </refsect2> + + <refsect2 id="method-gtkentry--set-icon-drag-source"> + <title>gtk.Entry.set_icon_drag_source</title> + + <programlisting><methodsynopsis language="python"> + <methodname>set_icon_drag_source</methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + <methodparam><parameter role="keyword">target_list</parameter></methodparam> + <methodparam><parameter role="keyword">actions</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">icon_pos</parameter> :</term> + <listitem><simpara>icon position.</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter role="keyword">target_list</parameter> :</term> + <listitem><simpara>the targets (data formats) in which the data can be provided.</simpara></listitem> + </varlistentry> + <varlistentry> + <term><parameter role="keyword">actions</parameter> :</term> + <listitem><simpara>a bitmask of the allowed drag actions.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para>The <methodname>set_icon_drag_source</methodname>() method sets up the icon at the given position + so that GTK+ will start a drag operation when the user clicks and drags the icon.</para> + + <para>To handle the drag operation, you need to connect to the usual "drag-data-get" (or possibly "drag-data-delete") signal, and use + <methodname><link linkend="method-gtkentry--get-current-icon-drag-source">gtk.Entry.get_current_icon_drag_source</link></methodname>()) + in your signal handler to find out if the drag was started from an icon.</para> + + <para>By default, GTK+ uses the icon as the drag icon. You can use the "drag-begin" signal to set a different icon. Note that you have to use + <link linkend="method-gobject--connect-after"><methodname>gobject.connect_after</methodname>()</link> + to ensure that your signal handler gets executed after the default handler.</para> + </refsect2> + + <refsect2 id="method-gtkentry--get-current-icon-drag-source"> + <title>gtk.Entry.get_current_icon_drag_source</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_current_icon_drag_source</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>the index of the icon which is the source of the current DND operation, or -1.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.16 and above.</para> + </note> + + <para>The <methodname>get_current_icon_drag_source</methodname>() method returns the index + of the icon which is the source of the current DND operation, or -1.</para> + + <para>This function is meant to be used in a "drag-data-get" callback.</para> + + </refsect2> + + <refsect2 id="method-gtkentry--get-icon-window"> + <title>gtk.Entry.get_icon_window</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_icon_window</methodname> + <methodparam><parameter role="keyword">icon_pos</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">icon_pos</parameter> :</term> + <listitem><simpara>Icon position.</simpara></listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>the entry's icon window at <parameter>icon_pos</parameter>.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.22 and above.</para> + </note> + + <para>The <methodname>get_icon_window</methodname>() method returns the + <link linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> + which contains the entry's icon at <parameter>icon_pos</parameter>. This + function is useful when drawing something to the entry in an "expose-event" + callback because it enables the callback to distinguish between the text + window and entry's icon windows.</para> + + </refsect2> + + <refsect2 id="method-gtkentry--get-text-window"> + <title>gtk.Entry.get_text_window</title> + + <programlisting><methodsynopsis language="python"> + <methodname>get_text_window</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>the entry's text window.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.22 and above.</para> + </note> + + <para>The <methodname>get_text_window</methodname>() method returns the + <link linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link> + which contains the text. This function is useful when drawing something to the + entry in an "expose-event" callback because it enables the callback to distinguish + between the text window and entry's icon windows.</para> + + </refsect2> + + <refsect2 id="method-gtkentry--layout-index-to-text-index"> + <title>gtk.Entry.layout_index_to_text_index</title> + + <programlisting><methodsynopsis language="python"> + <methodname>layout_index_to_text_index</methodname> + <methodparam><parameter role="keyword">layout_index</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">layout_index</parameter> :</term> + <listitem><simpara>index of the entry layout text.</simpara></listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>index of the entry contents.</simpara></listitem> + </varlistentry> + </variablelist> + + <para>The <methodname>layout_index_to_text_index</methodname>() method converts from a position in the entry contents (returned by + <link linkend="method-gtkentry--get-text"><methodname>gtk.Entry.get_text</methodname></link>()) to a position in the entry's + <link linkend="class-pangolayout"><classname>pango.Layout</classname></link> + (returned by <link linkend="method-gtkentry--get-layout"><methodname>gtk.Entry.get_layout</methodname></link>(), + with text retrieved via <link linkend="method-pangolayout--get-text"><methodname>pango.Layout.get_text</methodname></link>()).</para> + + </refsect2> + + <refsect2 id="method-gtkentry--text-index-to-layout-index"> + <title>gtk.Entry.text_index_to_layout_index</title> + + <programlisting><methodsynopsis language="python"> + <methodname>text_index_to_layout_index</methodname> + <methodparam><parameter role="keyword">text_index</parameter></methodparam> + </methodsynopsis></programlisting> + <variablelist> + <varlistentry> + <term><parameter role="keyword">text_index</parameter> :</term> + <listitem><simpara>index of the entry contents.</simpara></listitem> + </varlistentry> + <varlistentry> + <term><emphasis>Returns</emphasis> :</term> + <listitem><simpara>index of the entry layout text.</simpara></listitem> + </varlistentry> + </variablelist> + + <para>The <methodname>text_index_to_layout_index</methodname>() method converts from a position in the entry contents (returned by + <link linkend="method-gtkentry--get-text"><methodname>gtk.Entry.get_text</methodname></link>()) to a position in the entry's + <link linkend="class-pangolayout"><classname>pango.Layout</classname></link> + (returned by <link linkend="method-gtkentry--get-layout"><methodname>gtk.Entry.get_layout</methodname></link>(), + with text retrieved via <link linkend="method-pangolayout--get-text"><methodname>pango.Layout.get_text</methodname></link>()).</para> + + </refsect2> + + <refsect2 id="method-gtkentry--im-context-filter-keypress"> + <title>gtk.Entry.im_context_filter_keypress</title> + + <programlisting><methodsynopsis language="python"> + <methodname>im_context_filter_keypress</methodname> + <methodparam><parameter role="keyword">event</parameter></methodparam> + </methodsynopsis></programlisting> + + <variablelist> + <varlistentry> + <term><parameter role="keyword">event</parameter> :</term> + <listitem><simpara>The key event.</simpara></listitem> + </varlistentry> + </variablelist> + + <note> + <para>This method is available in PyGTK 2.22 and above.</para> + </note> + <para> - The <methodname>get_text_length</methodname>() method retrieves the current length of the text in entry. + The <methodname>im_context_filter_keypress</methodname>() method allows the + <link linkend="class-gtkentry"><classname>gtk.Entry</classname></link> input method to internally handle key + press and release events. If this function returns <literal>True</literal>, then no further processing should be done + for this key event. See <link linkend="method-gtkimcontext--filter-keypress"><methodname>gtk.IMContext.filter_keypress</methodname></link>(). </para> - + + <para> + Note that you are expected to call this function from your handler when overriding key event handling. This + is needed in the case when you need to insert your own key handling between the input method and the default + key event handling of the <link linkend="class-gtkentry"><classname>gtk.Entry</classname></link>. + </para> + </refsect2> - + + <refsect2 id="method-gtkentry--reset-im-context"> + <title>gtk.Entry.reset_im_context</title> + + <programlisting><methodsynopsis language="python"> + <methodname>reset_im_context</methodname> + <methodparam></methodparam> + </methodsynopsis></programlisting> + + <note> + <para>This method is available in PyGTK 2.22 and above.</para> + </note> + + <para> + The <methodname>reset_im_context</methodname>() method resets the input method context of the entry if needed. + </para> + + <para> + This can be necessary in the case where modifying the buffer would confuse on-going input method behavior. + </para> + + </refsect2> + </refsect1> <refsect1> @@ -2115,6 +3216,46 @@ any)</simpara></listitem> </refsect2> + <refsect2 id="signal-gtkentry--preedit-changed"> + <title>The "preedit-changed" gtk.Entry Signal</title> + + <programlisting><methodsynopsis language="python"> + <methodname>callback</methodname> + <methodparam><parameter>entry</parameter></methodparam> + <methodparam><parameter>preedit</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>preedit</parameter> :</term> + <listitem><simpara>the current preedit string</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 "preedit-changed" signal is emitted when an input method is used, the typed text will not + immediately be committed to the buffer. So if you are interested in the text, connect to this signal.</para> + + </refsect2> + <refsect2 id="signal-gtkentry--toggle-overwrite"> <title>The "toggle-overwrite" gtk.Entry Signal</title> |