1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
5
<title>GtkEntry</title>
6
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
7
<link rel="start" href="index.html" title="GTK+ Reference Manual">
8
<link rel="up" href="NumericEntry.html" title="Numeric/Text Data Entry">
9
<link rel="prev" href="NumericEntry.html" title="Numeric/Text Data Entry">
10
<link rel="next" href="GtkEntryCompletion.html" title="GtkEntryCompletion">
11
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
12
<link rel="stylesheet" href="style.css" type="text/css">
13
<link rel="part" href="gtk.html" title="Part I. GTK+ Overview">
14
<link rel="part" href="gtkbase.html" title="Part II. GTK+ Core Reference">
15
<link rel="part" href="gtkobjects.html" title="Part III. GTK+ Widgets and Objects">
16
<link rel="chapter" href="ch01.html" title="Object Hierarchy">
17
<link rel="chapter" href="ch02.html" title="Widget Gallery">
18
<link rel="chapter" href="WindowWidgets.html" title="Windows">
19
<link rel="chapter" href="DisplayWidgets.html" title="Display Widgets">
20
<link rel="chapter" href="ButtonWidgets.html" title="Buttons and Toggles">
21
<link rel="chapter" href="NumericEntry.html" title="Numeric/Text Data Entry">
22
<link rel="chapter" href="TextWidgetObjects.html" title="Multiline Text Editor">
23
<link rel="chapter" href="TreeWidgetObjects.html" title="Tree, List and Icon Grid Widgets">
24
<link rel="chapter" href="MenusAndCombos.html" title="Menus, Combo Box, Toolbar">
25
<link rel="chapter" href="Actions.html" title="Action-based menus and toolbars">
26
<link rel="chapter" href="SelectorWidgets.html" title="Selectors (File/Font/Color/Input Devices)">
27
<link rel="chapter" href="LayoutContainers.html" title="Layout Containers">
28
<link rel="chapter" href="Ornaments.html" title="Ornaments">
29
<link rel="chapter" href="ScrollingWidgets.html" title="Scrolling">
30
<link rel="chapter" href="Printing.html" title="Printing">
31
<link rel="chapter" href="MiscObjects.html" title="Miscellaneous">
32
<link rel="chapter" href="AbstractObjects.html" title="Abstract Base Classes">
33
<link rel="chapter" href="PlugSocket.html" title="Cross-process Embedding">
34
<link rel="chapter" href="SpecialObjects.html" title="Special-purpose features">
35
<link rel="chapter" href="RecentDocuments.html" title="Recently Used Documents">
36
<link rel="chapter" href="DeprecatedObjects.html" title="Deprecated">
37
<link rel="part" href="migrating.html" title="Part IV. Migrating from Previous Versions of GTK+">
38
<link rel="chapter" href="gtk-migrating-checklist.html" title="Migration Checklist">
39
<link rel="chapter" href="gtk-migrating-GtkFileChooser.html" title="Migrating from GtkFileSelection to GtkFileChooser">
40
<link rel="chapter" href="gtk-migrating-GtkAction.html" title="Migrating from old menu and toolbar systems to GtkAction">
41
<link rel="chapter" href="gtk-migrating-GtkComboBox.html" title="Migrating from GtkOptionMenu and GtkCombo to GtkComboBox and GtkComboBoxEntry">
42
<link rel="chapter" href="gtk-migrating-GtkIconView.html" title="Migrating from GnomeIconList to GtkIconView">
43
<link rel="chapter" href="gtk-migrating-GtkAboutDialog.html" title="Migrating from GnomeAbout to GtkAboutDialog">
44
<link rel="chapter" href="gtk-migrating-GtkColorButton.html" title="Migrating from GnomeColorPicker to GtkColorButton">
45
<link rel="chapter" href="gtk-migrating-GtkAssistant.html" title="Migrating from GnomeDruid to GtkAssistant">
46
<link rel="chapter" href="gtk-migrating-GtkRecentChooser.html" title="Migrating from EggRecent to GtkRecentChooser">
47
<link rel="chapter" href="gtk-migrating-GtkLinkButton.html" title="Migrating from GnomeHRef to GtkLinkButton">
48
<link rel="part" href="pt05.html" title="Part V. GTK+ Tools">
49
<link rel="glossary" href="glossary.html" title="Glossary">
50
<link rel="index" href="ix01.html" title="Index">
51
<link rel="index" href="ix02.html" title="Index of deprecated symbols">
52
<link rel="index" href="ix03.html" title="Index of new symbols in 2.2">
53
<link rel="index" href="ix04.html" title="Index of new symbols in 2.4">
54
<link rel="index" href="ix05.html" title="Index of new symbols in 2.6">
55
<link rel="index" href="ix06.html" title="Index of new symbols in 2.8">
56
<link rel="index" href="ix07.html" title="Index of new symbols in 2.10">
58
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
59
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
61
<td><a accesskey="p" href="NumericEntry.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
62
<td><a accesskey="u" href="NumericEntry.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
63
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
64
<th width="100%" align="center">GTK+ Reference Manual</th>
65
<td><a accesskey="n" href="GtkEntryCompletion.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
67
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2991773" class="shortcut">Top</a>
69
<a href="#id2993154" class="shortcut">Description</a>
71
<a href="#id2992656" class="shortcut">Object Hierarchy</a>
73
<a href="#id2992710" class="shortcut">Implemented Interfaces</a>
75
<a href="#id2992747" class="shortcut">Properties</a>
77
<a href="#id2992999" class="shortcut">Style Properties</a>
79
<a href="#id2993032" class="shortcut">Signals</a></nobr></td></tr>
81
<div class="refentry" lang="en">
82
<a name="GtkEntry"></a><div class="titlepage"></div>
83
<div class="refnamediv"><table width="100%"><tr>
86
<a name="id2991773"></a><span class="refentrytitle">GtkEntry</span>
88
<p>GtkEntry — A single line text entry field</p>
90
<td valign="top" align="right"><img src="entry.png"></td>
92
<div class="refsynopsisdiv">
94
<pre class="synopsis">
96
#include <gtk/gtk.h>
99
<a href="GtkEntry.html#GtkEntry-struct">GtkEntry</a>;
100
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* <a href="GtkEntry.html#gtk-entry-new">gtk_entry_new</a> (void);
101
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* <a href="GtkEntry.html#gtk-entry-new-with-max-length">gtk_entry_new_with_max_length</a> (gint max);
102
void <a href="GtkEntry.html#gtk-entry-set-text">gtk_entry_set_text</a> (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
104
void <a href="GtkEntry.html#gtk-entry-append-text">gtk_entry_append_text</a> (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
106
void <a href="GtkEntry.html#gtk-entry-prepend-text">gtk_entry_prepend_text</a> (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
108
void <a href="GtkEntry.html#gtk-entry-set-position">gtk_entry_set_position</a> (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
110
const gchar* <a href="GtkEntry.html#gtk-entry-get-text">gtk_entry_get_text</a> (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry);
111
void <a href="GtkEntry.html#gtk-entry-select-region">gtk_entry_select_region</a> (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
114
void <a href="GtkEntry.html#gtk-entry-set-visibility">gtk_entry_set_visibility</a> (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
116
void <a href="GtkEntry.html#gtk-entry-set-invisible-char">gtk_entry_set_invisible_char</a> (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
118
void <a href="GtkEntry.html#gtk-entry-set-editable">gtk_entry_set_editable</a> (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
120
void <a href="GtkEntry.html#gtk-entry-set-max-length">gtk_entry_set_max_length</a> (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
122
gboolean <a href="GtkEntry.html#gtk-entry-get-activates-default">gtk_entry_get_activates_default</a> (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry);
123
gboolean <a href="GtkEntry.html#gtk-entry-get-has-frame">gtk_entry_get_has_frame</a> (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry);
124
const <a href="GtkStyle.html#GtkBorder">GtkBorder</a>* <a href="GtkEntry.html#gtk-entry-get-inner-border">gtk_entry_get_inner_border</a> (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry);
125
gint <a href="GtkEntry.html#gtk-entry-get-width-chars">gtk_entry_get_width_chars</a> (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry);
126
void <a href="GtkEntry.html#gtk-entry-set-activates-default">gtk_entry_set_activates_default</a> (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
128
void <a href="GtkEntry.html#gtk-entry-set-has-frame">gtk_entry_set_has_frame</a> (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
130
void <a href="GtkEntry.html#gtk-entry-set-inner-border">gtk_entry_set_inner_border</a> (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
131
const <a href="GtkStyle.html#GtkBorder">GtkBorder</a> *border);
132
void <a href="GtkEntry.html#gtk-entry-set-width-chars">gtk_entry_set_width_chars</a> (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
134
gunichar <a href="GtkEntry.html#gtk-entry-get-invisible-char">gtk_entry_get_invisible_char</a> (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry);
135
void <a href="GtkEntry.html#gtk-entry-set-alignment">gtk_entry_set_alignment</a> (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
137
gfloat <a href="GtkEntry.html#gtk-entry-get-alignment">gtk_entry_get_alignment</a> (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry);
138
PangoLayout* <a href="GtkEntry.html#gtk-entry-get-layout">gtk_entry_get_layout</a> (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry);
139
void <a href="GtkEntry.html#gtk-entry-get-layout-offsets">gtk_entry_get_layout_offsets</a> (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
142
gint <a href="GtkEntry.html#gtk-entry-layout-index-to-text-index">gtk_entry_layout_index_to_text_index</a>
143
(<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
145
gint <a href="GtkEntry.html#gtk-entry-text-index-to-layout-index">gtk_entry_text_index_to_layout_index</a>
146
(<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
148
gint <a href="GtkEntry.html#gtk-entry-get-max-length">gtk_entry_get_max_length</a> (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry);
149
gboolean <a href="GtkEntry.html#gtk-entry-get-visibility">gtk_entry_get_visibility</a> (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry);
150
void <a href="GtkEntry.html#gtk-entry-set-completion">gtk_entry_set_completion</a> (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
151
<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion);
152
<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a>* <a href="GtkEntry.html#gtk-entry-get-completion">gtk_entry_get_completion</a> (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry);
157
<div class="refsect1" lang="en">
158
<a name="id2992656"></a><h2>Object Hierarchy</h2>
159
<pre class="synopsis">
162
+----GInitiallyUnowned
163
+----<a href="GtkObject.html" title="GtkObject">GtkObject</a>
164
+----<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
166
+----<a href="GtkSpinButton.html" title="GtkSpinButton">GtkSpinButton</a>
169
<div class="refsect1" lang="en">
170
<a name="id2992710"></a><h2>Implemented Interfaces</h2>
173
AtkImplementorIface, <a href="GtkCellEditable.html" title="GtkCellEditable">GtkCellEditable</a> and <a href="GtkEditable.html" title="GtkEditable">GtkEditable</a>.</p>
175
<div class="refsect1" lang="en">
176
<a name="id2992747"></a><h2>Properties</h2>
177
<pre class="synopsis">
179
"<a href="GtkEntry.html#GtkEntry--activates-default">activates-default</a>" gboolean : Read / Write
180
"<a href="GtkEntry.html#GtkEntry--cursor-position">cursor-position</a>" gint : Read
181
"<a href="GtkEntry.html#GtkEntry--editable">editable</a>" gboolean : Read / Write
182
"<a href="GtkEntry.html#GtkEntry--has-frame">has-frame</a>" gboolean : Read / Write
183
"<a href="GtkEntry.html#GtkEntry--inner-border">inner-border</a>" <a href="GtkStyle.html#GtkBorder">GtkBorder</a> : Read / Write
184
"<a href="GtkEntry.html#GtkEntry--invisible-char">invisible-char</a>" guint : Read / Write
185
"<a href="GtkEntry.html#GtkEntry--max-length">max-length</a>" gint : Read / Write
186
"<a href="GtkEntry.html#GtkEntry--scroll-offset">scroll-offset</a>" gint : Read
187
"<a href="GtkEntry.html#GtkEntry--selection-bound">selection-bound</a>" gint : Read
188
"<a href="GtkEntry.html#GtkEntry--text">text</a>" gchararray : Read / Write
189
"<a href="GtkEntry.html#GtkEntry--truncate-multiline">truncate-multiline</a>" gboolean : Read / Write
190
"<a href="GtkEntry.html#GtkEntry--visibility">visibility</a>" gboolean : Read / Write
191
"<a href="GtkEntry.html#GtkEntry--width-chars">width-chars</a>" gint : Read / Write
192
"<a href="GtkEntry.html#GtkEntry--xalign">xalign</a>" gfloat : Read / Write
195
<div class="refsect1" lang="en">
196
<a name="id2992999"></a><h2>Style Properties</h2>
197
<pre class="synopsis">
199
"<a href="GtkEntry.html#GtkEntry--inner-border">inner-border</a>" <a href="GtkStyle.html#GtkBorder">GtkBorder</a> : Read
202
<div class="refsect1" lang="en">
203
<a name="id2993032"></a><h2>Signals</h2>
204
<pre class="synopsis">
206
"<a href="GtkEntry.html#GtkEntry-activate">activate</a>" : Run Last / Action
207
"<a href="GtkEntry.html#GtkEntry-backspace">backspace</a>" : Run Last / Action
208
"<a href="GtkEntry.html#GtkEntry-copy-clipboard">copy-clipboard</a>" : Run Last / Action
209
"<a href="GtkEntry.html#GtkEntry-cut-clipboard">cut-clipboard</a>" : Run Last / Action
210
"<a href="GtkEntry.html#GtkEntry-delete-from-cursor">delete-from-cursor</a>" : Run Last / Action
211
"<a href="GtkEntry.html#GtkEntry-insert-at-cursor">insert-at-cursor</a>" : Run Last / Action
212
"<a href="GtkEntry.html#GtkEntry-move-cursor">move-cursor</a>" : Run Last / Action
213
"<a href="GtkEntry.html#GtkEntry-paste-clipboard">paste-clipboard</a>" : Run Last / Action
214
"<a href="GtkEntry.html#GtkEntry-populate-popup">populate-popup</a>" : Run Last
215
"<a href="GtkEntry.html#GtkEntry-toggle-overwrite">toggle-overwrite</a>" : Run Last / Action
218
<div class="refsect1" lang="en">
219
<a name="id2993154"></a><h2>Description</h2>
221
The <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a> widget is a single line text entry
222
widget. A fairly large set of key bindings are supported
223
by default. If the entered text is longer than the allocation
224
of the widget, the widget will scroll so that the cursor
228
<div class="refsect1" lang="en">
229
<a name="id2993180"></a><h2>Details</h2>
230
<div class="refsect2" lang="en">
231
<a name="id2993191"></a><h3>
232
<a name="GtkEntry-struct"></a>GtkEntry</h3>
233
<a class="indexterm" name="id2993203"></a><pre class="programlisting">typedef struct _GtkEntry GtkEntry;</pre>
235
The <a href="GtkEntry.html#GtkEntry-struct"><span class="type">GtkEntry</span></a> struct contains only private data.
239
<div class="refsect2" lang="en">
240
<a name="id2993227"></a><h3>
241
<a name="gtk-entry-new"></a>gtk_entry_new ()</h3>
242
<a class="indexterm" name="id2993239"></a><pre class="programlisting"><a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* gtk_entry_new (void);</pre>
244
Creates a new entry.</p>
248
<div class="variablelist"><table border="0">
249
<col align="left" valign="top">
251
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
252
<td> a new <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a>.
258
<div class="refsect2" lang="en">
259
<a name="id2993287"></a><h3>
260
<a name="gtk-entry-new-with-max-length"></a>gtk_entry_new_with_max_length ()</h3>
261
<a class="indexterm" name="id2993302"></a><pre class="programlisting"><a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* gtk_entry_new_with_max_length (gint max);</pre>
262
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
263
<h3 class="title">Warning</h3>
264
<p><code class="literal">gtk_entry_new_with_max_length</code> is deprecated and should not be used in newly-written code.</p>
267
Creates a new <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a> widget with the given maximum length.
270
Note: the existence of this function is inconsistent
271
with the rest of the GTK+ API. The normal setup would
272
be to just require the user to make an extra call
273
to <a href="GtkEntry.html#gtk-entry-set-max-length"><code class="function">gtk_entry_set_max_length()</code></a> instead. It is not
274
expected that this function will be removed, but
275
it would be better practice not to use it.</p>
278
<div class="variablelist"><table border="0">
279
<col align="left" valign="top">
282
<td><span class="term"><em class="parameter"><code>max</code></em> :</span></td>
283
<td> the maximum length of the entry, or 0 for no maximum.
284
(other than the maximum length of entries.) The value passed in will
285
be clamped to the range 0-65536.
289
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
290
<td> a new <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a>.
297
<div class="refsect2" lang="en">
298
<a name="id2993413"></a><h3>
299
<a name="gtk-entry-set-text"></a>gtk_entry_set_text ()</h3>
300
<a class="indexterm" name="id2993427"></a><pre class="programlisting">void gtk_entry_set_text (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
301
const gchar *text);</pre>
303
Sets the text in the widget to the given
304
value, replacing the current contents.
306
<div class="variablelist"><table border="0">
307
<col align="left" valign="top">
310
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
311
<td>a <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a>.
315
<td><span class="term"><em class="parameter"><code>text</code></em> :</span></td>
325
<div class="refsect2" lang="en">
326
<a name="id2993504"></a><h3>
327
<a name="gtk-entry-append-text"></a>gtk_entry_append_text ()</h3>
328
<a class="indexterm" name="id2993519"></a><pre class="programlisting">void gtk_entry_append_text (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
329
const gchar *text);</pre>
330
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
331
<h3 class="title">Warning</h3>
332
<p><code class="literal">gtk_entry_append_text</code> is deprecated and should not be used in newly-written code.</p>
335
Appends the given text to the contents of the widget.
337
<div class="variablelist"><table border="0">
338
<col align="left" valign="top">
341
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
342
<td>a <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a>.
346
<td><span class="term"><em class="parameter"><code>text</code></em> :</span></td>
347
<td>the text to append.
356
<div class="refsect2" lang="en">
357
<a name="id2993608"></a><h3>
358
<a name="gtk-entry-prepend-text"></a>gtk_entry_prepend_text ()</h3>
359
<a class="indexterm" name="id2993624"></a><pre class="programlisting">void gtk_entry_prepend_text (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
360
const gchar *text);</pre>
361
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
362
<h3 class="title">Warning</h3>
363
<p><code class="literal">gtk_entry_prepend_text</code> is deprecated and should not be used in newly-written code.</p>
366
Prepends the given text to the contents of th ewidget.
368
<div class="variablelist"><table border="0">
369
<col align="left" valign="top">
372
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
373
<td>a <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a>.
377
<td><span class="term"><em class="parameter"><code>text</code></em> :</span></td>
378
<td>the text to prepend.
387
<div class="refsect2" lang="en">
388
<a name="id2993714"></a><h3>
389
<a name="gtk-entry-set-position"></a>gtk_entry_set_position ()</h3>
390
<a class="indexterm" name="id2993729"></a><pre class="programlisting">void gtk_entry_set_position (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
391
gint position);</pre>
392
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
393
<h3 class="title">Warning</h3>
394
<p><code class="literal">gtk_entry_set_position</code> is deprecated and should not be used in newly-written code.</p>
397
Sets the cursor position in an entry to the given
398
value. This function is obsolete. You should use
399
<a href="GtkEditable.html#gtk-editable-set-position"><code class="function">gtk_editable_set_position()</code></a> instead.
401
<div class="variablelist"><table border="0">
402
<col align="left" valign="top">
405
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
406
<td>a <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a>.
410
<td><span class="term"><em class="parameter"><code>position</code></em> :</span></td>
411
<td>the position of the cursor. The cursor is displayed
412
before the character with the given (base 0) index
413
in the widget. The value must be less than or
414
equal to the number of characters in the widget.
415
A value of -1 indicates that the position should
416
be set after the last character in the entry.
417
Note that this position is in characters, not in
427
<div class="refsect2" lang="en">
428
<a name="id2993838"></a><h3>
429
<a name="gtk-entry-get-text"></a>gtk_entry_get_text ()</h3>
430
<a class="indexterm" name="id2993851"></a><pre class="programlisting">const gchar* gtk_entry_get_text (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry);</pre>
432
Retrieves the contents of the entry widget.
433
See also <a href="GtkEditable.html#gtk-editable-get-chars"><code class="function">gtk_editable_get_chars()</code></a>.</p>
437
<div class="variablelist"><table border="0">
438
<col align="left" valign="top">
441
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
442
<td> a <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a>
446
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
447
<td> a pointer to the contents of the widget as a
448
string. This string points to internally allocated
449
storage in the widget and must not be freed, modified or
457
<div class="refsect2" lang="en">
458
<a name="id2993936"></a><h3>
459
<a name="gtk-entry-select-region"></a>gtk_entry_select_region ()</h3>
460
<a class="indexterm" name="id2993951"></a><pre class="programlisting">void gtk_entry_select_region (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
463
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
464
<h3 class="title">Warning</h3>
465
<p><code class="literal">gtk_entry_select_region</code> is deprecated and should not be used in newly-written code.</p>
468
Selects a region of text. The characters that
469
are selected are those characters at positions from
470
<em class="parameter"><code>start_pos</code></em> up to, but not including <em class="parameter"><code>end_pos</code></em>. If
471
<em class="parameter"><code>end_pos</code></em> is negative, then the the characters selected
472
will be those characters from <em class="parameter"><code>start_pos</code></em> to the end
473
of the text. This function is obsolete. You should
474
use <a href="GtkEditable.html#gtk-editable-select-region"><code class="function">gtk_editable_select_region()</code></a> instead.
476
<div class="variablelist"><table border="0">
477
<col align="left" valign="top">
480
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
481
<td>a <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a>.
485
<td><span class="term"><em class="parameter"><code>start</code></em> :</span></td>
486
<td>the starting position.
490
<td><span class="term"><em class="parameter"><code>end</code></em> :</span></td>
491
<td>the end position.
500
<div class="refsect2" lang="en">
501
<a name="id2994101"></a><h3>
502
<a name="gtk-entry-set-visibility"></a>gtk_entry_set_visibility ()</h3>
503
<a class="indexterm" name="id2994115"></a><pre class="programlisting">void gtk_entry_set_visibility (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
504
gboolean visible);</pre>
506
Sets whether the contents of the entry are visible or
507
not. When visibility is set to <code class="literal">FALSE</code>, characters
508
are displayed as the invisible char, and will also appear
509
that way when the text in the entry widget is copied
513
The default invisible char is the asterisk '*', but it can
514
be changed with <a href="GtkEntry.html#gtk-entry-set-invisible-char"><code class="function">gtk_entry_set_invisible_char()</code></a>.
516
<div class="variablelist"><table border="0">
517
<col align="left" valign="top">
520
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
521
<td>a <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a>.
525
<td><span class="term"><em class="parameter"><code>visible</code></em> :</span></td>
527
<code class="literal">TRUE</code> if the contents of the entry are displayed
537
<div class="refsect2" lang="en">
538
<a name="id2994230"></a><h3>
539
<a name="gtk-entry-set-invisible-char"></a>gtk_entry_set_invisible_char ()</h3>
540
<a class="indexterm" name="id2994244"></a><pre class="programlisting">void gtk_entry_set_invisible_char (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
543
Sets the character to use in place of the actual text when
544
<a href="GtkEntry.html#gtk-entry-set-visibility"><code class="function">gtk_entry_set_visibility()</code></a> has been called to set text visibility
545
to <code class="literal">FALSE</code>. i.e. this is the character used in "password mode" to
546
show the user how many characters have been typed. The default
547
invisible char is an asterisk ('*'). If you set the invisible char
548
to 0, then the user will get no feedback at all; there will be
549
no text on the screen as they type.</p>
553
<div class="variablelist"><table border="0">
554
<col align="left" valign="top">
557
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
558
<td> a <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a>
562
<td><span class="term"><em class="parameter"><code>ch</code></em> :</span></td>
563
<td> a Unicode character
570
<div class="refsect2" lang="en">
571
<a name="id2994351"></a><h3>
572
<a name="gtk-entry-set-editable"></a>gtk_entry_set_editable ()</h3>
573
<a class="indexterm" name="id2994366"></a><pre class="programlisting">void gtk_entry_set_editable (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
574
gboolean editable);</pre>
575
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
576
<h3 class="title">Warning</h3>
577
<p><code class="literal">gtk_entry_set_editable</code> is deprecated and should not be used in newly-written code.</p>
580
Determines if the user can edit the text in the editable
581
widget or not. This function is obsolete. You should
582
use <a href="GtkEditable.html#gtk-editable-set-editable"><code class="function">gtk_editable_set_editable()</code></a> instead.
584
<div class="variablelist"><table border="0">
585
<col align="left" valign="top">
588
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
589
<td>a <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a>.
593
<td><span class="term"><em class="parameter"><code>editable</code></em> :</span></td>
595
<code class="literal">TRUE</code> if the user is allowed to edit the text
605
<div class="refsect2" lang="en">
606
<a name="id2994479"></a><h3>
607
<a name="gtk-entry-set-max-length"></a>gtk_entry_set_max_length ()</h3>
608
<a class="indexterm" name="id2994491"></a><pre class="programlisting">void gtk_entry_set_max_length (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
611
Sets the maximum allowed length of the contents of the widget. If
612
the current contents are longer than the given length, then they
613
will be truncated to fit.</p>
616
<div class="variablelist"><table border="0">
617
<col align="left" valign="top">
620
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
621
<td> a <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a>.
625
<td><span class="term"><em class="parameter"><code>max</code></em> :</span></td>
626
<td> the maximum length of the entry, or 0 for no maximum.
627
(other than the maximum length of entries.) The value passed in will
628
be clamped to the range 0-65536.
635
<div class="refsect2" lang="en">
636
<a name="id2994575"></a><h3>
637
<a name="gtk-entry-get-activates-default"></a>gtk_entry_get_activates_default ()</h3>
638
<a class="indexterm" name="id2994588"></a><pre class="programlisting">gboolean gtk_entry_get_activates_default (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry);</pre>
640
Retrieves the value set by <a href="GtkEntry.html#gtk-entry-set-activates-default"><code class="function">gtk_entry_set_activates_default()</code></a>.</p>
644
<div class="variablelist"><table border="0">
645
<col align="left" valign="top">
648
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
649
<td> a <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a>
653
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
654
<td> <code class="literal">TRUE</code> if the entry will activate the default widget
661
<div class="refsect2" lang="en">
662
<a name="id2994679"></a><h3>
663
<a name="gtk-entry-get-has-frame"></a>gtk_entry_get_has_frame ()</h3>
664
<a class="indexterm" name="id2994692"></a><pre class="programlisting">gboolean gtk_entry_get_has_frame (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry);</pre>
666
Gets the value set by <a href="GtkEntry.html#gtk-entry-set-has-frame"><code class="function">gtk_entry_set_has_frame()</code></a>.</p>
670
<div class="variablelist"><table border="0">
671
<col align="left" valign="top">
674
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
675
<td> a <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a>
679
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
680
<td> whether the entry has a beveled frame
687
<div class="refsect2" lang="en">
688
<a name="id2994771"></a><h3>
689
<a name="gtk-entry-get-inner-border"></a>gtk_entry_get_inner_border ()</h3>
690
<a class="indexterm" name="id2994788"></a><pre class="programlisting">const <a href="GtkStyle.html#GtkBorder">GtkBorder</a>* gtk_entry_get_inner_border (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry);</pre>
692
This function returns the entry's inner-border property. See
693
<a href="GtkEntry.html#gtk-entry-set-inner-border"><code class="function">gtk_entry_set_inner_border()</code></a> for more information.</p>
697
<div class="variablelist"><table border="0">
698
<col align="left" valign="top">
701
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
702
<td> a <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a>
706
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
707
<td> the entry's <a href="GtkStyle.html#GtkBorder"><span class="type">GtkBorder</span></a>, or <a
708
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
709
><code class="literal">NULL</code></a> if none was set.
715
<p class="since">Since 2.10
719
<div class="refsect2" lang="en">
720
<a name="id2994894"></a><h3>
721
<a name="gtk-entry-get-width-chars"></a>gtk_entry_get_width_chars ()</h3>
722
<a class="indexterm" name="id2994908"></a><pre class="programlisting">gint gtk_entry_get_width_chars (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry);</pre>
724
Gets the value set by <a href="GtkEntry.html#gtk-entry-set-width-chars"><code class="function">gtk_entry_set_width_chars()</code></a>.</p>
728
<div class="variablelist"><table border="0">
729
<col align="left" valign="top">
732
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
733
<td> a <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a>
737
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
738
<td> number of chars to request space for, or negative if unset
745
<div class="refsect2" lang="en">
746
<a name="id2994987"></a><h3>
747
<a name="gtk-entry-set-activates-default"></a>gtk_entry_set_activates_default ()</h3>
748
<a class="indexterm" name="id2995001"></a><pre class="programlisting">void gtk_entry_set_activates_default (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
749
gboolean setting);</pre>
751
If <em class="parameter"><code>setting</code></em> is <code class="literal">TRUE</code>, pressing Enter in the <em class="parameter"><code>entry</code></em> will activate the default
752
widget for the window containing the entry. This usually means that
753
the dialog box containing the entry will be closed, since the default
754
widget is usually one of the dialog buttons.
757
(For experts: if <em class="parameter"><code>setting</code></em> is <code class="literal">TRUE</code>, the entry calls
758
<a href="GtkWindow.html#gtk-window-activate-default"><code class="function">gtk_window_activate_default()</code></a> on the window containing the entry, in
759
the default handler for the "activate" signal.)</p>
763
<div class="variablelist"><table border="0">
764
<col align="left" valign="top">
767
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
768
<td> a <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a>
772
<td><span class="term"><em class="parameter"><code>setting</code></em> :</span></td>
773
<td> <code class="literal">TRUE</code> to activate window's default widget on Enter keypress
780
<div class="refsect2" lang="en">
781
<a name="id2995150"></a><h3>
782
<a name="gtk-entry-set-has-frame"></a>gtk_entry_set_has_frame ()</h3>
783
<a class="indexterm" name="id2995162"></a><pre class="programlisting">void gtk_entry_set_has_frame (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
784
gboolean setting);</pre>
786
Sets whether the entry has a beveled frame around it.</p>
790
<div class="variablelist"><table border="0">
791
<col align="left" valign="top">
794
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
795
<td> a <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a>
799
<td><span class="term"><em class="parameter"><code>setting</code></em> :</span></td>
807
<div class="refsect2" lang="en">
808
<a name="id2995242"></a><h3>
809
<a name="gtk-entry-set-inner-border"></a>gtk_entry_set_inner_border ()</h3>
810
<a class="indexterm" name="id2995258"></a><pre class="programlisting">void gtk_entry_set_inner_border (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
811
const <a href="GtkStyle.html#GtkBorder">GtkBorder</a> *border);</pre>
813
Sets <code class="literal">entry</code>'s inner-border property to <code class="literal">border</code>, or clears it if <a
814
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
815
><code class="literal">NULL</code></a>
816
is passed. The inner-border is the area around the entry's text, but
820
If set, this property overrides the inner-border style property.
821
Overriding the style-provided border is useful when you want to do
822
in-place editing of some text in a canvas or list widget, where
823
pixel-exact positioning of the entry is important.</p>
827
<div class="variablelist"><table border="0">
828
<col align="left" valign="top">
831
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
832
<td> a <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a>
836
<td><span class="term"><em class="parameter"><code>border</code></em> :</span></td>
837
<td> a <a href="GtkStyle.html#GtkBorder"><span class="type">GtkBorder</span></a>, or <a
838
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
839
><code class="literal">NULL</code></a>
844
<p class="since">Since 2.10
848
<div class="refsect2" lang="en">
849
<a name="id2995404"></a><h3>
850
<a name="gtk-entry-set-width-chars"></a>gtk_entry_set_width_chars ()</h3>
851
<a class="indexterm" name="id2995418"></a><pre class="programlisting">void gtk_entry_set_width_chars (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
854
Changes the size request of the entry to be about the right size
855
for <em class="parameter"><code>n_chars</code></em> characters. Note that it changes the size
856
<span class="emphasis"><em>request</em></span>, the size can still be affected by
857
how you pack the widget into containers. If <em class="parameter"><code>n_chars</code></em> is -1, the
858
size reverts to the default entry size.</p>
862
<div class="variablelist"><table border="0">
863
<col align="left" valign="top">
866
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
867
<td> a <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a>
871
<td><span class="term"><em class="parameter"><code>n_chars</code></em> :</span></td>
879
<div class="refsect2" lang="en">
880
<a name="id2995516"></a><h3>
881
<a name="gtk-entry-get-invisible-char"></a>gtk_entry_get_invisible_char ()</h3>
882
<a class="indexterm" name="id2995529"></a><pre class="programlisting">gunichar gtk_entry_get_invisible_char (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry);</pre>
884
Retrieves the character displayed in place of the real characters
885
for entries with visisbility set to false. See <a href="GtkEntry.html#gtk-entry-set-invisible-char"><code class="function">gtk_entry_set_invisible_char()</code></a>.</p>
889
<div class="variablelist"><table border="0">
890
<col align="left" valign="top">
893
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
894
<td> a <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a>
898
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
899
<td> the current invisible char, or 0, if the entry does not
900
show invisible text at all.
907
<div class="refsect2" lang="en">
908
<a name="id2995611"></a><h3>
909
<a name="gtk-entry-set-alignment"></a>gtk_entry_set_alignment ()</h3>
910
<a class="indexterm" name="id2995627"></a><pre class="programlisting">void gtk_entry_set_alignment (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
911
gfloat xalign);</pre>
913
Sets the alignment for the contents of the entry. This controls
914
the horizontal positioning of the contents when the displayed
915
text is shorter than the width of the entry.</p>
919
<div class="variablelist"><table border="0">
920
<col align="left" valign="top">
923
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
924
<td> a <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a>
928
<td><span class="term"><em class="parameter"><code>xalign</code></em> :</span></td>
929
<td> The horizontal alignment, from 0 (left) to 1 (right).
930
Reversed for RTL layouts
935
<p class="since">Since 2.4
939
<div class="refsect2" lang="en">
940
<a name="id2995717"></a><h3>
941
<a name="gtk-entry-get-alignment"></a>gtk_entry_get_alignment ()</h3>
942
<a class="indexterm" name="id2995732"></a><pre class="programlisting">gfloat gtk_entry_get_alignment (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry);</pre>
944
Gets the value set by <a href="GtkEntry.html#gtk-entry-set-alignment"><code class="function">gtk_entry_set_alignment()</code></a>.</p>
948
<div class="variablelist"><table border="0">
949
<col align="left" valign="top">
952
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
953
<td> a <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a>
957
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
964
<p class="since">Since 2.4
968
<div class="refsect2" lang="en">
969
<a name="id2995817"></a><h3>
970
<a name="gtk-entry-get-layout"></a>gtk_entry_get_layout ()</h3>
971
<a class="indexterm" name="id2995830"></a><pre class="programlisting">PangoLayout* gtk_entry_get_layout (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry);</pre>
973
Gets the <span class="type">PangoLayout</span> used to display the entry.
974
The layout is useful to e.g. convert text positions to
975
pixel positions, in combination with <a href="GtkEntry.html#gtk-entry-get-layout-offsets"><code class="function">gtk_entry_get_layout_offsets()</code></a>.
976
The returned layout is owned by the entry and must not be
977
modified or freed by the caller.
980
Keep in mind that the layout text may contain a preedit string, so
981
<a href="GtkEntry.html#gtk-entry-layout-index-to-text-index"><code class="function">gtk_entry_layout_index_to_text_index()</code></a> and
982
<a href="GtkEntry.html#gtk-entry-text-index-to-layout-index"><code class="function">gtk_entry_text_index_to_layout_index()</code></a> are needed to convert byte
983
indices in the layout to byte indices in the entry contents.</p>
987
<div class="variablelist"><table border="0">
988
<col align="left" valign="top">
991
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
992
<td> a <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a>
996
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
997
<td> the <span class="type">PangoLayout</span> for this entry
1004
<div class="refsect2" lang="en">
1005
<a name="id2995958"></a><h3>
1006
<a name="gtk-entry-get-layout-offsets"></a>gtk_entry_get_layout_offsets ()</h3>
1007
<a class="indexterm" name="id2995972"></a><pre class="programlisting">void gtk_entry_get_layout_offsets (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
1011
Obtains the position of the <span class="type">PangoLayout</span> used to render text
1012
in the entry, in widget coordinates. Useful if you want to line
1013
up the text in an entry with some other text, e.g. when using the
1014
entry to implement editable cells in a sheet widget.
1017
Also useful to convert mouse events into coordinates inside the
1018
<span class="type">PangoLayout</span>, e.g. to take some action if some part of the entry text
1022
Note that as the user scrolls around in the entry the offsets will
1023
change; you'll need to connect to the "notify::scroll-offset"
1024
signal to track this. Remember when using the <span class="type">PangoLayout</span>
1025
functions you need to convert to and from pixels using
1026
<code class="function">PANGO_PIXELS()</code> or <span class="type">PANGO_SCALE</span>.
1029
Keep in mind that the layout text may contain a preedit string, so
1030
<a href="GtkEntry.html#gtk-entry-layout-index-to-text-index"><code class="function">gtk_entry_layout_index_to_text_index()</code></a> and
1031
<a href="GtkEntry.html#gtk-entry-text-index-to-layout-index"><code class="function">gtk_entry_text_index_to_layout_index()</code></a> are needed to convert byte
1032
indices in the layout to byte indices in the entry contents.</p>
1036
<div class="variablelist"><table border="0">
1037
<col align="left" valign="top">
1040
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
1041
<td> a <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a>
1045
<td><span class="term"><em class="parameter"><code>x</code></em> :</span></td>
1046
<td> location to store X offset of layout, or <a
1047
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
1048
><code class="literal">NULL</code></a>
1052
<td><span class="term"><em class="parameter"><code>y</code></em> :</span></td>
1053
<td> location to store Y offset of layout, or <a
1054
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
1055
><code class="literal">NULL</code></a>
1062
<div class="refsect2" lang="en">
1063
<a name="id2996182"></a><h3>
1064
<a name="gtk-entry-layout-index-to-text-index"></a>gtk_entry_layout_index_to_text_index ()</h3>
1065
<a class="indexterm" name="id2996196"></a><pre class="programlisting">gint gtk_entry_layout_index_to_text_index
1066
(<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
1067
gint layout_index);</pre>
1069
Converts from a position in the entry contents (returned
1070
by <a href="GtkEntry.html#gtk-entry-get-text"><code class="function">gtk_entry_get_text()</code></a>) to a position in the
1071
entry's <span class="type">PangoLayout</span> (returned by <a href="GtkEntry.html#gtk-entry-get-layout"><code class="function">gtk_entry_get_layout()</code></a>,
1072
with text retrieved via <code class="function">pango_layout_get_text()</code>).</p>
1076
<div class="variablelist"><table border="0">
1077
<col align="left" valign="top">
1080
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
1081
<td> a <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a>
1085
<td><span class="term"><em class="parameter"><code>layout_index</code></em> :</span></td>
1086
<td> byte index into the entry layout text
1090
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
1091
<td> byte index into the entry contents
1098
<div class="refsect2" lang="en">
1099
<a name="id2996332"></a><h3>
1100
<a name="gtk-entry-text-index-to-layout-index"></a>gtk_entry_text_index_to_layout_index ()</h3>
1101
<a class="indexterm" name="id2996346"></a><pre class="programlisting">gint gtk_entry_text_index_to_layout_index
1102
(<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
1103
gint text_index);</pre>
1105
Converts from a position in the entry's <span class="type">PangoLayout</span> (returned by
1106
<a href="GtkEntry.html#gtk-entry-get-layout"><code class="function">gtk_entry_get_layout()</code></a>) to a position in the entry contents
1107
(returned by <a href="GtkEntry.html#gtk-entry-get-text"><code class="function">gtk_entry_get_text()</code></a>).</p>
1111
<div class="variablelist"><table border="0">
1112
<col align="left" valign="top">
1115
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
1116
<td> a <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a>
1120
<td><span class="term"><em class="parameter"><code>text_index</code></em> :</span></td>
1121
<td> byte index into the entry contents
1125
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
1126
<td> byte index into the entry layout text
1133
<div class="refsect2" lang="en">
1134
<a name="id2996468"></a><h3>
1135
<a name="gtk-entry-get-max-length"></a>gtk_entry_get_max_length ()</h3>
1136
<a class="indexterm" name="id2996482"></a><pre class="programlisting">gint gtk_entry_get_max_length (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry);</pre>
1138
Retrieves the maximum allowed length of the text in
1139
<em class="parameter"><code>entry</code></em>. See <a href="GtkEntry.html#gtk-entry-set-max-length"><code class="function">gtk_entry_set_max_length()</code></a>.</p>
1143
<div class="variablelist"><table border="0">
1144
<col align="left" valign="top">
1147
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
1148
<td> a <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a>
1152
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
1153
<td> the maximum allowed number of characters
1154
in <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a>, or 0 if there is no maximum.
1161
<div class="refsect2" lang="en">
1162
<a name="id2996576"></a><h3>
1163
<a name="gtk-entry-get-visibility"></a>gtk_entry_get_visibility ()</h3>
1164
<a class="indexterm" name="id2996590"></a><pre class="programlisting">gboolean gtk_entry_get_visibility (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry);</pre>
1166
Retrieves whether the text in <em class="parameter"><code>entry</code></em> is visible. See
1167
<a href="GtkEntry.html#gtk-entry-set-visibility"><code class="function">gtk_entry_set_visibility()</code></a>.</p>
1171
<div class="variablelist"><table border="0">
1172
<col align="left" valign="top">
1175
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
1176
<td> a <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a>
1180
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
1181
<td> <code class="literal">TRUE</code> if the text is currently visible
1188
<div class="refsect2" lang="en">
1189
<a name="id2996685"></a><h3>
1190
<a name="gtk-entry-set-completion"></a>gtk_entry_set_completion ()</h3>
1191
<a class="indexterm" name="id2996700"></a><pre class="programlisting">void gtk_entry_set_completion (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
1192
<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion);</pre>
1194
Sets <em class="parameter"><code>completion</code></em> to be the auxiliary completion object to use with <em class="parameter"><code>entry</code></em>.
1195
All further configuration of the completion mechanism is done on
1196
<em class="parameter"><code>completion</code></em> using the <a href="GtkEntryCompletion.html" title="GtkEntryCompletion"><span class="type">GtkEntryCompletion</span></a> API. Completion is disabled if
1197
<em class="parameter"><code>completion</code></em> is set to <a
1198
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
1199
><code class="literal">NULL</code></a>.</p>
1203
<div class="variablelist"><table border="0">
1204
<col align="left" valign="top">
1207
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
1208
<td> A <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a>.
1212
<td><span class="term"><em class="parameter"><code>completion</code></em> :</span></td>
1213
<td> The <a href="GtkEntryCompletion.html" title="GtkEntryCompletion"><span class="type">GtkEntryCompletion</span></a> or <a
1214
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
1215
><code class="literal">NULL</code></a>.
1220
<p class="since">Since 2.4
1224
<div class="refsect2" lang="en">
1225
<a name="id2996849"></a><h3>
1226
<a name="gtk-entry-get-completion"></a>gtk_entry_get_completion ()</h3>
1227
<a class="indexterm" name="id2996865"></a><pre class="programlisting"><a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a>* gtk_entry_get_completion (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry);</pre>
1229
Returns the auxiliary completion object currently in use by <em class="parameter"><code>entry</code></em>.</p>
1233
<div class="variablelist"><table border="0">
1234
<col align="left" valign="top">
1237
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
1238
<td> A <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a>.
1242
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
1243
<td> The auxiliary completion object currently in use by <em class="parameter"><code>entry</code></em>.
1249
<p class="since">Since 2.4
1253
<div class="refsect1" lang="en">
1254
<a name="id2996954"></a><h2>Property Details</h2>
1255
<div class="refsect2" lang="en">
1256
<a name="id2996965"></a><h3>
1257
<a name="GtkEntry--activates-default"></a>The "<code class="literal">activates-default</code>" property</h3>
1258
<a class="indexterm" name="id2996981"></a><pre class="programlisting"> "activates-default" gboolean : Read / Write</pre>
1259
<p>Whether to activate the default widget (such as the default button in a dialog) when Enter is pressed.</p>
1260
<p>Default value: FALSE</p>
1263
<div class="refsect2" lang="en">
1264
<a name="id2997009"></a><h3>
1265
<a name="GtkEntry--cursor-position"></a>The "<code class="literal">cursor-position</code>" property</h3>
1266
<a class="indexterm" name="id2997026"></a><pre class="programlisting"> "cursor-position" gint : Read</pre>
1267
<p>The current position of the insertion cursor in chars.</p>
1268
<p>Allowed values: [0,65535]</p>
1269
<p>Default value: 0</p>
1272
<div class="refsect2" lang="en">
1273
<a name="id2997056"></a><h3>
1274
<a name="GtkEntry--editable"></a>The "<code class="literal">editable</code>" property</h3>
1275
<a class="indexterm" name="id2997072"></a><pre class="programlisting"> "editable" gboolean : Read / Write</pre>
1276
<p>Whether the entry contents can be edited.</p>
1277
<p>Default value: TRUE</p>
1280
<div class="refsect2" lang="en">
1281
<a name="id2997099"></a><h3>
1282
<a name="GtkEntry--has-frame"></a>The "<code class="literal">has-frame</code>" property</h3>
1283
<a class="indexterm" name="id2997114"></a><pre class="programlisting"> "has-frame" gboolean : Read / Write</pre>
1284
<p>FALSE removes outside bevel from entry.</p>
1285
<p>Default value: TRUE</p>
1288
<div class="refsect2" lang="en">
1289
<a name="id2997141"></a><h3>
1290
<a name="GtkEntry--inner-border"></a>The "<code class="literal">inner-border</code>" property</h3>
1291
<a class="indexterm" name="id2997157"></a><pre class="programlisting"> "inner-border" <a href="GtkStyle.html#GtkBorder">GtkBorder</a> : Read / Write</pre>
1293
Sets the text area's border between the text and the frame</p>
1301
<div class="refsect2" lang="en">
1302
<a name="id2997189"></a><h3>
1303
<a name="GtkEntry--invisible-char"></a>The "<code class="literal">invisible-char</code>" property</h3>
1304
<a class="indexterm" name="id2997206"></a><pre class="programlisting"> "invisible-char" guint : Read / Write</pre>
1305
<p>The character to use when masking entry contents (in "password mode").</p>
1306
<p>Default value: '*'</p>
1309
<div class="refsect2" lang="en">
1310
<a name="id2997233"></a><h3>
1311
<a name="GtkEntry--max-length"></a>The "<code class="literal">max-length</code>" property</h3>
1312
<a class="indexterm" name="id2997250"></a><pre class="programlisting"> "max-length" gint : Read / Write</pre>
1313
<p>Maximum number of characters for this entry. Zero if no maximum.</p>
1314
<p>Allowed values: [0,65535]</p>
1315
<p>Default value: 0</p>
1318
<div class="refsect2" lang="en">
1319
<a name="id2997281"></a><h3>
1320
<a name="GtkEntry--scroll-offset"></a>The "<code class="literal">scroll-offset</code>" property</h3>
1321
<a class="indexterm" name="id2997297"></a><pre class="programlisting"> "scroll-offset" gint : Read</pre>
1322
<p>Number of pixels of the entry scrolled off the screen to the left.</p>
1323
<p>Allowed values: >= 0</p>
1324
<p>Default value: 0</p>
1327
<div class="refsect2" lang="en">
1328
<a name="id2997328"></a><h3>
1329
<a name="GtkEntry--selection-bound"></a>The "<code class="literal">selection-bound</code>" property</h3>
1330
<a class="indexterm" name="id2997344"></a><pre class="programlisting"> "selection-bound" gint : Read</pre>
1331
<p>The position of the opposite end of the selection from the cursor in chars.</p>
1332
<p>Allowed values: [0,65535]</p>
1333
<p>Default value: 0</p>
1336
<div class="refsect2" lang="en">
1337
<a name="id2997375"></a><h3>
1338
<a name="GtkEntry--text"></a>The "<code class="literal">text</code>" property</h3>
1339
<a class="indexterm" name="id2997390"></a><pre class="programlisting"> "text" gchararray : Read / Write</pre>
1340
<p>The contents of the entry.</p>
1341
<p>Default value: ""</p>
1344
<div class="refsect2" lang="en">
1345
<a name="id2997418"></a><h3>
1346
<a name="GtkEntry--truncate-multiline"></a>The "<code class="literal">truncate-multiline</code>" property</h3>
1347
<a class="indexterm" name="id2997434"></a><pre class="programlisting"> "truncate-multiline" gboolean : Read / Write</pre>
1349
When <code class="literal">TRUE</code>, pasted multi-line text is truncated to the first line.</p>
1353
<p>Default value: FALSE</p>
1358
<div class="refsect2" lang="en">
1359
<a name="id2997481"></a><h3>
1360
<a name="GtkEntry--visibility"></a>The "<code class="literal">visibility</code>" property</h3>
1361
<a class="indexterm" name="id2997497"></a><pre class="programlisting"> "visibility" gboolean : Read / Write</pre>
1362
<p>FALSE displays the "invisible char" instead of the actual text (password mode).</p>
1363
<p>Default value: TRUE</p>
1366
<div class="refsect2" lang="en">
1367
<a name="id2997524"></a><h3>
1368
<a name="GtkEntry--width-chars"></a>The "<code class="literal">width-chars</code>" property</h3>
1369
<a class="indexterm" name="id2997540"></a><pre class="programlisting"> "width-chars" gint : Read / Write</pre>
1370
<p>Number of characters to leave space for in the entry.</p>
1371
<p>Allowed values: >= -1</p>
1372
<p>Default value: -1</p>
1375
<div class="refsect2" lang="en">
1376
<a name="id2997571"></a><h3>
1377
<a name="GtkEntry--xalign"></a>The "<code class="literal">xalign</code>" property</h3>
1378
<a class="indexterm" name="id2997587"></a><pre class="programlisting"> "xalign" gfloat : Read / Write</pre>
1380
The horizontal alignment, from 0 (left) to 1 (right).
1381
Reversed for RTL layouts.</p>
1386
Creates a new <a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a> widget.
1388
<p>Allowed values: [0,1]</p>
1389
<p>Default value: 0</p>
1394
<div class="refsect1" lang="en">
1395
<a name="id2997641"></a><h2>Style Property Details</h2>
1396
<div class="refsect2" lang="en">
1397
<a name="id2997652"></a><h3>
1398
<a name="GtkEntry--inner-border"></a>The "<code class="literal">inner-border</code>" style property</h3>
1399
<a class="indexterm" name="id2997668"></a><pre class="programlisting"> "inner-border" <a href="GtkStyle.html#GtkBorder">GtkBorder</a> : Read</pre>
1401
Sets the text area's border between the text and the frame</p>
1409
<div class="refsect1" lang="en">
1410
<a name="id2997702"></a><h2>Signal Details</h2>
1411
<div class="refsect2" lang="en">
1412
<a name="id2997712"></a><h3>
1413
<a name="GtkEntry-activate"></a>The "activate" signal</h3>
1414
<a class="indexterm" name="id2997721"></a><pre class="programlisting">void user_function (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
1415
gpointer user_data) : Run Last / Action</pre>
1419
<div class="variablelist"><table border="0">
1420
<col align="left" valign="top">
1423
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
1424
<td>the object which received the signal.
1429
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
1430
<td>user data set when the signal handler was connected.</td>
1436
<div class="refsect2" lang="en">
1437
<a name="id2997790"></a><h3>
1438
<a name="GtkEntry-backspace"></a>The "backspace" signal</h3>
1439
<a class="indexterm" name="id2997800"></a><pre class="programlisting">void user_function (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
1440
gpointer user_data) : Run Last / Action</pre>
1444
<div class="variablelist"><table border="0">
1445
<col align="left" valign="top">
1448
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
1449
<td>the object which received the signal.
1454
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
1455
<td>user data set when the signal handler was connected.</td>
1461
<div class="refsect2" lang="en">
1462
<a name="id2997868"></a><h3>
1463
<a name="GtkEntry-copy-clipboard"></a>The "copy-clipboard" signal</h3>
1464
<a class="indexterm" name="id2997879"></a><pre class="programlisting">void user_function (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
1465
gpointer user_data) : Run Last / Action</pre>
1469
<div class="variablelist"><table border="0">
1470
<col align="left" valign="top">
1473
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
1474
<td>the object which received the signal.
1479
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
1480
<td>user data set when the signal handler was connected.</td>
1486
<div class="refsect2" lang="en">
1487
<a name="id2997947"></a><h3>
1488
<a name="GtkEntry-cut-clipboard"></a>The "cut-clipboard" signal</h3>
1489
<a class="indexterm" name="id2997958"></a><pre class="programlisting">void user_function (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
1490
gpointer user_data) : Run Last / Action</pre>
1494
<div class="variablelist"><table border="0">
1495
<col align="left" valign="top">
1498
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
1499
<td>the object which received the signal.
1504
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
1505
<td>user data set when the signal handler was connected.</td>
1511
<div class="refsect2" lang="en">
1512
<a name="id2998027"></a><h3>
1513
<a name="GtkEntry-delete-from-cursor"></a>The "delete-from-cursor" signal</h3>
1514
<a class="indexterm" name="id2998037"></a><pre class="programlisting">void user_function (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
1515
<a href="gtk-Standard-Enumerations.html#GtkDeleteType">GtkDeleteType</a> arg1,
1517
gpointer user_data) : Run Last / Action</pre>
1521
<div class="variablelist"><table border="0">
1522
<col align="left" valign="top">
1525
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
1526
<td>the object which received the signal.
1530
<td><span class="term"><em class="parameter"><code>arg1</code></em> :</span></td>
1535
<td><span class="term"><em class="parameter"><code>arg2</code></em> :</span></td>
1541
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
1542
<td>user data set when the signal handler was connected.</td>
1548
<div class="refsect2" lang="en">
1549
<a name="id2998150"></a><h3>
1550
<a name="GtkEntry-insert-at-cursor"></a>The "insert-at-cursor" signal</h3>
1551
<a class="indexterm" name="id2998160"></a><pre class="programlisting">void user_function (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
1553
gpointer user_data) : Run Last / Action</pre>
1557
<div class="variablelist"><table border="0">
1558
<col align="left" valign="top">
1561
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
1562
<td>the object which received the signal.
1566
<td><span class="term"><em class="parameter"><code>arg1</code></em> :</span></td>
1572
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
1573
<td>user data set when the signal handler was connected.</td>
1579
<div class="refsect2" lang="en">
1580
<a name="id2998250"></a><h3>
1581
<a name="GtkEntry-move-cursor"></a>The "move-cursor" signal</h3>
1582
<a class="indexterm" name="id2998260"></a><pre class="programlisting">void user_function (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
1583
<a href="gtk-Standard-Enumerations.html#GtkMovementStep">GtkMovementStep</a> arg1,
1586
gpointer user_data) : Run Last / Action</pre>
1590
<div class="variablelist"><table border="0">
1591
<col align="left" valign="top">
1594
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
1595
<td>the object which received the signal.
1599
<td><span class="term"><em class="parameter"><code>arg1</code></em> :</span></td>
1604
<td><span class="term"><em class="parameter"><code>arg2</code></em> :</span></td>
1609
<td><span class="term"><em class="parameter"><code>arg3</code></em> :</span></td>
1615
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
1616
<td>user data set when the signal handler was connected.</td>
1622
<div class="refsect2" lang="en">
1623
<a name="id2998393"></a><h3>
1624
<a name="GtkEntry-paste-clipboard"></a>The "paste-clipboard" signal</h3>
1625
<a class="indexterm" name="id2998404"></a><pre class="programlisting">void user_function (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
1626
gpointer user_data) : Run Last / Action</pre>
1630
<div class="variablelist"><table border="0">
1631
<col align="left" valign="top">
1634
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
1635
<td>the object which received the signal.
1640
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
1641
<td>user data set when the signal handler was connected.</td>
1647
<div class="refsect2" lang="en">
1648
<a name="id2998473"></a><h3>
1649
<a name="GtkEntry-populate-popup"></a>The "populate-popup" signal</h3>
1650
<a class="indexterm" name="id2998483"></a><pre class="programlisting">void user_function (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
1651
<a href="GtkMenu.html" title="GtkMenu">GtkMenu</a> *arg1,
1652
gpointer user_data) : Run Last</pre>
1656
<div class="variablelist"><table border="0">
1657
<col align="left" valign="top">
1660
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
1661
<td>the object which received the signal.
1665
<td><span class="term"><em class="parameter"><code>arg1</code></em> :</span></td>
1671
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
1672
<td>user data set when the signal handler was connected.</td>
1678
<div class="refsect2" lang="en">
1679
<a name="id2998573"></a><h3>
1680
<a name="GtkEntry-toggle-overwrite"></a>The "toggle-overwrite" signal</h3>
1681
<a class="indexterm" name="id2998583"></a><pre class="programlisting">void user_function (<a href="GtkEntry.html" title="GtkEntry">GtkEntry</a> *entry,
1682
gpointer user_data) : Run Last / Action</pre>
1686
<div class="variablelist"><table border="0">
1687
<col align="left" valign="top">
1690
<td><span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
1691
<td>the object which received the signal.
1696
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
1697
<td>user data set when the signal handler was connected.</td>
1703
<div class="refsect1" lang="en">
1704
<a name="id2998654"></a><h2>See Also</h2>
1707
<div class="variablelist"><table border="0">
1708
<col align="left" valign="top">
1710
<td><span class="term"><a href="GtkTextView.html" title="GtkTextView"><span class="type">GtkTextView</span></a></span></td>
1711
<td><p>a widget for handling multi-line text entry.</p></td>
added
removed
docs/reference/gtk/html/GtkEntry.html
