ComboBoxEntry

Description A GtkComboBoxEntry is a widget that allows the user to choose from a list of valid choices or enter a different value. It is very similar to a GtkComboBox, but it displays the selected value in an entry to allow modifying it. In contrast to a GtkComboBox, the underlying model of a GtkComboBoxEntry must always have a text column (see gtk_combo_box_entry_set_text_column()), and the entry will show the content of the text column in the selected row. To get the text from the entry, use gtk_combo_box_get_active_text(). The changed signal will be emitted while typing into a GtkComboBoxEntry, as well as when selecting an item from the GtkComboBoxEntry's list. Use gtk_combo_box_get_active() or gtk_combo_box_get_active_iter() to discover whether an item was actually selected from the list. Connect to the activate signal of the GtkEntry (use gtk_bin_get_child()) to detect when the user actually finishes entering text. The convenience API to construct simple text-only GtkComboBoxes can also be used with GtkComboBoxEntrys which have been constructed with gtk_combo_box_entry_new_text(). If you have special needs that go beyond a simple entry (e.g. input validation), it is possible to replace the child entry by a different widget using gtk_container_remove() and gtk_container_add(). GtkComboBoxEntry as GtkBuildable Beyond the <attributes> support that is shared by all GtkCellLayout implementation, GtkComboBoxEntry makes the entry available in UI definitions as an internal child with name "entry".

Constructors

this
this(GtkComboBoxEntry* gtkComboBoxEntry)

Sets our main struct and passes it to the parent class

this
this(bool text)

Creates a new GtkComboBoxEntry which has a GtkEntry as child. After construction, you should set a model using gtk_combo_box_set_model() and a text_column * using gtk_combo_box_entry_set_text_column(). Since 2.4

this
this(TreeModelIF model, int textColumn)

Warning gtk_combo_box_entry_new_with_model has been deprecated since version 2.24 and should not be used in newly-written code. Use gtk_combo_box_new_with_model_and_entry() instead Creates a new GtkComboBoxEntry which has a GtkEntry as child and a list of strings as popup. You can get the GtkEntry from a GtkComboBoxEntry using GTK_ENTRY (GTK_BIN (combo_box_entry)->child). To add and remove strings from the list, just modify model using its data manipulation API. Since 2.4

Members

Functions

getComboBoxEntryStruct
GtkComboBoxEntry* getComboBoxEntryStruct()
Undocumented in source. Be warned that the author may not have intended to support it.
getStruct
void* getStruct()

the main Gtk struct as a void*

getTextColumn
int getTextColumn()

Warning gtk_combo_box_entry_get_text_column has been deprecated since version 2.24 and should not be used in newly-written code. Use gtk_combo_box_get_entry_text_column() instead Returns the column which entry_box is using to get the strings from. Since 2.4

setStruct
void setStruct(GObject* obj)
Undocumented in source. Be warned that the author may not have intended to support it.
setTextColumn
void setTextColumn(int textColumn)

Warning gtk_combo_box_entry_set_text_column has been deprecated since version 2.24 and should not be used in newly-written code. Use gtk_combo_box_set_entry_text_column() instead Sets the model column which entry_box should use to get strings from to be text_column. Since 2.4

Variables

gtkComboBoxEntry
GtkComboBoxEntry* gtkComboBoxEntry;

the main Gtk struct

Inherited Members

From ComboBox

gtkComboBox
GtkComboBox* gtkComboBox;

the main Gtk struct

getComboBoxStruct
GtkComboBox* getComboBoxStruct()
Undocumented in source. Be warned that the author may not have intended to support it.
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.
maxCount
int maxCount;
Undocumented in source.
__anonymous
mixin CellLayoutT!(GtkComboBox)
Undocumented in source.
__anonymous
mixin CellEditableT!(GtkComboBox)
Undocumented in source.
setActiveText
void setActiveText(string text, bool insert)
getIndex
int getIndex(string text)
prependOrReplaceText
void prependOrReplaceText(string text)
connectedSignals
int[string] connectedSignals;
onChangedListeners
void delegate(ComboBox)[] onChangedListeners;
Undocumented in source.
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 a GtkComboBoxEntry, as well as when selecting an item from the GtkComboBoxEntry's list. Since 2.4

callBackChanged
void callBackChanged(GtkComboBox* widgetStruct, ComboBox _comboBox)
Undocumented in source. Be warned that the author may not have intended to support it.
onMoveActiveListeners
void delegate(GtkScrollType, ComboBox)[] onMoveActiveListeners;
Undocumented in source.
addOnMoveActive
void addOnMoveActive(void delegate(GtkScrollType, ComboBox) dlg, ConnectFlags connectFlags)

The ::move-active signal is a keybinding signal which gets emitted to move the active selection. Since 2.12

callBackMoveActive
void callBackMoveActive(GtkComboBox* widgetStruct, GtkScrollType scrollType, ComboBox _comboBox)
Undocumented in source. Be warned that the author may not have intended to support it.
onPopdownListeners
bool delegate(ComboBox)[] onPopdownListeners;
Undocumented in source.
addOnPopdown
void addOnPopdown(bool delegate(ComboBox) dlg, ConnectFlags connectFlags)

The ::popdown signal is a keybinding signal which gets emitted to popdown the combo box list. The default bindings for this signal are Alt+Up and Escape. Since 2.12

callBackPopdown
gboolean callBackPopdown(GtkComboBox* buttonStruct, ComboBox _comboBox)
Undocumented in source. Be warned that the author may not have intended to support it.
onPopupListeners
void delegate(ComboBox)[] onPopupListeners;
Undocumented in source.
addOnPopup
void addOnPopup(void delegate(ComboBox) dlg, ConnectFlags connectFlags)

The ::popup signal is a keybinding signal which gets emitted to popup the combo box list. The default binding for this signal is Alt+Down. Since 2.12 See Also GtkComboBoxText, GtkTreeModel, GtkCellRenderer

callBackPopup
void callBackPopup(GtkComboBox* widgetStruct, ComboBox _comboBox)
Undocumented in source. Be warned that the author may not have intended to support it.
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. Since 2.6

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. Since 2.4

getRowSpanColumn
int getRowSpanColumn()

Returns the column with row span information for combo_box. Since 2.6

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. Since 2.4

getColumnSpanColumn
int getColumnSpanColumn()

Returns the column with column span information for combo_box. Since 2.6

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. Since 2.4

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. Since 2.4

setActive
void setActive(int index)

Sets the active item of combo_box to be the item at index. Since 2.4

getActiveIter
int getActiveIter(TreeIter iter)

Sets iter to point to the current active item, if it exists. Since 2.4

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. Since 2.4

getModel
TreeModelIF getModel()

Returns the GtkTreeModel which is acting as data source for combo_box. Since 2.4

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. Note that this function does not clear the cell renderers, you have to call gtk_cell_layout_clear() yourself if you need to set up different cell renderers for the new model. Since 2.4

appendText
void appendText(string text)

Warning gtk_combo_box_append_text has been deprecated since version 2.24 and should not be used in newly-written code. Use GtkComboBoxText Appends string to the list of strings stored in combo_box. Note that you can only use this function with combo boxes constructed with gtk_combo_box_new_text(). Since 2.4

insertText
void insertText(int position, string text)

Warning gtk_combo_box_insert_text has been deprecated since version 2.24 and should not be used in newly-written code. Use GtkComboBoxText Inserts string at position in the list of strings stored in combo_box. Note that you can only use this function with combo boxes constructed with gtk_combo_box_new_text(). Since 2.4

prependText
void prependText(string text)

Warning gtk_combo_box_prepend_text has been deprecated since version 2.24 and should not be used in newly-written code. Use GtkComboBoxText Prepends string to the list of strings stored in combo_box. Note that you can only use this function with combo boxes constructed with gtk_combo_box_new_text(). Since 2.4

removeText
void removeText(int position)

Warning gtk_combo_box_remove_text has been deprecated since version 2.24 and should not be used in newly-written code. Use GtkComboBoxText Removes the string at position from combo_box. Note that you can only use this function with combo boxes constructed with gtk_combo_box_new_text(). Since 2.4

getActiveText
string getActiveText()

Warning gtk_combo_box_get_active_text has been deprecated since version 2.24 and should not be used in newly-written code. If you used this with a GtkComboBox constructed with gtk_combo_box_new_text() then you should now use GtkComboBoxText and gtk_combo_box_text_get_active_text() instead. Or if you used this with a GtkComboBoxEntry then you should now use GtkComboBox with "has-entry" as TRUE and use gtk_entry_get_text (GTK_ENTRY (gtk_bin_get_child (GTK_BIN (combobox))). Returns the currently active string in combo_box or NULL if none is selected. Note that you can only use this function with combo boxes constructed with gtk_combo_box_new_text() and with GtkComboBoxEntrys. Since 2.6

popup
void popup()

Pops up the menu or dropdown list of combo_box. This function is mostly intended for use by accessibility technologies; applications should have little use for it. Since 2.4

popdown
void popdown()

Hides the menu or dropdown list of combo_box. This function is mostly intended for use by accessibility technologies; applications should have little use for it. Since 2.4

getPopupAccessible
ObjectAtk getPopupAccessible()

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

getRowSeparatorFunc
GtkTreeViewRowSeparatorFunc getRowSeparatorFunc()

Returns the current row separator function. Since 2.6

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. Since 2.6

setAddTearoffs
void setAddTearoffs(int addTearoffs)

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

getAddTearoffs
int getAddTearoffs()

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

setTitle
void setTitle(string title)

Sets the menu's title in tearoff mode. Since 2.10

getTitle
string getTitle()

Gets the current title of the menu in tearoff mode. See gtk_combo_box_set_add_tearoffs(). Since 2.10

setFocusOnClick
void setFocusOnClick(int 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. Since 2.6

getFocusOnClick
int getFocusOnClick()

Returns whether the combo box grabs focus when it is clicked with the mouse. See gtk_combo_box_set_focus_on_click(). Since 2.6

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). Since 2.14

getButtonSensitivity
GtkSensitivityType getButtonSensitivity()

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

getHasEntry
int getHasEntry()

Returns whether the combo box has an entry. Since 2.24

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. This is only relevant if combo_box has been created with "has-entry" as TRUE. Since 2.24

getEntryTextColumn
int getEntryTextColumn()

Returns the column which combo_box is using to get the strings from to display in the internal entry. Since 2.24

Meta