ComboBoxText

A GtkComboBoxText is a simple variant of #GtkComboBox that hides the model-view complexity for simple text-only use cases.

To create a GtkComboBoxText, use gtk.combo_box_text.ComboBoxText.new_ or gtk.combo_box_text.ComboBoxText.newWithEntry.

You can add items to a GtkComboBoxText with gtk.combo_box_text.ComboBoxText.appendText, gtk.combo_box_text.ComboBoxText.insertText or gtk.combo_box_text.ComboBoxText.prependText and remove options with gtk.combo_box_text.ComboBoxText.remove.

If the GtkComboBoxText contains an entry (via the “has-entry” property), its contents can be retrieved using gtk.combo_box_text.ComboBoxText.getActiveText. The entry itself can be accessed by calling gtk.bin.Bin.getChild on the combo box.

You should not call gtk.combo_box.ComboBox.setModel or attempt to pack more cells into this combo box via its GtkCellLayout interface.

GtkComboBoxText as GtkBuildable

The GtkComboBoxText implementation of the GtkBuildable interface supports adding items directly using the <items> element and specifying <item> elements for each item. Each <item> element can specify the “id” corresponding to the appended text and also supports the regular translation attributes “translatable”, “context” and “comments”.

Here is a UI definition fragment specifying GtkComboBoxText items:

<object class="GtkComboBoxText">
  <items>
    <item translatable="yes" id="factory">Factory</item>
    <item translatable="yes" id="home">Home</item>
    <item translatable="yes" id="subway">Subway</item>
  </items>
</object>

CSS nodes

combobox
╰── box.linked
    ├── entry.combo
    ├── button.combo
    ╰── window.popup

GtkComboBoxText has a single CSS node with name combobox. It adds the style class .combo to the main CSS nodes of its entry and button children, and the .linked class to the node of its internal box.

class ComboBoxText : ComboBox {

this(void* ptr, Flag!"Take" take);

static GType _getGType();

GType _gType [@property getter];

ComboBoxText self();

static ComboBoxTextGidBuilder builder();

this();

static gtk.combo_box_text.ComboBoxText newWithEntry();

void append(string id, string text);

void appendText(string text);

string getActiveText();

void insert(int position, string id, string text);

void insertText(int position, string text);

void prepend(string id, string text);

void prependText(string text);

void remove(int position);

void removeAll();

}

Constructors

this this(void* ptr, Flag!"Take" take)
this this(): Creates a new #GtkComboBoxText, which is a #GtkComboBox just displaying strings.

Members

Functions

append void append(string id, string text): Appends text to the list of strings stored in combo_box. If id is non-null then it is used as the ID of the row.
appendText void appendText(string text): Appends text to the list of strings stored in combo_box.
getActiveText string getActiveText(): Returns the currently active string in combo_box, or null if none is selected. If combo_box contains an entry, this function will return its contents (which will not necessarily be an item from the list).
insert void insert(int position, string id, string text): Inserts text at position in the list of strings stored in combo_box. If id is non-null then it is used as the ID of the row. See #GtkComboBox:id-column.
insertText void insertText(int position, string text): Inserts text at position in the list of strings stored in combo_box.
prepend void prepend(string id, string text): Prepends text to the list of strings stored in combo_box. If id is non-null then it is used as the ID of the row.
prependText void prependText(string text): Prepends text to the list of strings stored in combo_box.
remove void remove(int position): Removes the string at position from combo_box.
removeAll void removeAll(): Removes all the text entries from the combo box.
self ComboBoxText self(): Returns this, for use in with statements.

Properties

_gType GType _gType [@property getter]

Static functions

_getGType GType _getGType()
builder ComboBoxTextGidBuilder builder(): Get builder for gtk.combo_box_text.ComboBoxText
newWithEntry gtk.combo_box_text.ComboBoxText newWithEntry(): Creates a new #GtkComboBoxText, which is a #GtkComboBox just displaying strings. The combo box created by this function has an entry.

Inherited Members

From ComboBox

_getGType GType _getGType()
_gType GType _gType [@property getter]
self ComboBox self(): Returns this, for use in with statements.
builder ComboBoxGidBuilder builder(): Get builder for gtk.combo_box.ComboBox
active int active [@property getter]: Get active property.
active int active [@property setter]: Set active property.
activeId string activeId [@property getter]: Get activeId property.
activeId string activeId [@property setter]: Set activeId property.
addTearoffs bool addTearoffs [@property getter]: Get addTearoffs property.
addTearoffs bool addTearoffs [@property setter]: Set addTearoffs property.
buttonSensitivity gtk.types.SensitivityType buttonSensitivity [@property getter]: Get buttonSensitivity property.
buttonSensitivity gtk.types.SensitivityType buttonSensitivity [@property setter]: Set buttonSensitivity property.
cellArea gtk.cell_area.CellArea cellArea [@property getter]: Get cellArea property.
columnSpanColumn int columnSpanColumn [@property getter]: Get columnSpanColumn property.
columnSpanColumn int columnSpanColumn [@property setter]: Set columnSpanColumn property.
entryTextColumn int entryTextColumn [@property getter]: Get entryTextColumn property.
entryTextColumn int entryTextColumn [@property setter]: Set entryTextColumn property.
hasEntry bool hasEntry [@property getter]: Get hasEntry property.
hasFrame bool hasFrame [@property getter]: Get hasFrame property.
hasFrame bool hasFrame [@property setter]: Set hasFrame property.
idColumn int idColumn [@property getter]: Get idColumn property.
idColumn int idColumn [@property setter]: Set idColumn property.
model gtk.tree_model.TreeModel model [@property getter]: Get model property.
model gtk.tree_model.TreeModel model [@property setter]: Set model property.
popupFixedWidth bool popupFixedWidth [@property getter]: Get popupFixedWidth property.
popupFixedWidth bool popupFixedWidth [@property setter]: Set popupFixedWidth property.
popupShown bool popupShown [@property getter]: Get popupShown property.
rowSpanColumn int rowSpanColumn [@property getter]: Get rowSpanColumn property.
rowSpanColumn int rowSpanColumn [@property setter]: Set rowSpanColumn property.
tearoffTitle string tearoffTitle [@property getter]: Get tearoffTitle property.
tearoffTitle string tearoffTitle [@property setter]: Set tearoffTitle property.
wrapWidth int wrapWidth [@property getter]: Get wrapWidth property.
wrapWidth int wrapWidth [@property setter]: Set wrapWidth property.
newWithArea gtk.combo_box.ComboBox newWithArea(gtk.cell_area.CellArea area): Creates a new empty #GtkComboBox using area to layout cells.
newWithAreaAndEntry gtk.combo_box.ComboBox newWithAreaAndEntry(gtk.cell_area.CellArea area): Creates a new empty #GtkComboBox with an entry.
newWithEntry gtk.combo_box.ComboBox newWithEntry(): Creates a new empty #GtkComboBox with an entry.
newWithModel gtk.combo_box.ComboBox newWithModel(gtk.tree_model.TreeModel model): Creates a new #GtkComboBox with the model initialized to model.
newWithModelAndEntry gtk.combo_box.ComboBox newWithModelAndEntry(gtk.tree_model.TreeModel model): Creates a new empty #GtkComboBox with an entry and with the model initialized to model.
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.ComboBox.setIdColumn).
getActiveIter bool getActiveIter(gtk.tree_iter.TreeIter iter): Sets iter to point to the currently active item, if any item is active. Otherwise, iter is left unchanged.
getAddTearoffs bool getAddTearoffs(): Gets the current value of the :add-tearoffs property.
getButtonSensitivity gtk.types.SensitivityType 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.
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.ComboBox.setFocusOnClick.
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 gtk.tree_model.TreeModel getModel(): Returns the #GtkTreeModel which is acting as data source for combo_box.
getPopupAccessible atk.object.ObjectWrap 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.
getRowSpanColumn int getRowSpanColumn(): Returns the column with row span information for combo_box.
getTitle string getTitle(): Gets the current title of the menu in tearoff mode. See gtk.combo_box.ComboBox.setAddTearoffs.
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(gdk.device.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(gtk.tree_iter.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(gtk.types.SensitivityType sensitivity): Sets whether the dropdown button of the combo box should be always sensitive (gtk.types.SensitivityType.On), never sensitive (gtk.types.SensitivityType.Off) or only if there is at least one item to display (gtk.types.SensitivityType.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(gtk.tree_model.TreeModel 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(gtk.types.TreeViewRowSeparatorFunc func): 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.
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.
connectChanged gulong connectChanged(T callback, Flag!"After" after): Connect to Changed signal.
connectFormatEntryText gulong connectFormatEntryText(T callback, Flag!"After" after): Connect to FormatEntryText signal.
connectMoveActive gulong connectMoveActive(T callback, Flag!"After" after): Connect to MoveActive signal.
connectPopdown gulong connectPopdown(T callback, Flag!"After" after): Connect to Popdown signal.
connectPopup gulong connectPopup(T callback, Flag!"After" after): Connect to Popup signal.

gtk combo_box_text classes