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.

A convenience alias for Nothing :: Maybe ComboBox.

Returns the index of the currently active item, or -1 if there’s no 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 TreePath of the active item.

Since: 2.4

Returns the ID of the active row of comboBox. This value is taken from the active row and the column specified by the ComboBox:id-column 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:id-column 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.

Since: 3.0

Sets iter to point to the currently active item, if any item is active. Otherwise, iter is left unchanged.

Since: 2.4

Gets the current value of the :add-tearoffs property.

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

Since: 2.14

Returns the column with column span information for comboBox.

Since: 2.6

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

Since: 2.24

Returns whether the combo box grabs focus when it is clicked with the mouse. See comboBoxSetFocusOnClick.

Since: 2.6

Returns whether the combo box has an entry.

Since: 2.24

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

Since: 3.0

Returns the TreeModel which is acting as data source for comboBox.

Since: 2.4

Gets the accessible object corresponding to the combo box’s popup.

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

Since: 2.6

Gets whether the popup uses a fixed width matching the allocated width of the combo box.

Since: 3.0

Returns the column with row span information for comboBox.

Since: 2.6

Gets the current title of the menu in tearoff mode. See comboBoxSetAddTearoffs.

Since: 2.10

Returns the wrap width which is used to determine the number of columns for the popup menu. If the wrap width is larger than 1, the combo box is in table mode.

Since: 2.6

Creates a new empty ComboBox.

Since: 2.4

Creates a new empty ComboBox using area to layout cells.

Creates a new empty ComboBox with an entry.

The new combo box will use area to layout cells.

Creates a new empty ComboBox with an entry.

Since: 2.24

Creates a new ComboBox with the model initialized to model.

Since: 2.4

Creates a new empty ComboBox with an entry and with the model initialized to model.

Since: 2.24

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.

Since: 2.4

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.

Since: 2.4

Pops up the menu or dropdown list of comboBox, the popup window will be grabbed so only device and its associated pointer/keyboard are the only GdkDevices able to send events to it.

Since: 3.0

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

Since: 2.4

Changes the active row of comboBox to the one that has an ID equal to activeId, or unsets the active row if activeId is Nothing. Rows having a Nothing ID string cannot be made active by this function.

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

Since: 3.0

Sets the current active item to be the one referenced by iter, or unsets the active item if iter is Nothing.

Since: 2.4

Sets whether the popup menu should have a tearoff menu item.

Since: 2.6

Sets whether the dropdown button of the combo box should be always sensitive (SensitivityTypeOn), never sensitive (SensitivityTypeOff) or only if there is at least one item to display (SensitivityTypeAuto).

Since: 2.14

Sets the column with column span information for comboBox to be columnSpan. The column span column contains integers which indicate how many columns an item should span.

Since: 2.4

Sets the model column which comboBox should use to get strings from to be textColumn. 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:has-entry as True.

Since: 2.24

Sets whether the combo box will grab focus when it is clicked with the mouse. Making mouse clicks not grab focus is useful in places like toolbars where you don’t want the keyboard focus removed from the main area of the application.

Since: 2.6

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.

Since: 3.0

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.

Since: 2.4

Specifies whether the popup’s width should be a fixed width matching the allocated width of the combo box.

Since: 3.0

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.

Since: 2.6

Sets the column with row span information for comboBox to be rowSpan. The row span column contains integers which indicate how many rows an item should span.

Since: 2.4

Sets the menu’s title in tearoff mode.

Since: 2.10

Sets the wrap width of comboBox to be width. The wrap width is basically the preferred number of columns when you want the popup to be layed out in a table.

Since: 2.4

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 “add-tearoffs” property. This is rarely needed directly, but it is used by new.

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

get comboBox #addTearoffs

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

set comboBox [ #addTearoffs := 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 ]

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

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

get comboBox #cellArea

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

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

get comboBox #columnSpanColumn

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

set comboBox [ #columnSpanColumn := 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

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

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

get comboBox #rowSpanColumn

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

set comboBox [ #rowSpanColumn := value ]

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

clear #tearoffTitle

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

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

get comboBox #tearoffTitle

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

set comboBox [ #tearoffTitle := value ]

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

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

get comboBox #wrapWidth

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

set comboBox [ #wrapWidth := value ]

Type for the callback on the (unwrapped) C side.

The changed signal is 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.

Since: 2.4

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

Wrap the callback into a GClosure.

Generate a function pointer callable from C code, from a C_ComboBoxChangedCallback.

A convenience synonym for Nothing :: Maybe ComboBoxChangedCallback.

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

Wrap a ComboBoxChangedCallback into a C_ComboBoxChangedCallback.

Type for the callback on the (unwrapped) C side.

For combo boxes that are created with an entry (See GtkComboBox:has-entry).

A signal which allows you to change how the text displayed in a combo box's entry is displayed.

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 GtkComboBox[entryTextColumn](#signal:entryTextColumn) model column.

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

C code

static gchar*
format_entry_text_callback (GtkComboBox *combo,
                            const gchar *path,
                            gpointer     user_data)
{
  GtkTreeIter iter;
  GtkTreeModel model;
  gdouble      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);
}

Since: 3.4

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

Wrap the callback into a GClosure.

Generate a function pointer callable from C code, from a C_ComboBoxFormatEntryTextCallback.

A convenience synonym for Nothing :: Maybe ComboBoxFormatEntryTextCallback.

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

Wrap a ComboBoxFormatEntryTextCallback into a C_ComboBoxFormatEntryTextCallback.

Type for the callback on the (unwrapped) C side.

The moveActive signal is a [keybinding signal][GtkBindingSignal] which gets emitted to move the active selection.

Since: 2.12

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

Wrap the callback into a GClosure.

Generate a function pointer callable from C code, from a C_ComboBoxMoveActiveCallback.

A convenience synonym for Nothing :: Maybe ComboBoxMoveActiveCallback.

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

Wrap a ComboBoxMoveActiveCallback into a C_ComboBoxMoveActiveCallback.

Type for the callback on the (unwrapped) C side.

The popdown signal is a [keybinding signal][GtkBindingSignal] which gets emitted to popdown the combo box list.

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

Since: 2.12

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

Wrap the callback into a GClosure.

Generate a function pointer callable from C code, from a C_ComboBoxPopdownCallback.

A convenience synonym for Nothing :: Maybe ComboBoxPopdownCallback.

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

Wrap a ComboBoxPopdownCallback into a C_ComboBoxPopdownCallback.

Type for the callback on the (unwrapped) C side.

The popup signal is a [keybinding signal][GtkBindingSignal] which gets emitted to popup the combo box list.

The default binding for this signal is Alt+Down.

Since: 2.12

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

Wrap the callback into a GClosure.

Generate a function pointer callable from C code, from a C_ComboBoxPopupCallback.

A convenience synonym for Nothing :: Maybe ComboBoxPopupCallback.

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

Wrap a ComboBoxPopupCallback into a C_ComboBoxPopupCallback.