ComboBox

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 Windows-style combo box.

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.

To allow the user to enter values not in the model, the “has-entry” property allows the GtkComboBox to contain a #GtkEntry. This entry can be accessed by calling gtk_bin_get_child() on the combo box.

For a simple list of textual choices, the model-view API of GtkComboBox can be a bit overwhelming. In this case, #GtkComboBoxText offers a simple alternative. Both GtkComboBox and #GtkComboBoxText can contain an entry.

CSS nodes

|[ combobox ├── box.linked │ ╰── button.combo │ ╰── box │ ├── cellview │ ╰── arrow ╰── window.popup ]|

A normal combobox contains a box with the .linked class, a button with the .combo class and inside those buttons, there are a cellview and an arrow.

|[ combobox ├── box.linked │ ├── entry.combo │ ╰── button.combo │ ╰── box │ ╰── arrow ╰── window.popup ]|

A GtkComboBox with an entry has a single CSS node with name combobox. It contains a bx with the .linked class and that box contains an entry and a button, both with the .combo class added. The button also contains another node with name arrow.

class ComboBox : Bin , CellEditableIF , CellLayoutIF {

GtkComboBox* gtkComboBox;

GtkComboBox* getComboBoxStruct();

void* getStruct();

void setStruct(GObject* obj);

this(GtkComboBox* gtkComboBox, bool ownedRef);

mixin CellEditableT!(GtkComboBox) ;

mixin CellLayoutT!(GtkComboBox) ;

this(bool entry);

this(TreeModelIF model, bool entry);

this(CellArea area, bool entry);

static GType getType();

int getActive();

string getActiveId();

bool getActiveIter(TreeIter iter);

bool getAddTearoffs();

GtkSensitivityType getButtonSensitivity();

int getColumnSpanColumn();

int getEntryTextColumn();

bool getFocusOnClick();

bool getHasEntry();

int getIdColumn();

TreeModelIF getModel();

ObjectAtk getPopupAccessible();

bool getPopupFixedWidth();

GtkTreeViewRowSeparatorFunc getRowSeparatorFunc();

int getRowSpanColumn();

string getTitle();

int getWrapWidth();

void popdown();

void popup();

void popupForDevice(Device device);

void setActive(int index);

bool setActiveId(string activeId);

void setActiveIter(TreeIter iter);

void setAddTearoffs(bool addTearoffs);

void setButtonSensitivity(GtkSensitivityType sensitivity);

void setColumnSpanColumn(int columnSpan);

void setEntryTextColumn(int textColumn);

void setFocusOnClick(bool focusOnClick);

void setIdColumn(int idColumn);

void setModel(TreeModelIF model);

void setPopupFixedWidth(bool fixed);

void setRowSeparatorFunc(GtkTreeViewRowSeparatorFunc func, void* data, GDestroyNotify destroy);

void setRowSpanColumn(int rowSpan);

void setTitle(string title);

void setWrapWidth(int width);

int[string] connectedSignals;

void delegate(ComboBox)[] onChangedListeners;

void addOnChanged(void delegate(ComboBox) dlg, ConnectFlags connectFlags);

static void callBackChanged(GtkComboBox* comboboxStruct, ComboBox _combobox);

string delegate(string, ComboBox)[] onFormatEntryTextListeners;

void addOnFormatEntryText(string delegate(string, ComboBox) dlg, ConnectFlags connectFlags);

static string callBackFormatEntryText(GtkComboBox* comboboxStruct, char* path, ComboBox _combobox);

void delegate(GtkScrollType, ComboBox)[] onMoveActiveListeners;

void addOnMoveActive(void delegate(GtkScrollType, ComboBox) dlg, ConnectFlags connectFlags);

static void callBackMoveActive(GtkComboBox* comboboxStruct, GtkScrollType scrollType, ComboBox _combobox);

bool delegate(ComboBox)[] onPopdownListeners;

void addOnPopdown(bool delegate(ComboBox) dlg, ConnectFlags connectFlags);

static int callBackPopdown(GtkComboBox* comboboxStruct, ComboBox _combobox);

void delegate(ComboBox)[] onPopupListeners;

void addOnPopup(void delegate(ComboBox) dlg, ConnectFlags connectFlags);

static void callBackPopup(GtkComboBox* comboboxStruct, ComboBox _combobox);

}

Constructors

this this(GtkComboBox* gtkComboBox, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(bool entry): Creates a new empty GtkComboBox.
this this(TreeModelIF model, bool entry): Creates a new GtkComboBox with the model initialized to model.
this this(CellArea area, bool entry): Creates a new empty GtkComboBox using area to layout cells.

Members

Functions

addOnChanged void addOnChanged(void delegate(ComboBox) dlg, ConnectFlags connectFlags): 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 gtk_combo_box_set_active_iter(). It will also be emitted while typing into the entry of a combo box with an entry.
addOnFormatEntryText void addOnFormatEntryText(string delegate(string, ComboBox) dlg, ConnectFlags connectFlags): For combo boxes that are created with an entry (See GtkComboBox:has-entry).
addOnMoveActive void addOnMoveActive(void delegate(GtkScrollType, ComboBox) dlg, ConnectFlags connectFlags): The ::move-active signal is a [keybinding signal]GtkBindingSignal which gets emitted to move the active selection.
addOnPopdown void addOnPopdown(bool delegate(ComboBox) dlg, ConnectFlags connectFlags): The ::popdown signal is a [keybinding signal]GtkBindingSignal which gets emitted to popdown the combo box list.
addOnPopup void addOnPopup(void delegate(ComboBox) dlg, ConnectFlags connectFlags): The ::popup signal is a [keybinding signal]GtkBindingSignal which gets emitted to popup the combo box list.
getActive int getActive(): 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 #GtkTreePath of the active item.
getActiveId string getActiveId(): Returns the ID of the active row of @combo_box. This value is taken from the active row and the column specified by the #GtkComboBox:id-column property of @combo_box (see gtk_combo_box_set_id_column()).
getActiveIter bool getActiveIter(TreeIter iter): Sets @iter to point to the current active item, if it exists.
getAddTearoffs bool getAddTearoffs(): Gets the current value of the :add-tearoffs property.
getButtonSensitivity GtkSensitivityType getButtonSensitivity(): Returns whether the combo box sets the dropdown button sensitive or not when there are no items in the model.
getColumnSpanColumn int getColumnSpanColumn(): Returns the column with column span information for @combo_box.
getComboBoxStruct GtkComboBox* getComboBoxStruct(): Get the main Gtk struct
getEntryTextColumn int getEntryTextColumn(): Returns the column which @combo_box is using to get the strings from to display in the internal entry.
getFocusOnClick bool getFocusOnClick(): Returns whether the combo box grabs focus when it is clicked with the mouse. See gtk_combo_box_set_focus_on_click().
getHasEntry bool getHasEntry(): Returns whether the combo box has an entry.
getIdColumn int getIdColumn(): Returns the column which @combo_box is using to get string IDs for values from.
getModel TreeModelIF getModel(): Returns the #GtkTreeModel which is acting as data source for @combo_box.
getPopupAccessible ObjectAtk getPopupAccessible(): Gets the accessible object corresponding to the combo box’s popup.
getPopupFixedWidth bool getPopupFixedWidth(): Gets whether the popup uses a fixed width matching the allocated width of the combo box.
getRowSeparatorFunc GtkTreeViewRowSeparatorFunc getRowSeparatorFunc(): Returns the current row separator function.
getRowSpanColumn int getRowSpanColumn(): Returns the column with row span information for @combo_box.
getStruct void* getStruct(): the main Gtk struct as a void*
getTitle string getTitle(): Gets the current title of the menu in tearoff mode. See gtk_combo_box_set_add_tearoffs().
getWrapWidth int getWrapWidth(): 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.
popdown void popdown(): Hides the menu or dropdown list of @combo_box.
popup void popup(): Pops up the menu or dropdown list of @combo_box.
popupForDevice void popupForDevice(Device device): Pops up the menu or dropdown list of @combo_box, the popup window will be grabbed so only @device and its associated pointer/keyboard are the only #GdkDevices able to send events to it.
setActive void setActive(int index): Sets the active item of @combo_box to be the item at @index.
setActiveId bool setActiveId(string activeId): Changes the active row of @combo_box to the one that has an ID equal to @active_id, or unsets the active row if @active_id is %NULL. Rows having a %NULL ID string cannot be made active by this function.
setActiveIter void setActiveIter(TreeIter iter): Sets the current active item to be the one referenced by @iter, or unsets the active item if @iter is %NULL.
setAddTearoffs void setAddTearoffs(bool addTearoffs): Sets whether the popup menu should have a tearoff menu item.
setButtonSensitivity void setButtonSensitivity(GtkSensitivityType sensitivity): Sets whether the dropdown button of the combo box should be always sensitive (%GTK_SENSITIVITY_ON), never sensitive (%GTK_SENSITIVITY_OFF) or only if there is at least one item to display (%GTK_SENSITIVITY_AUTO).
setColumnSpanColumn void setColumnSpanColumn(int columnSpan): Sets the column with column span information for @combo_box to be @column_span. The column span column contains integers which indicate how many columns an item should span.
setEntryTextColumn void setEntryTextColumn(int textColumn): Sets the model column which @combo_box should use to get strings from to be @text_column. The column @text_column in the model of @combo_box must be of type %G_TYPE_STRING.
setFocusOnClick void setFocusOnClick(bool focusOnClick): 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.
setIdColumn void setIdColumn(int idColumn): Sets the model column which @combo_box should use to get string IDs for values from. The column @id_column in the model of @combo_box must be of type %G_TYPE_STRING.
setModel void setModel(TreeModelIF model): Sets the model used by @combo_box to be @model. Will unset a previously set model (if applicable). If model is %NULL, then it will unset the model.
setPopupFixedWidth void setPopupFixedWidth(bool fixed): Specifies whether the popup’s width should be a fixed width matching the allocated width of the combo box.
setRowSeparatorFunc void setRowSeparatorFunc(GtkTreeViewRowSeparatorFunc func, void* data, GDestroyNotify destroy): 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 %NULL, no separators are drawn. This is the default value.
setRowSpanColumn void setRowSpanColumn(int rowSpan): Sets the column with row span information for @combo_box to be @row_span. The row span column contains integers which indicate how many rows an item should span.
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.
setTitle void setTitle(string title): Sets the menu’s title in tearoff mode.
setWrapWidth void setWrapWidth(int width): Sets the wrap width of @combo_box 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.

Mixins

__anonymous mixin CellEditableT!(GtkComboBox): Undocumented in source.
__anonymous mixin CellLayoutT!(GtkComboBox): Undocumented in source.

Static functions

callBackChanged void callBackChanged(GtkComboBox* comboboxStruct, ComboBox _combobox): Undocumented in source. Be warned that the author may not have intended to support it.
callBackFormatEntryText string callBackFormatEntryText(GtkComboBox* comboboxStruct, char* path, ComboBox _combobox): Undocumented in source. Be warned that the author may not have intended to support it.
callBackMoveActive void callBackMoveActive(GtkComboBox* comboboxStruct, GtkScrollType scrollType, ComboBox _combobox): Undocumented in source. Be warned that the author may not have intended to support it.
callBackPopdown int callBackPopdown(GtkComboBox* comboboxStruct, ComboBox _combobox): Undocumented in source. Be warned that the author may not have intended to support it.
callBackPopup void callBackPopup(GtkComboBox* comboboxStruct, ComboBox _combobox): Undocumented in source. Be warned that the author may not have intended to support it.
getType GType getType()

Variables

connectedSignals int[string] connectedSignals;: Undocumented in source.
gtkComboBox GtkComboBox* gtkComboBox;: the main Gtk struct
onChangedListeners void delegate(ComboBox)[] onChangedListeners;: Undocumented in source.
onFormatEntryTextListeners string delegate(string, ComboBox)[] onFormatEntryTextListeners;: Undocumented in source.
onMoveActiveListeners void delegate(GtkScrollType, ComboBox)[] onMoveActiveListeners;: Undocumented in source.
onPopdownListeners bool delegate(ComboBox)[] onPopdownListeners;: Undocumented in source.
onPopupListeners void delegate(ComboBox)[] onPopupListeners;: Undocumented in source.

Inherited Members

From Bin

gtkBin GtkBin* gtkBin;: the main Gtk struct
getBinStruct GtkBin* getBinStruct(): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
setStruct void setStruct(GObject* obj): Undocumented in source. Be warned that the author may not have intended to support it.
getType GType getType()
getChild Widget getChild(): Gets the child of the #GtkBin, or %NULL if the bin contains no child widget. The returned widget does not have a reference added, so you do not need to unref it.

From CellEditableIF

getCellEditableStruct GtkCellEditable* getCellEditableStruct(): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
editingDone void editingDone(): Emits the #GtkCellEditable::editing-done signal.
removeWidget void removeWidget(): Emits the #GtkCellEditable::remove-widget signal.
startEditing void startEditing(Event event): Begins editing on a @cell_editable. @event is the #GdkEvent that began the editing process. It may be %NULL, in the instance that editing was initiated through programatic means.
onEditingDoneListeners void delegate(CellEditableIF)[] onEditingDoneListeners [@property getter]: Undocumented in source.
addOnEditingDone void addOnEditingDone(void delegate(CellEditableIF) dlg, ConnectFlags connectFlags): This signal is a sign for the cell renderer to update its value from the @cell_editable.
onRemoveWidgetListeners void delegate(CellEditableIF)[] onRemoveWidgetListeners [@property getter]: Undocumented in source.
addOnRemoveWidget void addOnRemoveWidget(void delegate(CellEditableIF) dlg, ConnectFlags connectFlags): This signal is meant to indicate that the cell is finished editing, and the widget may now be destroyed.

From CellLayoutIF

getCellLayoutStruct GtkCellLayout* getCellLayoutStruct(): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
addAttribute void addAttribute(CellRenderer cell, string attribute, int column): Adds an attribute mapping to the list in @cell_layout.
clear void clear(): Unsets all the mappings on all renderers on @cell_layout and removes all renderers from @cell_layout.
clearAttributes void clearAttributes(CellRenderer cell): Clears all existing attributes previously set with gtk_cell_layout_set_attributes().
getArea CellArea getArea(): Returns the underlying #GtkCellArea which might be @cell_layout if called on a #GtkCellArea or might be %NULL if no #GtkCellArea is used by @cell_layout.
getCells ListG getCells(): Returns the cell renderers which have been added to @cell_layout.
packEnd void packEnd(CellRenderer cell, bool expand): Adds the @cell to the end of @cell_layout. If @expand is %FALSE, then the @cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which @expand is %TRUE.
packStart void packStart(CellRenderer cell, bool expand): Packs the @cell into the beginning of @cell_layout. If @expand is %FALSE, then the @cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which @expand is %TRUE.
reorder void reorder(CellRenderer cell, int position): Re-inserts @cell at @position.
setCellDataFunc void setCellDataFunc(CellRenderer cell, GtkCellLayoutDataFunc func, void* funcData, GDestroyNotify destroy): Sets the #GtkCellLayoutDataFunc to use for @cell_layout.

Meta

Source

See Implementation

gtk ComboBox classes

ComboBox