source: pkg/pygtk/branches/upstream/current/docs/html/class-gtkentry.html @ 4

Revision 4, 64.2 KB checked in by alanbach-guest, 7 years ago (diff)

[svn-inject] Installing original source of pygtk

Line 
1<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.Entry</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.68.1"><link rel="start" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gtk-class-reference.html" title="The gtk Class Reference"><link rel="prev" href="class-gtkeditable.html" title="gtk.Editable"><link rel="next" href="class-gtkentrycompletion.html" title="gtk.EntryCompletion"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtk.Entry</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtkeditable.html">Prev</a> </td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gtkentrycompletion.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtkentry"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.Entry</h2><p>gtk.Entry — a single line text entry field.</p></div><div class="refsect1" lang="en"><a name="id3204789"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.Entry</span></span>(<span class="ooclass"><span class="classname"><a href="class-gtkwidget.html" title="gtk.Widget">gtk.Widget</a></span></span>, <span class="ooclass"><span class="classname"><a href="class-gtkeditable.html" title="gtk.Editable">gtk.Editable</a></span></span>, <span class="ooclass"><span class="classname"><a href="class-gtkcelleditable.html" title="gtk.CellEditable">gtk.CellEditable</a></span></span>):
2<code class="constructorsynopsis">    <span class="methodname"><a href="class-gtkentry.html#constructor-gtkentry" title="Constructor">gtk.Entry</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>max</code></strong></span><span class="initializer">=0</span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gtkentry.html#method-gtkentry--set-visibility" title="gtk.Entry.set_visibility">set_visibility</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>visible</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gtkentry.html#method-gtkentry--get-visibility" title="gtk.Entry.get_visibility">get_visibility</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gtkentry.html#method-gtkentry--set-invisible-char" title="gtk.Entry.set_invisible_char">set_invisible_char</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>ch</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gtkentry.html#method-gtkentry--get-invisible-char" title="gtk.Entry.get_invisible_char">get_invisible_char</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gtkentry.html#method-gtkentry--set-has-frame" title="gtk.Entry.set_has_frame">set_has_frame</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>setting</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gtkentry.html#method-gtkentry--get-has-frame" title="gtk.Entry.get_has_frame">get_has_frame</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gtkentry.html#method-gtkentry--set-max-length" title="gtk.Entry.set_max_length">set_max_length</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>max</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gtkentry.html#method-gtkentry--get-max-length" title="gtk.Entry.get_max_length">get_max_length</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gtkentry.html#method-gtkentry--set-activates-default" title="gtk.Entry.set_activates_default">set_activates_default</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>setting</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gtkentry.html#method-gtkentry--get-activates-default" title="gtk.Entry.get_activates_default">get_activates_default</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gtkentry.html#method-gtkentry--set-width-chars" title="gtk.Entry.set_width_chars">set_width_chars</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>n_chars</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gtkentry.html#method-gtkentry--get-width-chars" title="gtk.Entry.get_width_chars">get_width_chars</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gtkentry.html#method-gtkentry--set-text" title="gtk.Entry.set_text">set_text</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>text</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gtkentry.html#method-gtkentry--get-text" title="gtk.Entry.get_text">get_text</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gtkentry.html#method-gtkentry--get-layout" title="gtk.Entry.get_layout">get_layout</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gtkentry.html#method-gtkentry--get-layout-offsets" title="gtk.Entry.get_layout_offsets">get_layout_offsets</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gtkentry.html#method-gtkentry--set-alignment" title="gtk.Entry.set_alignment">set_alignment</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>xalign</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gtkentry.html#method-gtkentry--get-alignment" title="gtk.Entry.get_alignment">get_alignment</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gtkentry.html#method-gtkentry--set-completion" title="gtk.Entry.set_completion">set_completion</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>width_chars</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gtkentry.html#method-gtkentry--get-completion" title="gtk.Entry.get_completion">get_completion</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gtkentry.html#method-gtkentry--set-inner-border" title="gtk.Entry.set_inner_border">set_inner_border</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>border</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gtkentry.html#method-gtkentry--get-inner-border" title="gtk.Entry.get_inner_border">get_inner_border</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3205303"></a><h2>Ancestry</h2><pre class="synopsis">+-- <PYGTKDOCLINK HREF="class-gobject">gobject.GObject</PYGTKDOCLINK>
3  +-- <a href="class-gtkobject.html" title="gtk.Object">gtk.Object</a>
4    +-- <a href="class-gtkwidget.html" title="gtk.Widget">gtk.Widget</a>
5      +-- <a href="class-gtkentry.html" title="gtk.Entry">gtk.Entry</a> (implements <a href="class-gtkeditable.html" title="gtk.Editable">gtk.Editable</a>, <a href="class-gtkcelleditable.html" title="gtk.CellEditable">gtk.CellEditable</a>)
6</pre></div><div class="refsect1" lang="en"><a name="properties-gtkentry"></a><h2>gtk.Entry Properties</h2><p><a href="class-gtkobject.html#properties-gtkobject" title="gtk.Object Properties">gtk.Object Properties</a></p><p><a href="class-gtkwidget.html#properties-gtkwidget" title="gtk.Widget Properties">gtk.Widget Properties</a></p><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"activates-default"</td><td valign="top">Read/Write</td><td valign="top">If <code class="literal">True</code> activate the default widget
7              (such as the default button in a dialog) when Enter is
8              pressed. Default value: <code class="literal">False</code>.</td></tr><tr valign="top"><td valign="top">"cursor-position"</td><td valign="top">Read</td><td valign="top">The current position of the insertion cursor as a
9              character index. Allowed values: [0,65535]. Default value:
10              0</td></tr><tr valign="top"><td valign="top">"editable"</td><td valign="top">Read/Write</td><td valign="top">If <code class="literal">True</code> the entry contents can be
11              edited. Default value: <code class="literal">True</code>.</td></tr><tr valign="top"><td valign="top">"has-frame"</td><td valign="top">Read/Write</td><td valign="top">If <code class="literal">False</code> removes outside bevel from
12              entry. Default value: <code class="literal">True</code>.</td></tr><tr valign="top"><td valign="top">"inner-border"</td><td valign="top">Read/Write</td><td valign="top">The text area's border between the text and the frame
13              as a gtkBorder. Available in GTK+ 2.10.</td></tr><tr valign="top"><td valign="top">"invisible-char"</td><td valign="top">Read/Write</td><td valign="top">The character to use when masking entry contents (when
14              "visibility" is <code class="literal">False</code>). Default value:
15              '*'.</td></tr><tr valign="top"><td valign="top">"max-length"</td><td valign="top">Read/Write</td><td valign="top">The maximum number of characters for this entry. Zero
16              if no maximum. Allowed values: [0,65535] Default value:
17              0.</td></tr><tr valign="top"><td valign="top">"scroll-offset"</td><td valign="top">Read</td><td valign="top">The number of pixels of the entry scrolled off the
18              screen to the left. Allowed values: &gt;= 0 Default value:
19              0.</td></tr><tr valign="top"><td valign="top">"selection-bound"</td><td valign="top">Read</td><td valign="top">The position of the opposite end of the selection from
20              the cursor as a character index. Allowed values: [0,65535]
21              Default value: 0.</td></tr><tr valign="top"><td valign="top">"text"</td><td valign="top">Read/Write</td><td valign="top">The contents of the entry. Default value: "".</td></tr><tr valign="top"><td valign="top">"truncate-multiline"</td><td valign="top">Read/Write</td><td valign="top">If <code class="literal">True</code>, pasted multi-line text is
22              truncated to the first line. Default value:
23              <code class="literal">False</code>. Available in GTK+ 2.10 and
24              above.</td></tr><tr valign="top"><td valign="top">"visibility"</td><td valign="top">Read/Write</td><td valign="top">If <code class="literal">False</code> displays the "invisible
25              char" instead of the actual text (e.g. password mode). Default
26              value: <code class="literal">True</code>.</td></tr><tr valign="top"><td valign="top">"width-chars"</td><td valign="top">Read/Write</td><td valign="top">The number of characters to leave space for in the
27              entry. Allowed values: &gt;= -1. Default value: -1.</td></tr><tr valign="top"><td valign="top">"xalign"</td><td valign="top">Read/Write</td><td valign="top">The horizontal alignment ranging from 0.0 to 1.0
28              representing the fraction of freespace to the left (right for
29              RTL layouts) of the text. Available in GTK+ 2.4 and
30              above.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="style-properties-gtkentry"></a><h2>gtk.Entry Style Properties</h2><p><a href="class-gtkwidget.html#style-properties-gtkwidget" title="gtk.Widget Style Properties">gtk.Widget Style Properties</a></p><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"inner-border"</td><td valign="top">Read</td><td valign="top">Sets the text area's border between the text and the frame
31          This property is available in GTK+ 2.10 and above.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="signal-prototypes-gtkentry"></a><h2>gtk.Entry Signal Prototypes</h2><p><PYGTKDOCLINK HREF="signal-prototypes-gobject">gobject.GObject Signal Prototypes</PYGTKDOCLINK></p><p><a href="class-gtkobject.html#signal-prototypes-gtkobject" title="gtk.Object Signal Prototypes">gtk.Object Signal Prototypes</a></p><p><a href="class-gtkwidget.html#signal-prototypes-gtkwidget" title="gtk.Widget Signal Prototypes">gtk.Widget Signal Prototypes</a></p><p><a href="class-gtkeditable.html#signal-prototypes-gtkeditable" title="gtk.Editable Signal Prototypes">gtk.Editable Signal Prototypes</a></p><p><a href="class-gtkcelleditable.html#signal-prototypes-gtkcelleditable" title="gtk.CellEditable Signal Prototypes">gtk.CellEditable Signal Prototypes</a></p><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term">"<a href="class-gtkentry.html#signal-gtkentry--activate" title='The "activate" gtk.Entry Signal'>activate</a>"</span></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>entry</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><span class="term">"<a href="class-gtkentry.html#signal-gtkentry--backspace" title='The "backspace" gtk.Entry Signal'>backspace</a></span></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>entry</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><span class="term">"<a href="class-gtkentry.html#signal-gtkentry--copy-clipboard" title='The "copy-clipboard" gtk.Entry Signal'>copy-clipboard</a>"</span></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>entry</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><span class="term">"<a href="class-gtkentry.html#signal-gtkentry--cut-clipboard" title='The "cut-clipboard" gtk.Entry Signal'>cut-clipboard</a>"</span></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>entry</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><span class="term">"<a href="class-gtkentry.html#signal-gtkentry--delete-from-cursor" title='The "delete-from-cursor" gtk.Entry Signal'>delete-from-cursor</a>"</span></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>entry</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>delete_type</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>count</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><span class="term">"<a href="class-gtkentry.html#signal-gtkentry--insert-at-cursor" title='The "insert-at-cursor" gtk.Entry Signal'>insert-at-cursor</a>"</span></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>entry</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>string</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><span class="term">"<a href="class-gtkentry.html#signal-gtkentry--move-cursor" title='The "move-cursor" gtk.Entry Signal'>move-cursor</a>"</span></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>entry</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>step_size</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>count</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>extend_selection</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><span class="term">"<a href="class-gtkentry.html#signal-gtkentry--paste-clipboard" title='The "paste-clipboard" gtk.Entry Signal'>paste-clipboard</a>"</span></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>entry</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><span class="term">"<a href="class-gtkentry.html#signal-gtkentry--populate-popup" title='The "populate-popup" gtk.Entry Signal'>populate-popup</a>"</span></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>entry</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>menu</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr><tr><td><span class="term">"<a href="class-gtkentry.html#signal-gtkentry--toggle-overwrite" title='The "toggle-overwrite" gtk.Entry Signal'>toggle-overwrite</a>"</span></td><td><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>entry</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></td></tr></tbody></table></div><div class="refsect1" lang="en"><a name="id3206609"></a><h2>Description</h2><p>The <a href="class-gtkentry.html" title="gtk.Entry"><code class="classname">gtk.Entry</code></a> widget
32    is a single line text entry widget. A fairly large set of key bindings
33    are supported by default. If the entered text is longer than the
34    allocation of the widget, the widget will scroll so that the cursor
35    position is visible.</p></div><div class="refsect1" lang="en"><a name="constructor-gtkentry"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis">    <span class="methodname">gtk.Entry</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>max</code></strong></span><span class="initializer">=0</span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><strong class="parameter"><code>max</code></strong> :</span></td><td>the maximum length of the entry, or 0 for no
36maximum. (other than the maximum length of entries.) The value passed in
37will be limited to the range 0-65536.</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>a new <a href="class-gtkentry.html" title="gtk.Entry"><code class="classname">gtk.Entry</code></a>.</td></tr></tbody></table><p>Creates a new <a href="class-gtkentry.html" title="gtk.Entry"><code class="classname">gtk.Entry</code></a> widget
38    with the maximum length specified by <em class="parameter"><code>max</code></em>.</p></div><div class="refsect1" lang="en"><a name="id3206738"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtkentry--set-visibility"></a><h3>gtk.Entry.set_visibility</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_visibility</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>visible</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><strong class="parameter"><code>visible</code></strong> :</span></td><td>If False the contents are obscured using the
39"invisible-char"</td></tr></tbody></table><p>The <code class="methodname">set_visibility</code>() method sets the
40      "visibility" property to the value of
41      <em class="parameter"><code>visible</code></em>. If visible is <code class="literal">True</code>
42      the contents of the entry are displayed as plain text. If visible is
43      <code class="literal">False</code>, the contents are obscured by replacing the
44      characters with the invisible character (specified by the
45      "invisible-char" property). The characters will also be obscured when
46      the text in the entry widget is copied elsewhere. The default
47      invisible char is the asterisk '*', but it can be changed with <a href="class-gtkentry.html#method-gtkentry--set-invisible-char" title="gtk.Entry.set_invisible_char"><code class="methodname">set_invisible_char</code>()</a>.</p></div><div class="refsect2" lang="en"><a name="method-gtkentry--get-visibility"></a><h3>gtk.Entry.get_visibility</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_visibility</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td><code class="literal">True</code> if the text is
48currently visible</td></tr></tbody></table><p>The <code class="methodname">get_visibility</code>() method retrieves
49      the value of the "visibility" property that determines whether the
50      text in <em class="parameter"><code>entry</code></em> is visible. See <a href="class-gtkentry.html#method-gtkentry--set-visibility" title="gtk.Entry.set_visibility"><code class="methodname">set_visibility</code>()</a>.</p></div><div class="refsect2" lang="en"><a name="method-gtkentry--set-invisible-char"></a><h3>gtk.Entry.set_invisible_char</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_invisible_char</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>ch</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><strong class="parameter"><code>ch</code></strong> :</span></td><td>a Unicode character</td></tr></tbody></table><p>The <code class="methodname">set_invisible_char</code>() method sets
51      the "invisible-char" property with the value of
52      <em class="parameter"><code>ch</code></em>.  The "invisible-char" is the character to
53      use in place of the actual text when <a href="class-gtkentry.html#method-gtkentry--set-visibility" title="gtk.Entry.set_visibility"><code class="methodname">set_visibility</code>()</a>
54      has been called to set text visibility to
55      <code class="literal">False</code>. i.e.  this is the character used in
56      "password mode" to show the user how many characters have been
57      typed. The default invisible character is an asterisk ('*').  If you
58      set the invisible character to 0, then the user will get no feedback
59      at all; there will be no text on the screen as they type.</p></div><div class="refsect2" lang="en"><a name="method-gtkentry--get-invisible-char"></a><h3>gtk.Entry.get_invisible_char</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_invisible_char</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the current invisible char, or 0, if the entry
60does not show invisible text at all.</td></tr></tbody></table><p>The get_invisible_char() method retrieves the value of the
61      "invisible-char" property. The "invisible-char" is the character
62      displayed in place of the real characters for entries with visibility
63      set to <code class="literal">False</code>. See <a href="class-gtkentry.html#method-gtkentry--set-invisible-char" title="gtk.Entry.set_invisible_char"><code class="methodname">set_invisible_char</code>()</a>.</p></div><div class="refsect2" lang="en"><a name="method-gtkentry--set-has-frame"></a><h3>gtk.Entry.set_has_frame</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_has_frame</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>setting</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><strong class="parameter"><code>setting</code></strong> :</span></td><td>If True the entry is displayed with a beveled
64frame around it.</td></tr></tbody></table><p>The <code class="methodname">set_has_frame</code>() method sets the
65      "has-frame" property to the value of <em class="parameter"><code>setting</code></em>.
66      If <em class="parameter"><code>setting</code></em> is <code class="literal">True</code> the entry
67      is displayed with a beveled frame around it.</p></div><div class="refsect2" lang="en"><a name="method-gtkentry--get-has-frame"></a><h3>gtk.Entry.get_has_frame</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_has_frame</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>whether the entry has a beveled
68frame</td></tr></tbody></table><p>The <code class="methodname">get_has_frame</code>() method gets the
69      value of the "has-frame" property. If "has-frame" is
70      <code class="literal">True</code> the entry will be displayed with a beveled
71      frame around it.</p></div><div class="refsect2" lang="en"><a name="method-gtkentry--set-max-length"></a><h3>gtk.Entry.set_max_length</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_max_length</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>max</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><strong class="parameter"><code>max</code></strong> :</span></td><td>the maximum length of the entry, or 0 for no
72          maximum. (other than the maximum length of entries.) The value
73          passed in will be clamped to the range
74          0-65536.</td></tr></tbody></table><p>The <code class="methodname">set_max_length</code>() method sets the
75      "max-length" property to the value of <em class="parameter"><code>max</code></em>.  The
76      "max-length" property sets the maximum allowed length of the contents
77      of the widget. If the current contents are longer than the given
78      length, then they will be truncated to fit. If max is 0 then there is
79      no maximum length (other than 65536).</p></div><div class="refsect2" lang="en"><a name="method-gtkentry--get-max-length"></a><h3>gtk.Entry.get_max_length</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_max_length</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the maximum allowed number of characters in
80<a href="class-gtkentry.html" title="gtk.Entry"><code class="classname">gtk.Entry</code></a>, or 0
81if there is no maximum.</td></tr></tbody></table><p>The <code class="methodname">get_max_length</code>() method retrieves
82      the value of the "max-length" property that specifies the maximum
83      allowed length of the text in the entry. See <a href="class-gtkentry.html#method-gtkentry--set-max-length" title="gtk.Entry.set_max_length"><code class="methodname">set_max_length</code>()</a>.</p></div><div class="refsect2" lang="en"><a name="method-gtkentry--set-activates-default"></a><h3>gtk.Entry.set_activates_default</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_activates_default</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>setting</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><strong class="parameter"><code>setting</code></strong> :</span></td><td>If <code class="literal">True</code> activate the
84window's default widget on an <span><strong class="keycap">Enter</strong></span>
85key press</td></tr></tbody></table><p>The <code class="methodname">set_activates_default</code>() method sets
86      the "activates-default" property to the value of
87      <em class="parameter"><code>setting</code></em>. If <em class="parameter"><code>setting</code></em> is
88      <code class="literal">True</code>, pressing the <span><strong class="keycap">Enter</strong></span> key in
89      the entry will activate the default widget for the window containing
90      the entry.  This usually means that the dialog box containing the
91      entry will be closed, since the default widget is usually one of the
92      dialog buttons.</p><p>(For experts: if <em class="parameter"><code>setting</code></em> is
93      <code class="literal">True</code>, the entry calls <a href="class-gtkwindow.html#method-gtkwindow--activate-default" title="gtk.Window.activate_default"><code class="methodname">gtk.Window.activate_default</code>()</a>
94      on the window containing the entry, in the default handler for the
95      "activate" signal.)</p></div><div class="refsect2" lang="en"><a name="method-gtkentry--get-activates-default"></a><h3>gtk.Entry.get_activates_default</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_activates_default</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td><code class="literal">True</code> if the entry will
96activate the default widget</td></tr></tbody></table><p>The <code class="methodname">get_activates_default</code>() method
97      retrieves the value of the "activates-default" property which is set
98      by <a href="class-gtkentry.html#method-gtkentry--set-activates-default" title="gtk.Entry.set_activates_default"><code class="methodname">set_activates_default</code>()</a>.
99      If "activates-default" is <code class="literal">True</code> pressing the
100      <span><strong class="keycap">Enter</strong></span> key in the entry will activate the default
101      widget for the window containing the entry.</p></div><div class="refsect2" lang="en"><a name="method-gtkentry--set-width-chars"></a><h3>gtk.Entry.set_width_chars</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_width_chars</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>n_chars</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><strong class="parameter"><code>n_chars</code></strong> :</span></td><td>width in chars</td></tr></tbody></table><p>The <code class="methodname">set_width_chars</code>() method sets the
102      "width-chars" property to the value of <em class="parameter"><code>n_char</code></em>.
103      Setting the "width-chars" property changes the size request of the
104      entry to be about the right size for <em class="parameter"><code>n_chars</code></em>
105      characters. Note that it only changes the size
106      <span class="emphasis"><em>request</em></span>, the size can still be affected by how
107      you pack the widget into containers. If <em class="parameter"><code>n_chars</code></em>
108      is -1, the size reverts to the default entry size.</p></div><div class="refsect2" lang="en"><a name="method-gtkentry--get-width-chars"></a><h3>gtk.Entry.get_width_chars</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_width_chars</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>number of chars to request space for, or
109negative if unset</td></tr></tbody></table><p>The <code class="methodname">get_width_chars</code>() method gets the
110      value of the "width-chars" property which is set by the <a href="class-gtkentry.html#method-gtkentry--set-width-chars" title="gtk.Entry.set_width_chars"><code class="methodname">set_width_chars</code>()</a>
111      method.</p></div><div class="refsect2" lang="en"><a name="method-gtkentry--set-text"></a><h3>gtk.Entry.set_text</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_text</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>text</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><strong class="parameter"><code>text</code></strong> :</span></td><td>a string to use as the new contents of the
112entry</td></tr></tbody></table><p>The <code class="methodname">set_text</code>() method sets the "text"
113      property to the value of <em class="parameter"><code>text</code></em>. The string in
114      <em class="parameter"><code>text</code></em> replaces the current contents of the
115      entry.</p></div><div class="refsect2" lang="en"><a name="method-gtkentry--get-text"></a><h3>gtk.Entry.get_text</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_text</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the contents of the entry as a
116string</td></tr></tbody></table><p>The <code class="methodname">get_text</code>() method returns the value
117      of the "text" property which is a string containing the contents of
118      the entry.</p></div><div class="refsect2" lang="en"><a name="method-gtkentry--get-layout"></a><h3>gtk.Entry.get_layout</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_layout</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the <a href="class-pangolayout.html" title="pango.Layout"><code class="classname">pango.Layout</code></a> for
119this entry</td></tr></tbody></table><p>The <code class="methodname">get_layout</code>() method gets the <a href="class-pangolayout.html" title="pango.Layout"><code class="classname">pango.Layout</code></a>
120      used to display the entry. The layout is useful to e.g. convert text
121      positions to pixel positions, in combination with <a href="class-gtkentry.html#method-gtkentry--get-layout-offsets" title="gtk.Entry.get_layout_offsets"><code class="methodname">get_layout_offsets</code>()</a>.</p></div><div class="refsect2" lang="en"><a name="method-gtkentry--get-layout-offsets"></a><h3>gtk.Entry.get_layout_offsets</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_layout_offsets</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>a tuple containing the X and Y offsets of the
122pango layout</td></tr></tbody></table><p>The <code class="methodname">get_layout_offsets</code>() method obtains
123      the position of the <a href="class-pangolayout.html" title="pango.Layout"><code class="classname">pango.Layout</code></a>
124      used to render text in the entry, in widget coordinates and returns it
125      as a tuple. This method is used to line up the text in an entry with
126      some other text, e.g. when using the entry to implement editable cells
127      in a sheet widget. It is also useful to convert mouse events into
128      coordinates inside the <a href="class-pangolayout.html" title="pango.Layout"><code class="classname">pango.Layout</code></a>,
129      e.g.  to take some action if some part of the entry text is
130      clicked.</p><p>Note that as the user scrolls around in the entry the offsets
131      will change; you'll need to connect to the "notify::scroll_offset"
132      signal to track this.</p></div><div class="refsect2" lang="en"><a name="method-gtkentry--set-alignment"></a><h3>gtk.Entry.set_alignment</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_alignment</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>xalign</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><strong class="parameter"><code>xalign</code></strong> :</span></td><td>The horizontal alignment ranging from 0.0 to
133          1.0 representing the freespace to the left (right for RTL layouts)
134          of the text.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">set_alignment</code>() method sets the
135      "xalign" property to the value of <em class="parameter"><code>xalign</code></em>. The
136      alignment controls the horizontal positioning of the contents when the
137      displayed text is shorter than the width of the entry. The value of
138      <em class="parameter"><code>xalign</code></em> is the fraction of freespace to the left
139      (right in RTL layouts) of the text.</p></div><div class="refsect2" lang="en"><a name="method-gtkentry--get-alignment"></a><h3>gtk.Entry.get_alignment</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_alignment</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>The horizontal alignment ranging from 0.0 to
140          1.0 representing the freespace to the left (right for RTL layouts)
141          of the text.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">get_alignment</code>() method returns the
142      value of the "xalign" property which is the fraction of freespace (if
143      any) to the left (right in RTL layouts) of the text.</p></div><div class="refsect2" lang="en"><a name="method-gtkentry--set-completion"></a><h3>gtk.Entry.set_completion</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_completion</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>completion</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><strong class="parameter"><code>completion</code></strong> :</span></td><td>a <a href="class-gtkentrycompletion.html" title="gtk.EntryCompletion"><code class="classname">gtk.EntryCompletion</code></a></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">set_completion</code>() method sets the
144      <a href="class-gtkentrycompletion.html" title="gtk.EntryCompletion"><code class="classname">gtk.EntryCompletion</code></a>
145      specified by <em class="parameter"><code>completion</code></em> to be the auxiliary
146      completion object to use with the entry. All further configuration of
147      the completion mechanism is done using
148      <em class="parameter"><code>completion</code></em> and the <a href="class-gtkentrycompletion.html" title="gtk.EntryCompletion"><code class="classname">gtk.EntryCompletion</code></a>
149      methods.</p></div><div class="refsect2" lang="en"><a name="method-gtkentry--get-completion"></a><h3>gtk.Entry.get_completion</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_completion</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the auxiliary completion object</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.4 and above.</p></div><p>The <code class="methodname">get_completion</code>() method returns the
150     <a href="class-gtkentrycompletion.html" title="gtk.EntryCompletion"><code class="classname">gtk.EntryCompletion</code></a>
151     object currently in use by the entry.</p></div><div class="refsect2" lang="en"><a name="method-gtkentry--set-inner-border"></a><h3>gtk.Entry.set_inner_border</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">set_inner_border</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>border</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><strong class="parameter"><code>border</code></strong> :</span></td><td>a <a href="class-gtkborder.html" title="gtk.Border"><code class="classname">gtk.Border</code></a>,
152          or <code class="literal">None</code></td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.10 and above.</p></div><p>The <code class="methodname">set_inner_border</code>() method sets the
153      entry's "inner-border" property to the value specified by
154      <em class="parameter"><code>border</code></em>, or clears it if <code class="literal">None</code>
155      is passed. The "inner-border" is the area around the entry's text, but
156      inside its frame.</p><p>If set, this property overrides the inner-border style property.
157      Overriding the style-provided border is useful when you want to do
158      in-place editing of some text in a canvas or list widget, where
159      pixel-exact positioning of the entry is important.</p></div><div class="refsect2" lang="en"><a name="method-gtkentry--get-inner-border"></a><h3>gtk.Entry.get_inner_border</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_inner_border</span>(<span class="methodparam"></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td>the entry's <a href="class-gtkborder.html" title="gtk.Border"><code class="classname">gtk.Border</code></a>,
160          or <code class="literal">None</code> if none was set.</td></tr></tbody></table><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>This method is available in PyGTK 2.10 and above.</p></div><p>The <code class="methodname">get_inner_border</code>() method returns
161      the value of the entry's "inner-border" property. See <a href="class-gtkentry.html#method-gtkentry--set-inner-border" title="gtk.Entry.set_inner_border"><code class="methodname">set_inner_border</code>()</a>
162      for more information.</p></div></div><div class="refsect1" lang="en"><a name="id3208694"></a><h2>Signals</h2><div class="refsect2" lang="en"><a name="signal-gtkentry--activate"></a><h3>The "activate" gtk.Entry Signal</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>entry</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td><td>the entry that received the
163signal</td></tr><tr><td><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></td><td>the first user parameter (if any) specified
164with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
165method</td></tr><tr><td><span class="term"><em class="parameter"><code>...</code></em> :</span></td><td>additional user parameters (if
166any)</td></tr></tbody></table><p>The "activate" signal is emitted when the entry is activated
167      either by user action (pressing the <span><strong class="keycap">Enter</strong></span> key) or
168      programmatically with the <a href="class-gtkwidget.html#method-gtkwidget--activate" title="gtk.Widget.activate"><code class="methodname">gtk.Widget.activate</code>()</a>
169      method</p></div><div class="refsect2" lang="en"><a name="signal-gtkentry--backspace"></a><h3>The "backspace" gtk.Entry Signal</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>entry</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td><td>the object which received the signal.</td></tr><tr><td><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></td><td>the first user parameter (if any) specified
170          with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
171          method</td></tr><tr><td><span class="term"><em class="parameter"><code>...</code></em> :</span></td><td>additional user parameters (if any)</td></tr></tbody></table><p>The "backspace" signal is emitted when the
172      <span class="keysym">Backspace</span> key is entered from the keyboard.</p></div><div class="refsect2" lang="en"><a name="signal-gtkentry--copy-clipboard"></a><h3>The "copy-clipboard" gtk.Entry Signal</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>entry</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td><td>the entry that received the
173signal</td></tr><tr><td><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></td><td>the first user parameter (if any) specified
174with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
175method</td></tr><tr><td><span class="term"><em class="parameter"><code>...</code></em> :</span></td><td>additional user parameters (if
176any)</td></tr></tbody></table><p>The "copy-clipboard" signal is emitted when the selection text
177      in the entry is copied to the clipboard.</p></div><div class="refsect2" lang="en"><a name="signal-gtkentry--cut-clipboard"></a><h3>The "cut-clipboard" gtk.Entry Signal</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>entry</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td><td>the entry that received the
178signal</td></tr><tr><td><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></td><td>the first user parameter (if any) specified
179with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
180method</td></tr><tr><td><span class="term"><em class="parameter"><code>...</code></em> :</span></td><td>additional user parameters (if
181any)</td></tr></tbody></table><p>The "cut-clipboard" signal is emitted when the selection in the
182      entry is cut (removed from the entry) and placed in the
183      clipboard.</p></div><div class="refsect2" lang="en"><a name="signal-gtkentry--delete-from-cursor"></a><h3>The "delete-from-cursor" gtk.Entry Signal</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>entry</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>delete_type</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>count</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td><td>the entry that received the
184signal</td></tr><tr><td><span class="term"><em class="parameter"><code>delete_type</code></em> :</span></td><td>the type of deletion</td></tr><tr><td><span class="term"><em class="parameter"><code>count</code></em> :</span></td><td>the number of deletions of the type to
185perform</td></tr><tr><td><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></td><td>the first user parameter (if any) specified
186with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
187method</td></tr><tr><td><span class="term"><em class="parameter"><code>...</code></em> :</span></td><td>additional user parameters (if
188any)</td></tr></tbody></table><p>The "delete-from-cursor" signal is emitted when the a deletion
189      from the cursor i.e. removal o text at the cursor position, either
190      before it (negative <em class="parameter"><code>count</code></em>) or after it
191      (positive <em class="parameter"><code>count</code></em>). The value of
192      <em class="parameter"><code>delete_type</code></em> can be one of:</p><div class="itemizedlist"><ul type="disc"><li>gtk.DELETE_CHARS</li><li>gtk.DELETE_WORD_ENDS</li><li>  gtk.DELETE_WORDS</li><li>  gtk.DELETE_DISPLAY_LINES</li><li>  gtk.DELETE_DISPLAY_LINE_ENDS</li><li>  gtk.DELETE_PARAGRAPH_ENDS</li><li>  gtk.DELETE_PARAGRAPHS</li><li>  gtk.DELETE_WHITESPACE</li></ul></div></div><div class="refsect2" lang="en"><a name="signal-gtkentry--insert-at-cursor"></a><h3>The "insert-at-cursor" gtk.Entry Signal</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>entry</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>string</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td><td>the entry that received the
193signal</td></tr><tr><td><span class="term"><em class="parameter"><code>string</code></em> :</span></td><td>the text being inserted in the
194entry</td></tr><tr><td><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></td><td>the first user parameter (if any) specified
195with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
196method</td></tr><tr><td><span class="term"><em class="parameter"><code>...</code></em> :</span></td><td>additional user parameters (if
197any)</td></tr></tbody></table><p>The "insert-at-cursor" signal is emitted when text is being
198      inserted in the entry.</p></div><div class="refsect2" lang="en"><a name="signal-gtkentry--move-cursor"></a><h3>The "move-cursor" gtk.Entry Signal</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>entry</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>step</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>count</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>extend_selection</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td><td>the entry that received the
199signal</td></tr><tr><td><span class="term"><em class="parameter"><code>step</code></em> :</span></td><td>the size of the step to move the
200cursor</td></tr><tr><td><span class="term"><em class="parameter"><code>count</code></em> :</span></td><td>the number of steps to move the
201cursor</td></tr><tr><td><span class="term"><em class="parameter"><code>extend_selection</code></em> :</span></td><td>if True extend the selection as well as moving
202the cursor</td></tr><tr><td><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></td><td>the first user parameter (if any) specified
203with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
204method</td></tr><tr><td><span class="term"><em class="parameter"><code>...</code></em> :</span></td><td>additional user parameters (if
205any)</td></tr></tbody></table><p>The "move-cursor" signal is emitted when the cursor is being
206      moved by <em class="parameter"><code>count</code></em> steps of size
207      <em class="parameter"><code>step</code></em>. If
208      <em class="parameter"><code>extend_selection</code></em> is <code class="literal">True</code> the
209      selection is extended as the cursor is being moved. The value of
210      <em class="parameter"><code>step</code></em> can be one of:</p><div class="itemizedlist"><ul type="disc"><li>gtk.MOVEMENT_LOGICAL_POSITIONS</li><li>gtk.MOVEMENT_VISUAL_POSITIONS</li><li>  gtk.MOVEMENT_WORDS</li><li>  gtk.MOVEMENT_DISPLAY_LINES</li><li>  gtk.MOVEMENT_DISPLAY_LINE_ENDS</li><li>  gtk.MOVEMENT_PARAGRAPH_ENDS</li><li>  gtk.MOVEMENT_PARAGRAPHS</li><li>  gtk.MOVEMENT_PAGES</li><li>  gtk.MOVEMENT_BUFFER_ENDS</li></ul></div></div><div class="refsect2" lang="en"><a name="signal-gtkentry--paste-clipboard"></a><h3>The "paste-clipboard" gtk.Entry Signal</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>entry</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td><td>the entry that received the
211signal</td></tr><tr><td><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></td><td>the first user parameter (if any) specified
212with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
213method</td></tr><tr><td><span class="term"><em class="parameter"><code>...</code></em> :</span></td><td>additional user parameters (if
214any)</td></tr></tbody></table><p>The "paste-clipboard" signal is emitted when the contents of the
215      clipboard are pasted into the entry.</p></div><div class="refsect2" lang="en"><a name="signal-gtkentry--populate-popup"></a><h3>The "populate-popup" gtk.Entry Signal</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>entry</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>menu</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td><td>the entry that received the
216signal</td></tr><tr><td><span class="term"><em class="parameter"><code>menu</code></em> :</span></td><td>the menu that needs
217populating</td></tr><tr><td><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></td><td>the first user parameter (if any) specified
218with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
219method</td></tr><tr><td><span class="term"><em class="parameter"><code>...</code></em> :</span></td><td>additional user parameters (if
220any)</td></tr></tbody></table><p>The "populate-popup" signal is emitted when the
221      <em class="parameter"><code>menu</code></em> needs populating.</p></div><div class="refsect2" lang="en"><a name="signal-gtkentry--toggle-overwrite"></a><h3>The "toggle-overwrite" gtk.Entry Signal</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">callback</span>(<span class="methodparam"><span class="parameter"><em class="parameter"><code>entry</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>user_param1</code></em></span></span>, <span class="methodparam"><span class="parameter"><em class="parameter"><code>...</code></em></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td><td>the entry that received the
222signal</td></tr><tr><td><span class="term"><em class="parameter"><code>user_param1</code></em> :</span></td><td>the first user parameter (if any) specified
223with the <PYGTKDOCLINK HREF="method-gobject--connect"><code class="methodname">connect</code>()</PYGTKDOCLINK>
224method</td></tr><tr><td><span class="term"><em class="parameter"><code>...</code></em> :</span></td><td>additional user parameters (if
225any)</td></tr></tbody></table><p>The "toggle-overwrite" signal is emitted when the internal entry
226      attribute "overwrite_mode" is toggled by pressing the
227      <span><strong class="keycap">Insert</strong></span> key.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="class-gtkeditable.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="gtk-class-reference.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="class-gtkentrycompletion.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.Editable </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> gtk.EntryCompletion</td></tr></table></div></body></html>
Note: See TracBrowser for help on using the repository browser.