1
2@c %start of fragment
3
4@deftp Class <gtk-entry-completion>
5Derives from @code{<gtk-buildable>}, @code{<gtk-cell-layout>}, @code{<gobject>}.
6
7This class defines the following slots:
8
9@table @code
10@item model
11The model to find matches in
12
13@item minimum-key-length
14Minimum length of the search key in order to look up matches
15
16@item text-column
17The column of the model containing the strings.
18
19@item inline-completion
20Whether the common prefix should be inserted automatically
21
22@item popup-completion
23Whether the completions should be shown in a popup window
24
25@item popup-set-width
26If TRUE, the popup window will have the same size as the entry
27
28@item popup-single-match
29If TRUE, the popup window will appear for a single match.
30
31@item inline-selection
32Your description here
33
34@end table
35
36@end deftp
37
38@defop Signal <gtk-entry-completion> insert-prefix  (arg0@tie{}@code{<gchararray>}) @result{}@tie{}@code{<gboolean>}
39Gets emitted when the inline autocompletion is triggered. The default behaviour
40is to make the entry display the whole prefix and select the newly inserted
41part.
42
43Applications may connect to this signal in order to insert only a smaller part
44of the @var{prefix} into the entry - e.g. the entry used in the
45@code{<gtk-file-chooser>} inserts only the part of the prefix up to the next
46'/'.
47
48Since 2.6
49
50@end defop
51
52@defop Signal <gtk-entry-completion> match-selected  (arg0@tie{}@code{<gtk-tree-model>}) (arg1@tie{}@code{<gtk-tree-iter>}) @result{}@tie{}@code{<gboolean>}
53Gets emitted when a match from the list is selected. The default behaviour is to
54replace the contents of the entry with the contents of the text column in the
55row pointed to by @var{iter}.
56
57Since 2.4
58
59@end defop
60
61@defop Signal <gtk-entry-completion> cursor-on-match  (arg0@tie{}@code{<gtk-tree-model>}) (arg1@tie{}@code{<gtk-tree-iter>}) @result{}@tie{}@code{<gboolean>}
62undocumented
63@end defop
64
65@defop Signal <gtk-entry-completion> action-activated  (arg0@tie{}@code{<gint>})
66Gets emitted when an action is activated.
67
68Since 2.4
69
70@end defop
71
72@deffn Function gtk-entry-completion-new  @result{}@tie{} (ret@tie{}@code{<gtk-entry-completion>})
73Creates a new @code{<gtk-entry-completion>} object.
74
75@table @var
76@item ret
77A newly created @code{<gtk-entry-completion>} object.
78
79@end table
80
81Since 2.4
82
83@end deffn
84
85@deffn Function gtk-entry-completion-get-entry  (self@tie{}@code{<gtk-entry-completion>}) @result{}@tie{} (ret@tie{}@code{<gtk-widget>})
86@deffnx Method get-entry
87Gets the entry @var{completion} has been attached to.
88
89@table @var
90@item completion
91A @code{<gtk-entry-completion>}.
92
93@item ret
94The entry @var{completion} has been attached to.
95
96@end table
97
98Since 2.4
99
100@end deffn
101
102@deffn Function gtk-entry-completion-set-model  (self@tie{}@code{<gtk-entry-completion>}) (model@tie{}@code{<gtk-tree-model>})
103@deffnx Method set-model
104Sets the model for a @code{<gtk-entry-completion>}. If @var{completion} already
105has a model set, it will remove it before setting the new model. If model is
106@samp{@code{#f}}, then it will unset the model.
107
108@table @var
109@item completion
110A @code{<gtk-entry-completion>}.
111
112@item model
113The @code{<gtk-tree-model>}.
114
115@end table
116
117Since 2.4
118
119@end deffn
120
121@deffn Function gtk-entry-completion-get-model  (self@tie{}@code{<gtk-entry-completion>}) @result{}@tie{} (ret@tie{}@code{<gtk-tree-model>})
122@deffnx Method get-model
123Returns the model the @code{<gtk-entry-completion>} is using as data source.
124Returns @samp{@code{#f}} if the model is unset.
125
126@table @var
127@item completion
128A @code{<gtk-entry-completion>}.
129
130@item ret
131A @code{<gtk-tree-model>}, or @samp{@code{#f}} if none is currently being used.
132
133@end table
134
135Since 2.4
136
137@end deffn
138
139@deffn Function gtk-entry-completion-complete  (self@tie{}@code{<gtk-entry-completion>})
140@deffnx Method complete
141Requests a completion operation, or in other words a refiltering of the current
142list with completions, using the current key. The completion list view will be
143updated accordingly.
144
145@table @var
146@item completion
147A @code{<gtk-entry-completion>}.
148
149@end table
150
151Since 2.4
152
153@end deffn
154
155@deffn Function gtk-entry-completion-insert-prefix  (self@tie{}@code{<gtk-entry-completion>})
156@deffnx Method insert-prefix
157Requests a prefix insertion.
158
159@table @var
160@item completion
161a @code{<gtk-entry-completion>}
162
163@end table
164
165Since 2.6
166
167@end deffn
168
169@deffn Function gtk-entry-completion-delete-action  (self@tie{}@code{<gtk-entry-completion>}) (index@tie{}@code{int})
170@deffnx Method delete-action
171Deletes the action at @var{index} from @var{completion}'s action list.
172
173@table @var
174@item completion
175A @code{<gtk-entry-completion>}.
176
177@item index
178The index of the item to Delete.
179
180@end table
181
182Since 2.4
183
184@end deffn
185
186
187@c %end of fragment
188