summaryrefslogtreecommitdiff
path: root/docs/reference/gtk/tmpl/gtkcombobox.sgml
blob: b647b7109d566e7b3d60628d121df2d4703eaa35 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
<!-- ##### SECTION Title ##### -->
GtkComboBox

<!-- ##### SECTION Short_Description ##### -->
A widget used to choose from a list of items

<!-- ##### SECTION Long_Description ##### -->
<para>
A #GtkComboBox is a widget that allows the user to choose from a
list of valid choices.  The #GtkComboBox displays the selected 
choice.  When activated, the #GtkComboBox displays a popup 
which allows the user to make a new choice. The style in which 
the selected value is displayed, and the style of the popup is
determined by the current theme. It may be similar to a #GtkOptionMenu,
or similar to a Windows-style combo box.
</para>

<para>
Unlike its predecessors #GtkCombo and #GtkOptionMenu, the #GtkComboBox
uses the model-view pattern; the list of valid choices is specified in the
form of a tree model, and the display of the choices can be adapted to
the data in the model by using cell renderers, as you would in a tree view.
This is possible since #GtkComboBox implements the #GtkCellLayout interface.
The tree model holding the valid choices is not restricted to a flat list,
it can be a real tree, and the popup will reflect the tree structure.
</para>

<para>
In addition to the model-view API, #GtkComboBox offers a simple API which 
is suitable for text-only combo boxes, and hides the complexity of managing
the data in a model. It consists of the functions gtk_combo_box_new_text(), 
gtk_combo_box_append_text(), gtk_combo_box_insert_text(), 
gtk_combo_box_prepend_text(), gtk_combo_box_remove_text() and 
gtk_combo_box_get_active_text().
</para>

<!-- ##### SECTION See_Also ##### -->
<para>
#GtkComboBoxEntry, #GtkTreeModel, #GtkCellRenderer
</para>

<!-- ##### SECTION Stability_Level ##### -->


<!-- ##### STRUCT GtkComboBox ##### -->
<para>

</para>


<!-- ##### SIGNAL GtkComboBox::changed ##### -->
<para>

</para>

@combobox: the object which received the signal.

<!-- ##### ARG GtkComboBox:active ##### -->
<para>

</para>

<!-- ##### ARG GtkComboBox:add-tearoffs ##### -->
<para>

</para>

<!-- ##### ARG GtkComboBox:column-span-column ##### -->
<para>

</para>

<!-- ##### ARG GtkComboBox:focus-on-click ##### -->
<para>

</para>

<!-- ##### ARG GtkComboBox:has-frame ##### -->
<para>

</para>

<!-- ##### ARG GtkComboBox:model ##### -->
<para>

</para>

<!-- ##### ARG GtkComboBox:row-span-column ##### -->
<para>

</para>

<!-- ##### ARG GtkComboBox:wrap-width ##### -->
<para>

</para>

<!-- ##### ARG GtkComboBox:appears-as-list ##### -->
<para>

</para>

<!-- ##### FUNCTION gtk_combo_box_new ##### -->
<para>

</para>

@Returns: 
<!-- # Unused Parameters # -->
@model: 


<!-- ##### FUNCTION gtk_combo_box_new_with_model ##### -->
<para>

</para>

@model: 
@Returns: 


<!-- ##### FUNCTION gtk_combo_box_get_wrap_width ##### -->
<para>

</para>

@combo_box: 
@Returns: 


<!-- ##### FUNCTION gtk_combo_box_set_wrap_width ##### -->
<para>

</para>

@combo_box: 
@width: 


<!-- ##### FUNCTION gtk_combo_box_get_row_span_column ##### -->
<para>

</para>

@combo_box: 
@Returns: 


<!-- ##### FUNCTION gtk_combo_box_set_row_span_column ##### -->
<para>

</para>

@combo_box: 
@row_span: 


<!-- ##### FUNCTION gtk_combo_box_get_column_span_column ##### -->
<para>

</para>

@combo_box: 
@Returns: 


<!-- ##### FUNCTION gtk_combo_box_set_column_span_column ##### -->
<para>

</para>

@combo_box: 
@column_span: 


<!-- ##### FUNCTION gtk_combo_box_get_active ##### -->
<para>

</para>

@combo_box: 
@Returns: 


<!-- ##### FUNCTION gtk_combo_box_set_active ##### -->
<para>

</para>

@combo_box: 
@index_: 
<!-- # Unused Parameters # -->
@index: 


<!-- ##### FUNCTION gtk_combo_box_get_active_iter ##### -->
<para>

</para>

@combo_box: 
@iter: 
@Returns: 


<!-- ##### FUNCTION gtk_combo_box_set_active_iter ##### -->
<para>

</para>

@combo_box: 
@iter: 


<!-- ##### FUNCTION gtk_combo_box_get_model ##### -->
<para>

</para>

@combo_box: 
@Returns: 


<!-- ##### FUNCTION gtk_combo_box_set_model ##### -->
<para>

</para>

@combo_box: 
@model: 


<!-- ##### FUNCTION gtk_combo_box_new_text ##### -->
<para>

</para>

@Returns: 


<!-- ##### FUNCTION gtk_combo_box_append_text ##### -->
<para>

</para>

@combo_box: 
@text: 


<!-- ##### FUNCTION gtk_combo_box_insert_text ##### -->
<para>

</para>

@combo_box: 
@position: 
@text: 


<!-- ##### FUNCTION gtk_combo_box_prepend_text ##### -->
<para>

</para>

@combo_box: 
@text: 


<!-- ##### FUNCTION gtk_combo_box_remove_text ##### -->
<para>

</para>

@combo_box: 
@position: 


<!-- ##### FUNCTION gtk_combo_box_get_active_text ##### -->
<para>

</para>

@combo_box: 
@Returns: 


<!-- ##### FUNCTION gtk_combo_box_popup ##### -->
<para>

</para>

@combo_box: 


<!-- ##### FUNCTION gtk_combo_box_popdown ##### -->
<para>

</para>

@combo_box: 


<!-- ##### FUNCTION gtk_combo_box_get_popup_accessible ##### -->
<para>

</para>

@combo_box: 
@Returns: 


<!-- ##### FUNCTION gtk_combo_box_get_row_separator_func ##### -->
<para>

</para>

@combo_box: 
@Returns: 


<!-- ##### FUNCTION gtk_combo_box_set_row_separator_func ##### -->
<para>

</para>

@combo_box: 
@func: 
@data: 
@destroy: 


<!-- ##### FUNCTION gtk_combo_box_set_add_tearoffs ##### -->
<para>

</para>

@combo_box: 
@add_tearoffs: 


<!-- ##### FUNCTION gtk_combo_box_get_add_tearoffs ##### -->
<para>

</para>

@combo_box: 
@Returns: 


<!-- ##### FUNCTION gtk_combo_box_set_focus_on_click ##### -->
<para>

</para>

@combo: 
@focus_on_click: 


<!-- ##### FUNCTION gtk_combo_box_get_focus_on_click ##### -->
<para>

</para>

@combo: 
@Returns: