Memory-managed wrapper type.

Type class for types which can be safely cast to ComboBox, for instance with toComboBox.

Cast to ComboBox, for types for which this is known to be safe. For general casts, use castTo.

Returns the index of the currently active item.

If the model is a non-flat treemodel, and the active item is not an immediate child of the root of the tree, this function returns gtk_tree_path_get_indices (path)[0], where path is the [structgtk.TreePath] of the active item.

Returns the ID of the active row of comboBox.

This value is taken from the active row and the column specified by the ComboBox:idColumn property of comboBox (see comboBoxSetIdColumn).

The returned value is an interned string which means that you can compare the pointer by value to other interned strings and that you must not free it.

If the ComboBox:idColumn property of comboBox is not set, or if no row is active, or if the active row has a Nothing ID value, then Nothing is returned.

Sets iter to point to the currently active item.

If no item is active, iter is left unchanged.

Returns whether the combo box sets the dropdown button sensitive or not when there are no items in the model.

Gets the child widget of comboBox.

Returns the column which comboBox is using to get the strings from to display in the internal entry.

Returns whether the combo box has an entry.

Returns the column which comboBox is using to get string IDs for values from.

Returns the GtkTreeModel of comboBox.

Gets whether the popup uses a fixed width.

Creates a new empty GtkComboBox.

Creates a new empty GtkComboBox with an entry.

In order to use a combo box with entry, you need to tell it which column of the model contains the text for the entry by calling comboBoxSetEntryTextColumn.

Creates a new GtkComboBox with a model.

Creates a new empty GtkComboBox with an entry and a model.

See also comboBoxNewWithEntry.

Hides the menu or dropdown list of comboBox.

This function is mostly intended for use by accessibility technologies; applications should have little use for it.

Pops up the menu or dropdown list of comboBox.

This function is mostly intended for use by accessibility technologies; applications should have little use for it.

Before calling this, comboBox must be mapped, or nothing will happen.

Pops up the menu of comboBox.

Note that currently this does not do anything with the device, as it was previously only used for list-mode combo boxes, and those were removed in GTK 4. However, it is retained in case similar functionality is added back later.

Sets the active item of comboBox to be the item at index.

Changes the active row of comboBox to the one that has an ID equal to activeId.

If activeId is Nothing, the active row is unset. Rows having a Nothing ID string cannot be made active by this function.

If the ComboBox:idColumn property of comboBox is unset or if no row has the given ID then the function does nothing and returns False.

Sets the current active item to be the one referenced by iter.

If iter is Nothing, the active item is unset.

Sets whether the dropdown button of the combo box should update its sensitivity depending on the model contents.

Sets the child widget of comboBox.

Sets the model column which comboBox should use to get strings from to be textColumn.

For this column no separate CellRenderer is needed.

The column textColumn in the model of comboBox must be of type G_TYPE_STRING.

This is only relevant if comboBox has been created with ComboBox:hasEntry as True.

Sets the model column which comboBox should use to get string IDs for values from.

The column idColumn in the model of comboBox must be of type G_TYPE_STRING.

Sets the model used by comboBox to be model.

Will unset a previously set model (if applicable). If model is Nothing, then it will unset the model.

Note that this function does not clear the cell renderers, you have to call cellLayoutClear yourself if you need to set up different cell renderers for the new model.

Specifies whether the popup’s width should be a fixed width.

If fixed is True, the popup's width is set to match the allocated width of the combo box.

Sets the row separator function, which is used to determine whether a row should be drawn as a separator.

If the row separator function is Nothing, no separators are drawn. This is the default value.

Construct a GValueConstruct with valid value for the “active” property. This is rarely needed directly, but it is used by new.

Get the value of the “active” property. When overloading is enabled, this is equivalent to

get comboBox #active

Set the value of the “active” property. When overloading is enabled, this is equivalent to

set comboBox [ #active := value ]

Set the value of the “active-id” property to Nothing. When overloading is enabled, this is equivalent to

clear #activeId

Construct a GValueConstruct with valid value for the “active-id” property. This is rarely needed directly, but it is used by new.

Get the value of the “active-id” property. When overloading is enabled, this is equivalent to

get comboBox #activeId

Set the value of the “active-id” property. When overloading is enabled, this is equivalent to

set comboBox [ #activeId := value ]

Construct a GValueConstruct with valid value for the “button-sensitivity” property. This is rarely needed directly, but it is used by new.

Get the value of the “button-sensitivity” property. When overloading is enabled, this is equivalent to

get comboBox #buttonSensitivity

Set the value of the “button-sensitivity” property. When overloading is enabled, this is equivalent to

set comboBox [ #buttonSensitivity := value ]

Set the value of the “child” property to Nothing. When overloading is enabled, this is equivalent to

clear #child

Construct a GValueConstruct with valid value for the “child” property. This is rarely needed directly, but it is used by new.

Get the value of the “child” property. When overloading is enabled, this is equivalent to

get comboBox #child

Set the value of the “child” property. When overloading is enabled, this is equivalent to

set comboBox [ #child := value ]

Construct a GValueConstruct with valid value for the “entry-text-column” property. This is rarely needed directly, but it is used by new.

Get the value of the “entry-text-column” property. When overloading is enabled, this is equivalent to

get comboBox #entryTextColumn

Set the value of the “entry-text-column” property. When overloading is enabled, this is equivalent to

set comboBox [ #entryTextColumn := value ]

Construct a GValueConstruct with valid value for the “has-entry” property. This is rarely needed directly, but it is used by new.

Get the value of the “has-entry” property. When overloading is enabled, this is equivalent to

get comboBox #hasEntry

Construct a GValueConstruct with valid value for the “has-frame” property. This is rarely needed directly, but it is used by new.

Get the value of the “has-frame” property. When overloading is enabled, this is equivalent to

get comboBox #hasFrame

Set the value of the “has-frame” property. When overloading is enabled, this is equivalent to

set comboBox [ #hasFrame := value ]

Construct a GValueConstruct with valid value for the “id-column” property. This is rarely needed directly, but it is used by new.

Get the value of the “id-column” property. When overloading is enabled, this is equivalent to

get comboBox #idColumn

Set the value of the “id-column” property. When overloading is enabled, this is equivalent to

set comboBox [ #idColumn := value ]

Set the value of the “model” property to Nothing. When overloading is enabled, this is equivalent to

clear #model

Construct a GValueConstruct with valid value for the “model” property. This is rarely needed directly, but it is used by new.

Get the value of the “model” property. When overloading is enabled, this is equivalent to

get comboBox #model

Set the value of the “model” property. When overloading is enabled, this is equivalent to

set comboBox [ #model := value ]

Construct a GValueConstruct with valid value for the “popup-fixed-width” property. This is rarely needed directly, but it is used by new.

Get the value of the “popup-fixed-width” property. When overloading is enabled, this is equivalent to

get comboBox #popupFixedWidth

Set the value of the “popup-fixed-width” property. When overloading is enabled, this is equivalent to

set comboBox [ #popupFixedWidth := value ]

Get the value of the “popup-shown” property. When overloading is enabled, this is equivalent to

get comboBox #popupShown

Emitted to when the combo box is activated.

The ::activate signal on GtkComboBox is an action signal and emitting it causes the combo box to pop up its dropdown.

Since: 4.6

Connect a signal handler for the activate signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after comboBox #activate callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

Connect a signal handler for the activate signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on comboBox #activate callback

Emitted when the active item is changed.

The can be due to the user selecting a different item from the list, or due to a call to comboBoxSetActiveIter. It will also be emitted while typing into the entry of a combo box with an entry.

Connect a signal handler for the changed signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after comboBox #changed callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

Connect a signal handler for the changed signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on comboBox #changed callback

Emitted to allow changing how the text in a combo box's entry is displayed.

See ComboBox:hasEntry.

Connect a signal handler which returns an allocated string representing path. That string will then be used to set the text in the combo box's entry. The default signal handler uses the text from the ComboBox:entryTextColumn model column.

Here's an example signal handler which fetches data from the model and displays it in the entry.

c code

static char *
format_entry_text_callback (GtkComboBox *combo,
                            const char *path,
                            gpointer     user_data)
{
  GtkTreeIter iter;
  GtkTreeModel model;
  double       value;

  model = gtk_combo_box_get_model (combo);

  gtk_tree_model_get_iter_from_string (model, &iter, path);
  gtk_tree_model_get (model, &iter,
                      THE_DOUBLE_VALUE_COLUMN, &value,
                      -1);

  return g_strdup_printf ("%g", value);
}

Connect a signal handler for the formatEntryText signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after comboBox #formatEntryText callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

Connect a signal handler for the formatEntryText signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on comboBox #formatEntryText callback

Emitted to move the active selection.

This is an keybinding signal.

Connect a signal handler for the moveActive signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after comboBox #moveActive callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

Connect a signal handler for the moveActive signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on comboBox #moveActive callback

Emitted to popdown the combo box list.

This is an keybinding signal.

The default bindings for this signal are Alt+Up and Escape.

Connect a signal handler for the popdown signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after comboBox #popdown callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

Connect a signal handler for the popdown signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on comboBox #popdown callback

Emitted to popup the combo box list.

This is an keybinding signal.

The default binding for this signal is Alt+Down.

Connect a signal handler for the popup signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after comboBox #popup callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

Connect a signal handler for the popup signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on comboBox #popup callback