Class
GtkComboBoxText
deprecated: 4.10
Description [src]
final class Gtk.ComboBoxText : Gtk.ComboBox
implements Gtk.Accessible, Gtk.Buildable, Gtk.CellEditable, Gtk.CellLayout, Gtk.ConstraintTarget {
/* No available fields */
}A GtkComboBoxText is a simple variant of GtkComboBox for text-only
use cases.
GtkComboBoxText hides the model-view complexity of GtkComboBox.
To create a GtkComboBoxText, use gtk_combo_box_text_new() or
gtk_combo_box_text_new_with_entry().
You can add items to a GtkComboBoxText with
gtk_combo_box_text_append_text(),
gtk_combo_box_text_insert_text() or
gtk_combo_box_text_prepend_text() and remove options with
gtk_combo_box_text_remove().
If the GtkComboBoxText contains an entry (via the
GtkComboBox:has-entry property), its contents can be retrieved
using gtk_combo_box_text_get_active_text().
You should not call gtk_combo_box_set_model() 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.
Deprecated since: 4.10
Use GtkDropDown with a GtkStringList instead.
Instance methods
gtk_combo_box_text_append_text
Appends text to the list of strings stored in combo_box.
deprecated: 4.10
gtk_combo_box_text_get_active_text
Returns the currently active string in combo_box.
deprecated: 4.10
gtk_combo_box_text_insert
Inserts text at position in the list of strings stored in combo_box.
deprecated: 4.10
gtk_combo_box_text_insert_text
Inserts text at position in the list of strings stored in combo_box.
deprecated: 4.10
gtk_combo_box_text_prepend
Prepends text to the list of strings stored in combo_box.
deprecated: 4.10
gtk_combo_box_text_prepend_text
Prepends text to the list of strings stored in combo_box.
deprecated: 4.10
Methods inherited from GtkComboBox (24)
Please see GtkComboBox for a full list of methods.
Methods inherited from GtkAccessible (19)
gtk_accessible_announce
Requests the user’s screen reader to announce the given message.
since: 4.14
gtk_accessible_get_accessible_parent
Retrieves the accessible parent for an accessible object.
since: 4.10
gtk_accessible_get_accessible_role
Retrieves the accessible role of an accessible object.
gtk_accessible_get_at_context
Retrieves the implementation for the given accessible object.
since: 4.10
gtk_accessible_get_bounds
Queries the coordinates and dimensions of this accessible.
since: 4.10
gtk_accessible_get_first_accessible_child
Retrieves the first accessible child of an accessible object.
since: 4.10
gtk_accessible_get_next_accessible_sibling
Retrieves the next accessible sibling of an accessible object.
since: 4.10
gtk_accessible_get_platform_state
Queries a platform state, such as focus.
since: 4.10
gtk_accessible_reset_property
Resets the accessible property to its default value.
gtk_accessible_reset_relation
Resets the accessible relation to its default value.
gtk_accessible_reset_state
Resets the accessible state to its default value.
gtk_accessible_set_accessible_parent
Sets the parent and sibling of an accessible object.
since: 4.10
gtk_accessible_update_next_accessible_sibling
Updates the next accessible sibling.
since: 4.10
gtk_accessible_update_property
Updates a list of accessible properties.
gtk_accessible_update_property_value
Updates an array of accessible properties.
gtk_accessible_update_relation
Updates a list of accessible relations.
gtk_accessible_update_relation_value
Updates an array of accessible relations.
gtk_accessible_update_state
Updates a list of accessible states.
gtk_accessible_update_state_value
Updates an array of accessible states.
Methods inherited from GtkBuildable (1)
Methods inherited from GtkCellEditable (3)
gtk_cell_editable_editing_done
Emits the GtkCellEditable::editing-done signal.
deprecated: 4.10
gtk_cell_editable_remove_widget
Emits the GtkCellEditable::remove-widget signal.
deprecated: 4.10
gtk_cell_editable_start_editing
Begins editing on a cell_editable.
Methods inherited from GtkCellLayout (10)
gtk_cell_layout_add_attribute
Adds an attribute mapping to the list in cell_layout.
deprecated: 4.10
gtk_cell_layout_clear
Unsets all the mappings on all renderers on cell_layout and
removes all renderers from cell_layout.
deprecated: 4.10
gtk_cell_layout_clear_attributes
Clears all existing attributes previously set with gtk_cell_layout_set_attributes().
deprecated: 4.10
gtk_cell_layout_get_area
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.
deprecated: 4.10
gtk_cell_layout_get_cells
Returns the cell renderers which have been added to cell_layout.
deprecated: 4.10
gtk_cell_layout_pack_end
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.
deprecated: 4.10
gtk_cell_layout_pack_start
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.
deprecated: 4.10
gtk_cell_layout_reorder
Re-inserts cell at position.
deprecated: 4.10
gtk_cell_layout_set_attributes
Sets the attributes in the parameter list as the attributes
of cell_layout.
deprecated: 4.10
gtk_cell_layout_set_cell_data_func
Sets the GtkCellLayoutDataFunc to use for cell_layout.
deprecated: 4.10
Properties
Properties inherited from GtkComboBox (11)
Gtk.ComboBox:active
The item which is currently active.
Gtk.ComboBox:active-id
The value of the ID column of the active row.
Gtk.ComboBox:button-sensitivity
Whether the dropdown button is sensitive when the model is empty.
Gtk.ComboBox:child
The child widget.
Gtk.ComboBox:entry-text-column
The model column to associate with strings from the entry.
Gtk.ComboBox:has-entry
Whether the combo box has an entry.
Gtk.ComboBox:has-frame
The has-frame property controls whether a frame is drawn around the entry.
Gtk.ComboBox:id-column
The model column that provides string IDs for the values in the model, if != -1.
Gtk.ComboBox:model
The model from which the combo box takes its values.
Gtk.ComboBox:popup-fixed-width
Whether the popup’s width should be a fixed width matching the allocated width of the combo box.
Gtk.ComboBox:popup-shown
Whether the combo boxes dropdown is popped up.
Properties inherited from GtkWidget (34)
Gtk.Widget:can-focus
Whether the widget or any of its descendents can accept the input focus.
Gtk.Widget:can-target
Whether the widget can receive pointer events.
Gtk.Widget:css-classes
A list of css classes applied to this widget.
Gtk.Widget:css-name
The name of this widget in the CSS tree.
Gtk.Widget:cursor
The cursor used by widget.
Gtk.Widget:focus-on-click
Whether the widget should grab focus when it is clicked with the mouse.
Gtk.Widget:focusable
Whether this widget itself will accept the input focus.
Gtk.Widget:halign
How to distribute horizontal space if widget gets extra space.
Gtk.Widget:has-default
Whether the widget is the default widget.
Gtk.Widget:has-focus
Whether the widget has the input focus.
Gtk.Widget:has-tooltip
Enables or disables the emission of the GtkWidget::query-tooltip
signal on widget.
Gtk.Widget:height-request
Overrides for height request of the widget.
Gtk.Widget:hexpand
Whether to expand horizontally.
Gtk.Widget:hexpand-set
Whether to use the hexpand property.
Gtk.Widget:layout-manager
The GtkLayoutManager instance to use to compute
the preferred size of the widget, and allocate its children.
Gtk.Widget:margin-bottom
Margin on bottom side of widget.
Gtk.Widget:margin-end
Margin on end of widget, horizontally.
Gtk.Widget:margin-start
Margin on start of widget, horizontally.
Gtk.Widget:margin-top
Margin on top side of widget.
Gtk.Widget:name
The name of the widget.
Gtk.Widget:opacity
The requested opacity of the widget.
Gtk.Widget:overflow
How content outside the widget’s content area is treated.
Gtk.Widget:parent
The parent widget of this widget.
Gtk.Widget:receives-default
Whether the widget will receive the default action when it is focused.
Gtk.Widget:root
The GtkRoot widget of the widget tree containing this widget.
Gtk.Widget:scale-factor
The scale factor of the widget.
Gtk.Widget:sensitive
Whether the widget responds to input.
Gtk.Widget:tooltip-markup
Sets the text of tooltip to be the given string, which is marked up with Pango markup.
Gtk.Widget:tooltip-text
Sets the text of tooltip to be the given string.
Gtk.Widget:valign
How to distribute vertical space if widget gets extra space.
Gtk.Widget:vexpand
Whether to expand vertically.
Gtk.Widget:vexpand-set
Whether to use the vexpand property.
Gtk.Widget:visible
Whether the widget is visible.
Gtk.Widget:width-request
Overrides for width request of the widget.
Properties inherited from GtkAccessible (1)
Properties inherited from GtkCellEditable (1)
Signals
Signals inherited from GtkComboBox (6)
GtkComboBox::activate
Emitted to when the combo box is activated.
since: 4.6
GtkComboBox::changed
Emitted when the active item is changed.
GtkComboBox::format-entry-text
Emitted to allow changing how the text in a combo box’s entry is displayed.
GtkComboBox::move-active
Emitted to move the active selection.
GtkComboBox::popdown
Emitted to popdown the combo box list.
GtkComboBox::popup
Emitted to popup the combo box list.
Signals inherited from GtkWidget (13)
GtkWidget::destroy
Signals that all holders of a reference to the widget should release the reference that they hold.
GtkWidget::direction-changed
Emitted when the text direction of a widget changes.
GtkWidget::hide
Emitted when widget is hidden.
GtkWidget::keynav-failed
Emitted if keyboard navigation fails.
GtkWidget::map
Emitted when widget is going to be mapped.
GtkWidget::mnemonic-activate
Emitted when a widget is activated via a mnemonic.
GtkWidget::move-focus
Emitted when the focus is moved.
GtkWidget::query-tooltip
Emitted when the widget’s tooltip is about to be shown.
GtkWidget::realize
Emitted when widget is associated with a GdkSurface.
GtkWidget::show
Emitted when widget is shown.
GtkWidget::state-flags-changed
Emitted when the widget state changes.
GtkWidget::unmap
Emitted when widget is going to be unmapped.
GtkWidget::unrealize
Emitted when the GdkSurface associated with widget is destroyed.
Signals inherited from GObject (1)
GObject::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.
Signals inherited from GtkCellEditable (2)
GtkCellEditable::editing-done
This signal is a sign for the cell renderer to update its
value from the cell_editable.
GtkCellEditable::remove-widget
This signal is meant to indicate that the cell is finished
editing, and the cell_editable widget is being removed and may
subsequently be destroyed.