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>GtkEntryCompletion</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="GtkEntry.html" title="GtkEntry">
10
<link rel="next" href="GtkHScale.html" title="GtkHScale">
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="GtkEntry.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="GtkHScale.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="#id3005299" class="shortcut">Top</a>
69
<a href="#id3006253" class="shortcut">Description</a>
71
<a href="#id3006017" class="shortcut">Object Hierarchy</a>
73
<a href="#id3006041" class="shortcut">Implemented Interfaces</a>
75
<a href="#id3006064" class="shortcut">Properties</a>
77
<a href="#id3006204" class="shortcut">Signals</a></nobr></td></tr>
79
<div class="refentry" lang="en">
80
<a name="GtkEntryCompletion"></a><div class="titlepage"></div>
81
<div class="refnamediv"><table width="100%"><tr>
84
<a name="id3005299"></a><span class="refentrytitle">GtkEntryCompletion</span>
86
<p>GtkEntryCompletion — Completion functionality for GtkEntry</p>
88
<td valign="top" align="right"></td>
90
<div class="refsynopsisdiv">
92
<pre class="synopsis">
94
#include <gtk/gtk.h>
97
<a href="GtkEntryCompletion.html#GtkEntryCompletion-struct">GtkEntryCompletion</a>;
98
gboolean (<a href="GtkEntryCompletion.html#GtkEntryCompletionMatchFunc">*GtkEntryCompletionMatchFunc</a>) (<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion,
100
<a href="GtkTreeModel.html#GtkTreeIter">GtkTreeIter</a> *iter,
102
<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a>* <a href="GtkEntryCompletion.html#gtk-entry-completion-new">gtk_entry_completion_new</a> (void);
103
<a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* <a href="GtkEntryCompletion.html#gtk-entry-completion-get-entry">gtk_entry_completion_get_entry</a> (<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion);
104
void <a href="GtkEntryCompletion.html#gtk-entry-completion-set-model">gtk_entry_completion_set_model</a> (<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion,
105
<a href="GtkTreeModel.html" title="GtkTreeModel">GtkTreeModel</a> *model);
106
<a href="GtkTreeModel.html" title="GtkTreeModel">GtkTreeModel</a>* <a href="GtkEntryCompletion.html#gtk-entry-completion-get-model">gtk_entry_completion_get_model</a> (<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion);
107
void <a href="GtkEntryCompletion.html#gtk-entry-completion-set-match-func">gtk_entry_completion_set_match_func</a> (<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion,
108
<a href="GtkEntryCompletion.html#GtkEntryCompletionMatchFunc">GtkEntryCompletionMatchFunc</a> func,
110
GDestroyNotify func_notify);
111
void <a href="GtkEntryCompletion.html#gtk-entry-completion-set-minimum-key-length">gtk_entry_completion_set_minimum_key_length</a>
112
(<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion,
114
gint <a href="GtkEntryCompletion.html#gtk-entry-completion-get-minimum-key-length">gtk_entry_completion_get_minimum_key_length</a>
115
(<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion);
116
void <a href="GtkEntryCompletion.html#gtk-entry-completion-complete">gtk_entry_completion_complete</a> (<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion);
117
void <a href="GtkEntryCompletion.html#gtk-entry-completion-insert-prefix">gtk_entry_completion_insert_prefix</a> (<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion);
118
void <a href="GtkEntryCompletion.html#gtk-entry-completion-insert-action-text">gtk_entry_completion_insert_action_text</a>
119
(<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion,
122
void <a href="GtkEntryCompletion.html#gtk-entry-completion-insert-action-markup">gtk_entry_completion_insert_action_markup</a>
123
(<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion,
125
const gchar *markup);
126
void <a href="GtkEntryCompletion.html#gtk-entry-completion-delete-action">gtk_entry_completion_delete_action</a> (<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion,
128
void <a href="GtkEntryCompletion.html#gtk-entry-completion-set-text-column">gtk_entry_completion_set_text_column</a>
129
(<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion,
131
gint <a href="GtkEntryCompletion.html#gtk-entry-completion-get-text-column">gtk_entry_completion_get_text_column</a>
132
(<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion);
133
void <a href="GtkEntryCompletion.html#gtk-entry-completion-set-inline-completion">gtk_entry_completion_set_inline_completion</a>
134
(<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion,
135
gboolean inline_completion);
136
gboolean <a href="GtkEntryCompletion.html#gtk-entry-completion-get-inline-completion">gtk_entry_completion_get_inline_completion</a>
137
(<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion);
138
void <a href="GtkEntryCompletion.html#gtk-entry-completion-set-popup-completion">gtk_entry_completion_set_popup_completion</a>
139
(<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion,
140
gboolean popup_completion);
141
gboolean <a href="GtkEntryCompletion.html#gtk-entry-completion-get-popup-completion">gtk_entry_completion_get_popup_completion</a>
142
(<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion);
143
void <a href="GtkEntryCompletion.html#gtk-entry-completion-set-popup-set-width">gtk_entry_completion_set_popup_set_width</a>
144
(<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion,
145
gboolean popup_set_width);
146
gboolean <a href="GtkEntryCompletion.html#gtk-entry-completion-get-popup-set-width">gtk_entry_completion_get_popup_set_width</a>
147
(<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion);
148
void <a href="GtkEntryCompletion.html#gtk-entry-completion-set-popup-single-match">gtk_entry_completion_set_popup_single_match</a>
149
(<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion,
150
gboolean popup_single_match);
151
gboolean <a href="GtkEntryCompletion.html#gtk-entry-completion-get-popup-single-match">gtk_entry_completion_get_popup_single_match</a>
152
(<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion);
157
<div class="refsect1" lang="en">
158
<a name="id3006017"></a><h2>Object Hierarchy</h2>
159
<pre class="synopsis">
162
+----GtkEntryCompletion
165
<div class="refsect1" lang="en">
166
<a name="id3006041"></a><h2>Implemented Interfaces</h2>
168
GtkEntryCompletion implements
169
<a href="GtkCellLayout.html" title="GtkCellLayout">GtkCellLayout</a>.</p>
171
<div class="refsect1" lang="en">
172
<a name="id3006064"></a><h2>Properties</h2>
173
<pre class="synopsis">
175
"<a href="GtkEntryCompletion.html#GtkEntryCompletion--inline-completion">inline-completion</a>" gboolean : Read / Write
176
"<a href="GtkEntryCompletion.html#GtkEntryCompletion--minimum-key-length">minimum-key-length</a>" gint : Read / Write
177
"<a href="GtkEntryCompletion.html#GtkEntryCompletion--model">model</a>" <a href="GtkTreeModel.html" title="GtkTreeModel">GtkTreeModel</a> : Read / Write
178
"<a href="GtkEntryCompletion.html#GtkEntryCompletion--popup-completion">popup-completion</a>" gboolean : Read / Write
179
"<a href="GtkEntryCompletion.html#GtkEntryCompletion--popup-set-width">popup-set-width</a>" gboolean : Read / Write
180
"<a href="GtkEntryCompletion.html#GtkEntryCompletion--popup-single-match">popup-single-match</a>" gboolean : Read / Write
181
"<a href="GtkEntryCompletion.html#GtkEntryCompletion--text-column">text-column</a>" gint : Read / Write
184
<div class="refsect1" lang="en">
185
<a name="id3006204"></a><h2>Signals</h2>
186
<pre class="synopsis">
188
"<a href="GtkEntryCompletion.html#GtkEntryCompletion-action-activated">action-activated</a>" : Run Last
189
"<a href="GtkEntryCompletion.html#GtkEntryCompletion-insert-prefix">insert-prefix</a>" : Run Last
190
"<a href="GtkEntryCompletion.html#GtkEntryCompletion-match-selected">match-selected</a>" : Run Last
193
<div class="refsect1" lang="en">
194
<a name="id3006253"></a><h2>Description</h2>
196
<a href="GtkEntryCompletion.html" title="GtkEntryCompletion"><span class="type">GtkEntryCompletion</span></a> is an auxiliary object to be used in conjunction with
197
<a href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a> to provide the completion functionality. It implements the
198
<a href="GtkCellLayout.html" title="GtkCellLayout"><span class="type">GtkCellLayout</span></a> interface, to allow the user to add extra cells to the
199
<a href="GtkTreeView.html" title="GtkTreeView"><span class="type">GtkTreeView</span></a> with completion matches.
202
"Completion functionality" means that when the user modifies the text
203
in the entry, <a href="GtkEntryCompletion.html" title="GtkEntryCompletion"><span class="type">GtkEntryCompletion</span></a> checks which rows in the model match
204
the current content of the entry, and displays a list of matches.
205
By default, the matching is done by comparing the entry text
206
case-insensitively against the text column of the model (see
207
<a href="GtkEntryCompletion.html#gtk-entry-completion-set-text-column"><code class="function">gtk_entry_completion_set_text_column()</code></a>), but this can be overridden with
208
a custom match function (see <a href="GtkEntryCompletion.html#gtk-entry-completion-set-match-func"><code class="function">gtk_entry_completion_set_match_func()</code></a>).
211
When the user selects a completion, the content of the entry is updated.
212
By default, the content of the entry is replaced by the text column of the
213
model, but this can be overridden by connecting to the ::match-selected signal
214
and updating the entry in the signal handler. Note that you should return
215
<code class="literal">TRUE</code> from the signal handler to suppress the default behaviour.
218
To add completion functionality to an entry, use <a href="GtkEntry.html#gtk-entry-set-completion"><code class="function">gtk_entry_set_completion()</code></a>.
221
In addition to regular completion matches, which will be inserted into the
222
entry when they are selected, <a href="GtkEntryCompletion.html" title="GtkEntryCompletion"><span class="type">GtkEntryCompletion</span></a> also allows to display
223
"actions" in the popup window. Their appearance is similar to menuitems,
224
to differentiate them clearly from completion strings. When an action is
225
selected, the ::action-activated signal is emitted.
228
<div class="refsect1" lang="en">
229
<a name="id3006395"></a><h2>Details</h2>
230
<div class="refsect2" lang="en">
231
<a name="id3006406"></a><h3>
232
<a name="GtkEntryCompletion-struct"></a>GtkEntryCompletion</h3>
233
<a class="indexterm" name="id3006419"></a><pre class="programlisting">typedef struct _GtkEntryCompletion GtkEntryCompletion;</pre>
235
The GtkEntryCompletion struct contains only private data.
239
<div class="refsect2" lang="en">
240
<a name="id3006436"></a><h3>
241
<a name="GtkEntryCompletionMatchFunc"></a>GtkEntryCompletionMatchFunc ()</h3>
242
<a class="indexterm" name="id3006448"></a><pre class="programlisting">gboolean (*GtkEntryCompletionMatchFunc) (<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion,
244
<a href="GtkTreeModel.html#GtkTreeIter">GtkTreeIter</a> *iter,
245
gpointer user_data);</pre>
247
A function which decides whether the row indicated by <em class="parameter"><code>iter</code></em> matches a given
248
<em class="parameter"><code>key</code></em>, and should be displayed as a possible completion for <em class="parameter"><code>key</code></em>. Note that
249
<em class="parameter"><code>key</code></em> is normalized and case-folded (see <code class="function">g_utf8_normalize()</code> and
250
<code class="function">g_utf8_casefold()</code>). If this is not appropriate, match functions have access
251
to the unmodified key via <code class="literal">gtk_entry_get_text (GTK_ENTRY (gtk_entry_completion_get_entry ()))</code>.
253
<div class="variablelist"><table border="0">
254
<col align="left" valign="top">
257
<td><span class="term"><em class="parameter"><code>completion</code></em> :</span></td>
258
<td>the <a href="GtkEntryCompletion.html" title="GtkEntryCompletion"><span class="type">GtkEntryCompletion</span></a>
262
<td><span class="term"><em class="parameter"><code>key</code></em> :</span></td>
263
<td>the string to match, normalized and case-folded
267
<td><span class="term"><em class="parameter"><code>iter</code></em> :</span></td>
268
<td>a <a href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> indicating the row to match
272
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
273
<td>user data given to <a href="GtkEntryCompletion.html#gtk-entry-completion-set-match-func"><code class="function">gtk_entry_completion_set_match_func()</code></a>
277
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
279
<code class="literal">TRUE</code> if <em class="parameter"><code>iter</code></em> should be displayed as a possible completion for <em class="parameter"><code>key</code></em>
288
<div class="refsect2" lang="en">
289
<a name="id3006681"></a><h3>
290
<a name="gtk-entry-completion-new"></a>gtk_entry_completion_new ()</h3>
291
<a class="indexterm" name="id3006696"></a><pre class="programlisting"><a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a>* gtk_entry_completion_new (void);</pre>
293
Creates a new <a href="GtkEntryCompletion.html" title="GtkEntryCompletion"><span class="type">GtkEntryCompletion</span></a> object.</p>
297
<div class="variablelist"><table border="0">
298
<col align="left" valign="top">
300
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
301
<td> A newly created <a href="GtkEntryCompletion.html" title="GtkEntryCompletion"><span class="type">GtkEntryCompletion</span></a> object.
306
<p class="since">Since 2.4
310
<div class="refsect2" lang="en">
311
<a name="id3006759"></a><h3>
312
<a name="gtk-entry-completion-get-entry"></a>gtk_entry_completion_get_entry ()</h3>
313
<a class="indexterm" name="id3006774"></a><pre class="programlisting"><a href="GtkWidget.html" title="GtkWidget">GtkWidget</a>* gtk_entry_completion_get_entry (<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion);</pre>
315
Gets the entry <em class="parameter"><code>completion</code></em> has been attached to.</p>
319
<div class="variablelist"><table border="0">
320
<col align="left" valign="top">
323
<td><span class="term"><em class="parameter"><code>completion</code></em> :</span></td>
324
<td> A <a href="GtkEntryCompletion.html" title="GtkEntryCompletion"><span class="type">GtkEntryCompletion</span></a>.
328
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
329
<td> The entry <em class="parameter"><code>completion</code></em> has been attached to.
335
<p class="since">Since 2.4
339
<div class="refsect2" lang="en">
340
<a name="id3006862"></a><h3>
341
<a name="gtk-entry-completion-set-model"></a>gtk_entry_completion_set_model ()</h3>
342
<a class="indexterm" name="id3006878"></a><pre class="programlisting">void gtk_entry_completion_set_model (<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion,
343
<a href="GtkTreeModel.html" title="GtkTreeModel">GtkTreeModel</a> *model);</pre>
345
Sets the model for a <a href="GtkEntryCompletion.html" title="GtkEntryCompletion"><span class="type">GtkEntryCompletion</span></a>. If <em class="parameter"><code>completion</code></em> already has
346
a model set, it will remove it before setting the new model.
348
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
349
><code class="literal">NULL</code></a>, then it will unset the model.</p>
353
<div class="variablelist"><table border="0">
354
<col align="left" valign="top">
357
<td><span class="term"><em class="parameter"><code>completion</code></em> :</span></td>
358
<td> A <a href="GtkEntryCompletion.html" title="GtkEntryCompletion"><span class="type">GtkEntryCompletion</span></a>.
362
<td><span class="term"><em class="parameter"><code>model</code></em> :</span></td>
363
<td> The <a href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a>.
368
<p class="since">Since 2.4
372
<div class="refsect2" lang="en">
373
<a name="id3007000"></a><h3>
374
<a name="gtk-entry-completion-get-model"></a>gtk_entry_completion_get_model ()</h3>
375
<a class="indexterm" name="id3007016"></a><pre class="programlisting"><a href="GtkTreeModel.html" title="GtkTreeModel">GtkTreeModel</a>* gtk_entry_completion_get_model (<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion);</pre>
377
Returns the model the <a href="GtkEntryCompletion.html" title="GtkEntryCompletion"><span class="type">GtkEntryCompletion</span></a> is using as data source.
379
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
380
><code class="literal">NULL</code></a> if the model is unset.</p>
384
<div class="variablelist"><table border="0">
385
<col align="left" valign="top">
388
<td><span class="term"><em class="parameter"><code>completion</code></em> :</span></td>
389
<td> A <a href="GtkEntryCompletion.html" title="GtkEntryCompletion"><span class="type">GtkEntryCompletion</span></a>.
393
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
394
<td> A <a href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a>, or <a
395
href="../liboil/liboil-liboiljunk.html#NULL:CAPS"
396
><code class="literal">NULL</code></a> if none is currently being used.
402
<p class="since">Since 2.4
406
<div class="refsect2" lang="en">
407
<a name="id3007130"></a><h3>
408
<a name="gtk-entry-completion-set-match-func"></a>gtk_entry_completion_set_match_func ()</h3>
409
<a class="indexterm" name="id3007146"></a><pre class="programlisting">void gtk_entry_completion_set_match_func (<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion,
410
<a href="GtkEntryCompletion.html#GtkEntryCompletionMatchFunc">GtkEntryCompletionMatchFunc</a> func,
412
GDestroyNotify func_notify);</pre>
414
Sets the match function for <em class="parameter"><code>completion</code></em> to be <em class="parameter"><code>func</code></em>. The match function
415
is used to determine if a row should or should not be in the completion
420
<div class="variablelist"><table border="0">
421
<col align="left" valign="top">
424
<td><span class="term"><em class="parameter"><code>completion</code></em> :</span></td>
425
<td> A <a href="GtkEntryCompletion.html" title="GtkEntryCompletion"><span class="type">GtkEntryCompletion</span></a>.
429
<td><span class="term"><em class="parameter"><code>func</code></em> :</span></td>
430
<td> The <a href="GtkEntryCompletion.html#GtkEntryCompletionMatchFunc"><span class="type">GtkEntryCompletionMatchFunc</span></a> to use.
434
<td><span class="term"><em class="parameter"><code>func_data</code></em> :</span></td>
435
<td> The user data for <em class="parameter"><code>func</code></em>.
439
<td><span class="term"><em class="parameter"><code>func_notify</code></em> :</span></td>
440
<td> Destroy notifier for <em class="parameter"><code>func_data</code></em>.
445
<p class="since">Since 2.4
449
<div class="refsect2" lang="en">
450
<a name="id3007312"></a><h3>
451
<a name="gtk-entry-completion-set-minimum-key-length"></a>gtk_entry_completion_set_minimum_key_length ()</h3>
452
<a class="indexterm" name="id3007329"></a><pre class="programlisting">void gtk_entry_completion_set_minimum_key_length
453
(<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion,
456
Requires the length of the search key for <em class="parameter"><code>completion</code></em> to be at least
457
<em class="parameter"><code>length</code></em>. This is useful for long lists, where completing using a small
458
key takes a lot of time and will come up with meaningless results anyway
459
(ie, a too large dataset).</p>
463
<div class="variablelist"><table border="0">
464
<col align="left" valign="top">
467
<td><span class="term"><em class="parameter"><code>completion</code></em> :</span></td>
468
<td> A <a href="GtkEntryCompletion.html" title="GtkEntryCompletion"><span class="type">GtkEntryCompletion</span></a>.
472
<td><span class="term"><em class="parameter"><code>length</code></em> :</span></td>
473
<td> The minimum length of the key in order to start completing.
478
<p class="since">Since 2.4
482
<div class="refsect2" lang="en">
483
<a name="id3007432"></a><h3>
484
<a name="gtk-entry-completion-get-minimum-key-length"></a>gtk_entry_completion_get_minimum_key_length ()</h3>
485
<a class="indexterm" name="id3007449"></a><pre class="programlisting">gint gtk_entry_completion_get_minimum_key_length
486
(<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion);</pre>
488
Returns the minimum key length as set for <em class="parameter"><code>completion</code></em>.</p>
492
<div class="variablelist"><table border="0">
493
<col align="left" valign="top">
496
<td><span class="term"><em class="parameter"><code>completion</code></em> :</span></td>
497
<td> A <a href="GtkEntryCompletion.html" title="GtkEntryCompletion"><span class="type">GtkEntryCompletion</span></a>.
501
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
502
<td> The currently used minimum key length.
508
<p class="since">Since 2.4
512
<div class="refsect2" lang="en">
513
<a name="id3007532"></a><h3>
514
<a name="gtk-entry-completion-complete"></a>gtk_entry_completion_complete ()</h3>
515
<a class="indexterm" name="id3007548"></a><pre class="programlisting">void gtk_entry_completion_complete (<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion);</pre>
517
Requests a completion operation, or in other words a refiltering of the
518
current list with completions, using the current key. The completion list
519
view will be updated accordingly.</p>
523
<div class="variablelist"><table border="0">
524
<col align="left" valign="top">
526
<td><span class="term"><em class="parameter"><code>completion</code></em> :</span></td>
527
<td> A <a href="GtkEntryCompletion.html" title="GtkEntryCompletion"><span class="type">GtkEntryCompletion</span></a>.
531
<p class="since">Since 2.4
535
<div class="refsect2" lang="en">
536
<a name="id3007616"></a><h3>
537
<a name="gtk-entry-completion-insert-prefix"></a>gtk_entry_completion_insert_prefix ()</h3>
538
<a class="indexterm" name="id3007633"></a><pre class="programlisting">void gtk_entry_completion_insert_prefix (<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion);</pre>
540
Requests a prefix insertion.</p>
544
<div class="variablelist"><table border="0">
545
<col align="left" valign="top">
547
<td><span class="term"><em class="parameter"><code>completion</code></em> :</span></td>
548
<td> a <a href="GtkEntryCompletion.html" title="GtkEntryCompletion"><span class="type">GtkEntryCompletion</span></a>
552
<p class="since">Since 2.6
556
<div class="refsect2" lang="en">
557
<a name="id3007698"></a><h3>
558
<a name="gtk-entry-completion-insert-action-text"></a>gtk_entry_completion_insert_action_text ()</h3>
559
<a class="indexterm" name="id3007714"></a><pre class="programlisting">void gtk_entry_completion_insert_action_text
560
(<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion,
562
const gchar *text);</pre>
564
Inserts an action in <em class="parameter"><code>completion</code></em>'s action item list at position <em class="parameter"><code>index_</code></em>
565
with text <em class="parameter"><code>text</code></em>. If you want the action item to have markup, use
566
<a href="GtkEntryCompletion.html#gtk-entry-completion-insert-action-markup"><code class="function">gtk_entry_completion_insert_action_markup()</code></a>.</p>
570
<div class="variablelist"><table border="0">
571
<col align="left" valign="top">
574
<td><span class="term"><em class="parameter"><code>completion</code></em> :</span></td>
575
<td> A <a href="GtkEntryCompletion.html" title="GtkEntryCompletion"><span class="type">GtkEntryCompletion</span></a>.
579
<td><span class="term"><em class="parameter"><code>index_</code></em> :</span></td>
580
<td> The index of the item to insert.
584
<td><span class="term"><em class="parameter"><code>text</code></em> :</span></td>
585
<td> Text of the item to insert.
590
<p class="since">Since 2.4
594
<div class="refsect2" lang="en">
595
<a name="id3007855"></a><h3>
596
<a name="gtk-entry-completion-insert-action-markup"></a>gtk_entry_completion_insert_action_markup ()</h3>
597
<a class="indexterm" name="id3007872"></a><pre class="programlisting">void gtk_entry_completion_insert_action_markup
598
(<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion,
600
const gchar *markup);</pre>
602
Inserts an action in <em class="parameter"><code>completion</code></em>'s action item list at position <em class="parameter"><code>index_</code></em>
603
with markup <em class="parameter"><code>markup</code></em>.</p>
607
<div class="variablelist"><table border="0">
608
<col align="left" valign="top">
611
<td><span class="term"><em class="parameter"><code>completion</code></em> :</span></td>
612
<td> A <a href="GtkEntryCompletion.html" title="GtkEntryCompletion"><span class="type">GtkEntryCompletion</span></a>.
616
<td><span class="term"><em class="parameter"><code>index_</code></em> :</span></td>
617
<td> The index of the item to insert.
621
<td><span class="term"><em class="parameter"><code>markup</code></em> :</span></td>
622
<td> Markup of the item to insert.
627
<p class="since">Since 2.4
631
<div class="refsect2" lang="en">
632
<a name="id3008000"></a><h3>
633
<a name="gtk-entry-completion-delete-action"></a>gtk_entry_completion_delete_action ()</h3>
634
<a class="indexterm" name="id3008017"></a><pre class="programlisting">void gtk_entry_completion_delete_action (<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion,
637
Deletes the action at <em class="parameter"><code>index_</code></em> from <em class="parameter"><code>completion</code></em>'s action list.</p>
641
<div class="variablelist"><table border="0">
642
<col align="left" valign="top">
645
<td><span class="term"><em class="parameter"><code>completion</code></em> :</span></td>
646
<td> A <a href="GtkEntryCompletion.html" title="GtkEntryCompletion"><span class="type">GtkEntryCompletion</span></a>.
650
<td><span class="term"><em class="parameter"><code>index_</code></em> :</span></td>
651
<td> The index of the item to Delete.
656
<p class="since">Since 2.4
660
<div class="refsect2" lang="en">
661
<a name="id3008116"></a><h3>
662
<a name="gtk-entry-completion-set-text-column"></a>gtk_entry_completion_set_text_column ()</h3>
663
<a class="indexterm" name="id3008133"></a><pre class="programlisting">void gtk_entry_completion_set_text_column
664
(<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion,
667
Convenience function for setting up the most used case of this code: a
668
completion list with just strings. This function will set up <em class="parameter"><code>completion</code></em>
669
to have a list displaying all (and just) strings in the completion list,
670
and to get those strings from <em class="parameter"><code>column</code></em> in the model of <em class="parameter"><code>completion</code></em>.
673
This functions creates and adds a <a href="GtkCellRendererText.html" title="GtkCellRendererText"><span class="type">GtkCellRendererText</span></a> for the selected
674
column. If you need to set the text column, but don't want the cell
675
renderer, use <code class="function">g_object_set()</code> to set the ::text_column property directly.</p>
679
<div class="variablelist"><table border="0">
680
<col align="left" valign="top">
683
<td><span class="term"><em class="parameter"><code>completion</code></em> :</span></td>
684
<td> A <a href="GtkEntryCompletion.html" title="GtkEntryCompletion"><span class="type">GtkEntryCompletion</span></a>.
688
<td><span class="term"><em class="parameter"><code>column</code></em> :</span></td>
689
<td> The column in the model of <em class="parameter"><code>completion</code></em> to get strings from.
694
<p class="since">Since 2.4
698
<div class="refsect2" lang="en">
699
<a name="id3008275"></a><h3>
700
<a name="gtk-entry-completion-get-text-column"></a>gtk_entry_completion_get_text_column ()</h3>
701
<a class="indexterm" name="id3008291"></a><pre class="programlisting">gint gtk_entry_completion_get_text_column
702
(<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion);</pre>
704
Returns the column in the model of <em class="parameter"><code>completion</code></em> to get strings from.</p>
708
<div class="variablelist"><table border="0">
709
<col align="left" valign="top">
712
<td><span class="term"><em class="parameter"><code>completion</code></em> :</span></td>
713
<td> a <a href="GtkEntryCompletion.html" title="GtkEntryCompletion"><span class="type">GtkEntryCompletion</span></a>
717
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
718
<td> the column containing the strings
724
<p class="since">Since 2.6
728
<div class="refsect2" lang="en">
729
<a name="id3008375"></a><h3>
730
<a name="gtk-entry-completion-set-inline-completion"></a>gtk_entry_completion_set_inline_completion ()</h3>
731
<a class="indexterm" name="id3008393"></a><pre class="programlisting">void gtk_entry_completion_set_inline_completion
732
(<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion,
733
gboolean inline_completion);</pre>
735
Sets whether the common prefix of the possible completions should
736
be automatically inserted in the entry.</p>
740
<div class="variablelist"><table border="0">
741
<col align="left" valign="top">
744
<td><span class="term"><em class="parameter"><code>completion</code></em> :</span></td>
745
<td> a <a href="GtkEntryCompletion.html" title="GtkEntryCompletion"><span class="type">GtkEntryCompletion</span></a>
749
<td><span class="term"><em class="parameter"><code>inline_completion</code></em> :</span></td>
750
<td> <code class="literal">TRUE</code> to do inline completion
755
<p class="since">Since 2.6
759
<div class="refsect2" lang="en">
760
<a name="id3008492"></a><h3>
761
<a name="gtk-entry-completion-get-inline-completion"></a>gtk_entry_completion_get_inline_completion ()</h3>
762
<a class="indexterm" name="id3008509"></a><pre class="programlisting">gboolean gtk_entry_completion_get_inline_completion
763
(<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion);</pre>
765
Returns whether the common prefix of the possible completions should
766
be automatically inserted in the entry.</p>
770
<div class="variablelist"><table border="0">
771
<col align="left" valign="top">
774
<td><span class="term"><em class="parameter"><code>completion</code></em> :</span></td>
775
<td> a <a href="GtkEntryCompletion.html" title="GtkEntryCompletion"><span class="type">GtkEntryCompletion</span></a>
779
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
780
<td> <code class="literal">TRUE</code> if inline completion is turned on
786
<p class="since">Since 2.6
790
<div class="refsect2" lang="en">
791
<a name="id3008597"></a><h3>
792
<a name="gtk-entry-completion-set-popup-completion"></a>gtk_entry_completion_set_popup_completion ()</h3>
793
<a class="indexterm" name="id3008614"></a><pre class="programlisting">void gtk_entry_completion_set_popup_completion
794
(<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion,
795
gboolean popup_completion);</pre>
797
Sets whether the completions should be presented in a popup window.</p>
801
<div class="variablelist"><table border="0">
802
<col align="left" valign="top">
805
<td><span class="term"><em class="parameter"><code>completion</code></em> :</span></td>
806
<td> a <a href="GtkEntryCompletion.html" title="GtkEntryCompletion"><span class="type">GtkEntryCompletion</span></a>
810
<td><span class="term"><em class="parameter"><code>popup_completion</code></em> :</span></td>
811
<td> <code class="literal">TRUE</code> to do popup completion
816
<p class="since">Since 2.6
820
<div class="refsect2" lang="en">
821
<a name="id3008713"></a><h3>
822
<a name="gtk-entry-completion-get-popup-completion"></a>gtk_entry_completion_get_popup_completion ()</h3>
823
<a class="indexterm" name="id3008730"></a><pre class="programlisting">gboolean gtk_entry_completion_get_popup_completion
824
(<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion);</pre>
826
Returns whether the completions should be presented in a popup window.</p>
830
<div class="variablelist"><table border="0">
831
<col align="left" valign="top">
834
<td><span class="term"><em class="parameter"><code>completion</code></em> :</span></td>
835
<td> a <a href="GtkEntryCompletion.html" title="GtkEntryCompletion"><span class="type">GtkEntryCompletion</span></a>
839
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
840
<td> <code class="literal">TRUE</code> if popup completion is turned on
846
<p class="since">Since 2.6
850
<div class="refsect2" lang="en">
851
<a name="id3008817"></a><h3>
852
<a name="gtk-entry-completion-set-popup-set-width"></a>gtk_entry_completion_set_popup_set_width ()</h3>
853
<a class="indexterm" name="id3008834"></a><pre class="programlisting">void gtk_entry_completion_set_popup_set_width
854
(<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion,
855
gboolean popup_set_width);</pre>
857
Sets whether the completion popup window will be resized to be the same
858
width as the entry.</p>
862
<div class="variablelist"><table border="0">
863
<col align="left" valign="top">
866
<td><span class="term"><em class="parameter"><code>completion</code></em> :</span></td>
867
<td> a <a href="GtkEntryCompletion.html" title="GtkEntryCompletion"><span class="type">GtkEntryCompletion</span></a>
871
<td><span class="term"><em class="parameter"><code>popup_set_width</code></em> :</span></td>
872
<td> <code class="literal">TRUE</code> to make the width of the popup the same as the entry
877
<p class="since">Since 2.8
881
<div class="refsect2" lang="en">
882
<a name="id3008934"></a><h3>
883
<a name="gtk-entry-completion-get-popup-set-width"></a>gtk_entry_completion_get_popup_set_width ()</h3>
884
<a class="indexterm" name="id3008950"></a><pre class="programlisting">gboolean gtk_entry_completion_get_popup_set_width
885
(<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion);</pre>
887
Returns whether the completion popup window will be resized to the
888
width of the entry.</p>
892
<div class="variablelist"><table border="0">
893
<col align="left" valign="top">
896
<td><span class="term"><em class="parameter"><code>completion</code></em> :</span></td>
897
<td> a <a href="GtkEntryCompletion.html" title="GtkEntryCompletion"><span class="type">GtkEntryCompletion</span></a>
901
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
902
<td> <code class="literal">TRUE</code> if the popup window will be resized to the width of
909
<p class="since">Since 2.8
913
<div class="refsect2" lang="en">
914
<a name="id3009039"></a><h3>
915
<a name="gtk-entry-completion-set-popup-single-match"></a>gtk_entry_completion_set_popup_single_match ()</h3>
916
<a class="indexterm" name="id3009056"></a><pre class="programlisting">void gtk_entry_completion_set_popup_single_match
917
(<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion,
918
gboolean popup_single_match);</pre>
920
Sets whether the completion popup window will appear even if there is
921
only a single match. You may want to set this to <code class="literal">FALSE</code> if you
922
are using <a href="GtkEntryCompletion.html#GtkEntryCompletion--inline-completion">inline
927
<div class="variablelist"><table border="0">
928
<col align="left" valign="top">
931
<td><span class="term"><em class="parameter"><code>completion</code></em> :</span></td>
932
<td> a <a href="GtkEntryCompletion.html" title="GtkEntryCompletion"><span class="type">GtkEntryCompletion</span></a>
936
<td><span class="term"><em class="parameter"><code>popup_single_match</code></em> :</span></td>
937
<td> <code class="literal">TRUE</code> if the popup should appear even for a single
943
<p class="since">Since 2.8
947
<div class="refsect2" lang="en">
948
<a name="id3009175"></a><h3>
949
<a name="gtk-entry-completion-get-popup-single-match"></a>gtk_entry_completion_get_popup_single_match ()</h3>
950
<a class="indexterm" name="id3009191"></a><pre class="programlisting">gboolean gtk_entry_completion_get_popup_single_match
951
(<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *completion);</pre>
953
Returns whether the completion popup window will appear even if there is
954
only a single match.</p>
958
<div class="variablelist"><table border="0">
959
<col align="left" valign="top">
962
<td><span class="term"><em class="parameter"><code>completion</code></em> :</span></td>
963
<td> a <a href="GtkEntryCompletion.html" title="GtkEntryCompletion"><span class="type">GtkEntryCompletion</span></a>
967
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
968
<td> <code class="literal">TRUE</code> if the popup window will appear regardless of the
975
<p class="since">Since 2.8
979
<div class="refsect1" lang="en">
980
<a name="id3009281"></a><h2>Property Details</h2>
981
<div class="refsect2" lang="en">
982
<a name="id3009292"></a><h3>
983
<a name="GtkEntryCompletion--inline-completion"></a>The "<code class="literal">inline-completion</code>" property</h3>
984
<a class="indexterm" name="id3009308"></a><pre class="programlisting"> "inline-completion" gboolean : Read / Write</pre>
986
Determines whether the common prefix of the possible completions
987
should be inserted automatically in the entry. Note that this
988
requires text-column to be set, even if you are using a custom
993
<p>Default value: FALSE</p>
998
<div class="refsect2" lang="en">
999
<a name="id3009347"></a><h3>
1000
<a name="GtkEntryCompletion--minimum-key-length"></a>The "<code class="literal">minimum-key-length</code>" property</h3>
1001
<a class="indexterm" name="id3009364"></a><pre class="programlisting"> "minimum-key-length" gint : Read / Write</pre>
1002
<p>Minimum length of the search key in order to look up matches.</p>
1003
<p>Allowed values: >= 0</p>
1004
<p>Default value: 1</p>
1007
<div class="refsect2" lang="en">
1008
<a name="id3009395"></a><h3>
1009
<a name="GtkEntryCompletion--model"></a>The "<code class="literal">model</code>" property</h3>
1010
<a class="indexterm" name="id3009411"></a><pre class="programlisting"> "model" <a href="GtkTreeModel.html" title="GtkTreeModel">GtkTreeModel</a> : Read / Write</pre>
1011
<p>The model to find matches in.</p>
1014
<div class="refsect2" lang="en">
1015
<a name="id3009435"></a><h3>
1016
<a name="GtkEntryCompletion--popup-completion"></a>The "<code class="literal">popup-completion</code>" property</h3>
1017
<a class="indexterm" name="id3009453"></a><pre class="programlisting"> "popup-completion" gboolean : Read / Write</pre>
1019
Determines whether the possible completions should be
1020
shown in a popup window.</p>
1024
<p>Default value: TRUE</p>
1029
<div class="refsect2" lang="en">
1030
<a name="id3009489"></a><h3>
1031
<a name="GtkEntryCompletion--popup-set-width"></a>The "<code class="literal">popup-set-width</code>" property</h3>
1032
<a class="indexterm" name="id3009506"></a><pre class="programlisting"> "popup-set-width" gboolean : Read / Write</pre>
1034
Determines whether the completions popup window will be
1035
resized to the width of the entry.</p>
1039
<p>Default value: TRUE</p>
1044
<div class="refsect2" lang="en">
1045
<a name="id3009542"></a><h3>
1046
<a name="GtkEntryCompletion--popup-single-match"></a>The "<code class="literal">popup-single-match</code>" property</h3>
1047
<a class="indexterm" name="id3009560"></a><pre class="programlisting"> "popup-single-match" gboolean : Read / Write</pre>
1049
Determines whether the completions popup window will shown
1050
for a single possible completion. You probably want to set
1051
this to <code class="literal">FALSE</code> if you are using
1052
<a href="GtkEntryCompletion.html#GtkEntryCompletion--inline-completion">inline
1057
<p>Default value: TRUE</p>
1062
<div class="refsect2" lang="en">
1063
<a name="id3009616"></a><h3>
1064
<a name="GtkEntryCompletion--text-column"></a>The "<code class="literal">text-column</code>" property</h3>
1065
<a class="indexterm" name="id3009633"></a><pre class="programlisting"> "text-column" gint : Read / Write</pre>
1067
The column of the model containing the strings.</p>
1071
<p>Allowed values: >= -1</p>
1072
<p>Default value: -1</p>
1077
<div class="refsect1" lang="en">
1078
<a name="id3009673"></a><h2>Signal Details</h2>
1079
<div class="refsect2" lang="en">
1080
<a name="id3009684"></a><h3>
1081
<a name="GtkEntryCompletion-action-activated"></a>The "action-activated" signal</h3>
1082
<a class="indexterm" name="id3009695"></a><pre class="programlisting">void user_function (<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *widget,
1084
gpointer user_data) : Run Last</pre>
1086
Gets emitted when an action is activated.</p>
1090
<div class="variablelist"><table border="0">
1091
<col align="left" valign="top">
1094
<td><span class="term"><em class="parameter"><code>widget</code></em> :</span></td>
1095
<td> the object which received the signal
1099
<td><span class="term"><em class="parameter"><code>index</code></em> :</span></td>
1100
<td> the index of the activated action
1104
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
1105
<td>user data set when the signal handler was connected.</td>
1113
<div class="refsect2" lang="en">
1114
<a name="id3009794"></a><h3>
1115
<a name="GtkEntryCompletion-insert-prefix"></a>The "insert-prefix" signal</h3>
1116
<a class="indexterm" name="id3009805"></a><pre class="programlisting">gboolean user_function (<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *widget,
1118
gpointer user_data) : Run Last</pre>
1120
Gets emitted when the inline autocompletion is triggered.
1121
The default behaviour is to make the entry display the
1122
whole prefix and select the newly inserted part.
1125
Applications may connect to this signal in order to insert only a
1126
smaller part of the <em class="parameter"><code>prefix</code></em> into the entry - e.g. the entry used in
1127
the <a href="GtkFileChooser.html" title="GtkFileChooser"><span class="type">GtkFileChooser</span></a> inserts only the part of the prefix up to the
1132
<div class="variablelist"><table border="0">
1133
<col align="left" valign="top">
1136
<td><span class="term"><em class="parameter"><code>widget</code></em> :</span></td>
1137
<td> the object which received the signal
1141
<td><span class="term"><em class="parameter"><code>prefix</code></em> :</span></td>
1142
<td> the common prefix of all possible completions
1146
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
1147
<td>user data set when the signal handler was connected.</td>
1150
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
1151
<td> <code class="literal">TRUE</code> if the signal has been handled
1161
<div class="refsect2" lang="en">
1162
<a name="id3009948"></a><h3>
1163
<a name="GtkEntryCompletion-match-selected"></a>The "match-selected" signal</h3>
1164
<a class="indexterm" name="id3009959"></a><pre class="programlisting">gboolean user_function (<a href="GtkEntryCompletion.html" title="GtkEntryCompletion">GtkEntryCompletion</a> *widget,
1165
<a href="GtkTreeModel.html" title="GtkTreeModel">GtkTreeModel</a> *model,
1166
<a href="GtkTreeModel.html#GtkTreeIter">GtkTreeIter</a> *iter,
1167
gpointer user_data) : Run Last</pre>
1169
Gets emitted when a match from the list is selected.
1170
The default behaviour is to replace the contents of the
1171
entry with the contents of the text column in the row
1172
pointed to by <em class="parameter"><code>iter</code></em>.</p>
1176
<div class="variablelist"><table border="0">
1177
<col align="left" valign="top">
1180
<td><span class="term"><em class="parameter"><code>widget</code></em> :</span></td>
1181
<td> the object which received the signal
1185
<td><span class="term"><em class="parameter"><code>model</code></em> :</span></td>
1186
<td> the <a href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a> containing the matches
1190
<td><span class="term"><em class="parameter"><code>iter</code></em> :</span></td>
1191
<td> a <a href="GtkTreeModel.html#GtkTreeIter"><span class="type">GtkTreeIter</span></a> positioned at the selected match
1195
<td><span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
1196
<td>user data set when the signal handler was connected.</td>
1199
<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
1200
<td> <code class="literal">TRUE</code> if the signal has been handled
added
removed
docs/reference/gtk/html/GtkEntryCompletion.html
