Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtkcombobox.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GtkComboBox
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 A widget used to choose from a list of items
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 A #GtkComboBox is a widget that allows the user to choose from a
  10 list of valid choices.  The #GtkComboBox displays the selected
  11 choice.  When activated, the #GtkComboBox displays a popup
  12 which allows the user to make a new choice. The style in which
  13 the selected value is displayed, and the style of the popup is
  14 determined by the current theme. It may be similar to a #GtkOptionMenu,
  15 or similar to a Windows-style combo box.
  16 </para>
  17
  18 <para>
  19 Unlike its predecessors #GtkCombo and #GtkOptionMenu, the #GtkComboBox
  20 uses the model-view pattern; the list of valid choices is specified in the
  21 form of a tree model, and the display of the choices can be adapted to
  22 the data in the model by using cell renderers, as you would in a tree view.
  23 This is possible since #GtkComboBox implements the #GtkCellLayout interface.
  24 The tree model holding the valid choices is not restricted to a flat list,
  25 it can be a real tree, and the popup will reflect the tree structure.
  26 </para>
  27
  28 <para>
  29 In addition to the model-view API, #GtkComboBox offers a simple API which
  30 is suitable for text-only combo boxes, and hides the complexity of managing
  31 the data in a model. It consists of the functions gtk_combo_box_new_text(),
  32 gtk_combo_box_append_text(), gtk_combo_box_insert_text(),
  33 gtk_combo_box_prepend_text(), gtk_combo_box_remove_text() and
  34 gtk_combo_box_get_active_text().
  35 </para>
  36
  37 <!-- ##### SECTION See_Also ##### -->
  38 <para>
  39 #GtkComboBoxEntry, #GtkTreeModel, #GtkCellRenderer
  40 </para>
  41
  42 <!-- ##### SECTION Stability_Level ##### -->
  43
  44
  45 <!-- ##### STRUCT GtkComboBox ##### -->
  46 <para>
  47
  48 </para>
  49
  50
  51 <!-- ##### SIGNAL GtkComboBox::changed ##### -->
  52 <para>
  53
  54 </para>
  55
  56 @combobox: the object which received the signal.
  57
  58 <!-- ##### ARG GtkComboBox:active ##### -->
  59 <para>
  60
  61 </para>
  62
  63 <!-- ##### ARG GtkComboBox:add-tearoffs ##### -->
  64 <para>
  65
  66 </para>
  67
  68 <!-- ##### ARG GtkComboBox:column-span-column ##### -->
  69 <para>
  70
  71 </para>
  72
  73 <!-- ##### ARG GtkComboBox:focus-on-click ##### -->
  74 <para>
  75
  76 </para>
  77
  78 <!-- ##### ARG GtkComboBox:has-frame ##### -->
  79 <para>
  80
  81 </para>
  82
  83 <!-- ##### ARG GtkComboBox:model ##### -->
  84 <para>
  85
  86 </para>
  87
  88 <!-- ##### ARG GtkComboBox:row-span-column ##### -->
  89 <para>
  90
  91 </para>
  92
  93 <!-- ##### ARG GtkComboBox:wrap-width ##### -->
  94 <para>
  95
  96 </para>
  97
  98 <!-- ##### ARG GtkComboBox:appears-as-list ##### -->
  99 <para>
 100
 101 </para>
 102
 103 <!-- ##### FUNCTION gtk_combo_box_new ##### -->
 104 <para>
 105
 106 </para>
 107
 108 @Returns:
 109 <!-- # Unused Parameters # -->
 110 @model:
 111
 112
 113 <!-- ##### FUNCTION gtk_combo_box_new_with_model ##### -->
 114 <para>
 115
 116 </para>
 117
 118 @model:
 119 @Returns:
 120
 121
 122 <!-- ##### FUNCTION gtk_combo_box_get_wrap_width ##### -->
 123 <para>
 124
 125 </para>
 126
 127 @combo_box:
 128 @Returns:
 129
 130
 131 <!-- ##### FUNCTION gtk_combo_box_set_wrap_width ##### -->
 132 <para>
 133
 134 </para>
 135
 136 @combo_box:
 137 @width:
 138
 139
 140 <!-- ##### FUNCTION gtk_combo_box_get_row_span_column ##### -->
 141 <para>
 142
 143 </para>
 144
 145 @combo_box:
 146 @Returns:
 147
 148
 149 <!-- ##### FUNCTION gtk_combo_box_set_row_span_column ##### -->
 150 <para>
 151
 152 </para>
 153
 154 @combo_box:
 155 @row_span:
 156
 157
 158 <!-- ##### FUNCTION gtk_combo_box_get_column_span_column ##### -->
 159 <para>
 160
 161 </para>
 162
 163 @combo_box:
 164 @Returns:
 165
 166
 167 <!-- ##### FUNCTION gtk_combo_box_set_column_span_column ##### -->
 168 <para>
 169
 170 </para>
 171
 172 @combo_box:
 173 @column_span:
 174
 175
 176 <!-- ##### FUNCTION gtk_combo_box_get_active ##### -->
 177 <para>
 178
 179 </para>
 180
 181 @combo_box:
 182 @Returns:
 183
 184
 185 <!-- ##### FUNCTION gtk_combo_box_set_active ##### -->
 186 <para>
 187
 188 </para>
 189
 190 @combo_box:
 191 @index_:
 192 <!-- # Unused Parameters # -->
 193 @index:
 194
 195
 196 <!-- ##### FUNCTION gtk_combo_box_get_active_iter ##### -->
 197 <para>
 198
 199 </para>
 200
 201 @combo_box:
 202 @iter:
 203 @Returns:
 204
 205
 206 <!-- ##### FUNCTION gtk_combo_box_set_active_iter ##### -->
 207 <para>
 208
 209 </para>
 210
 211 @combo_box:
 212 @iter:
 213
 214
 215 <!-- ##### FUNCTION gtk_combo_box_get_model ##### -->
 216 <para>
 217
 218 </para>
 219
 220 @combo_box:
 221 @Returns:
 222
 223
 224 <!-- ##### FUNCTION gtk_combo_box_set_model ##### -->
 225 <para>
 226
 227 </para>
 228
 229 @combo_box:
 230 @model:
 231
 232
 233 <!-- ##### FUNCTION gtk_combo_box_new_text ##### -->
 234 <para>
 235
 236 </para>
 237
 238 @Returns:
 239
 240
 241 <!-- ##### FUNCTION gtk_combo_box_append_text ##### -->
 242 <para>
 243
 244 </para>
 245
 246 @combo_box:
 247 @text:
 248
 249
 250 <!-- ##### FUNCTION gtk_combo_box_insert_text ##### -->
 251 <para>
 252
 253 </para>
 254
 255 @combo_box:
 256 @position:
 257 @text:
 258
 259
 260 <!-- ##### FUNCTION gtk_combo_box_prepend_text ##### -->
 261 <para>
 262
 263 </para>
 264
 265 @combo_box:
 266 @text:
 267
 268
 269 <!-- ##### FUNCTION gtk_combo_box_remove_text ##### -->
 270 <para>
 271
 272 </para>
 273
 274 @combo_box:
 275 @position:
 276
 277
 278 <!-- ##### FUNCTION gtk_combo_box_get_active_text ##### -->
 279 <para>
 280
 281 </para>
 282
 283 @combo_box:
 284 @Returns:
 285
 286
 287 <!-- ##### FUNCTION gtk_combo_box_popup ##### -->
 288 <para>
 289
 290 </para>
 291
 292 @combo_box:
 293
 294
 295 <!-- ##### FUNCTION gtk_combo_box_popdown ##### -->
 296 <para>
 297
 298 </para>
 299
 300 @combo_box:
 301
 302
 303 <!-- ##### FUNCTION gtk_combo_box_get_popup_accessible ##### -->
 304 <para>
 305
 306 </para>
 307
 308 @combo_box:
 309 @Returns:
 310
 311
 312 <!-- ##### FUNCTION gtk_combo_box_get_row_separator_func ##### -->
 313 <para>
 314
 315 </para>
 316
 317 @combo_box:
 318 @Returns:
 319
 320
 321 <!-- ##### FUNCTION gtk_combo_box_set_row_separator_func ##### -->
 322 <para>
 323
 324 </para>
 325
 326 @combo_box:
 327 @func:
 328 @data:
 329 @destroy:
 330
 331
 332 <!-- ##### FUNCTION gtk_combo_box_set_add_tearoffs ##### -->
 333 <para>
 334
 335 </para>
 336
 337 @combo_box:
 338 @add_tearoffs:
 339
 340
 341 <!-- ##### FUNCTION gtk_combo_box_get_add_tearoffs ##### -->
 342 <para>
 343
 344 </para>
 345
 346 @combo_box:
 347 @Returns:
 348
 349
 350 <!-- ##### FUNCTION gtk_combo_box_set_focus_on_click ##### -->
 351 <para>
 352
 353 </para>
 354
 355 @combo:
 356 @focus_on_click:
 357
 358
 359 <!-- ##### FUNCTION gtk_combo_box_get_focus_on_click ##### -->
 360 <para>
 361
 362 </para>
 363
 364 @combo:
 365 @Returns:
 366
 367