Gtk.ComboBoxText

g Atk.ImplementorIface Atk.ImplementorIface Gtk.Widget Gtk.Widget Atk.ImplementorIface->Gtk.Widget GObject.GInterface GObject.GInterface GObject.GInterface->Atk.ImplementorIface Gtk.Buildable Gtk.Buildable GObject.GInterface->Gtk.Buildable Gtk.CellEditable Gtk.CellEditable GObject.GInterface->Gtk.CellEditable Gtk.CellLayout Gtk.CellLayout GObject.GInterface->Gtk.CellLayout GObject.InitiallyUnowned GObject.InitiallyUnowned GObject.InitiallyUnowned->Gtk.Widget GObject.Object GObject.Object GObject.Object->GObject.InitiallyUnowned Gtk.Bin Gtk.Bin Gtk.ComboBox Gtk.ComboBox Gtk.Bin->Gtk.ComboBox Gtk.Buildable->Gtk.Widget Gtk.CellEditable->Gtk.ComboBox Gtk.CellLayout->Gtk.ComboBox Gtk.ComboBoxText Gtk.ComboBoxText Gtk.ComboBox->Gtk.ComboBoxText Gtk.Container Gtk.Container Gtk.Container->Gtk.Bin Gtk.Widget->Gtk.Container

Example

../_images/ComboBoxText.png
Subclasses:None

Style Properties

Inherited:Gtk.ComboBox (4), Gtk.Widget (17)

Fields

Inherited:Gtk.ComboBox (5), Gtk.Container (4), Gtk.Widget (69), GObject.Object (1), Gtk.CellEditable (2)
Name Type Access Description
parent_instance Gtk.ComboBox r  

Class Details

class Gtk.ComboBoxText(**kwargs)
Bases:Gtk.ComboBox
Abstract:No
Structure:Gtk.ComboBoxTextClass

A Gtk.ComboBoxText is a simple variant of Gtk.ComboBox that hides the model-view complexity for simple text-only use cases.

To create a Gtk.ComboBoxText, use Gtk.ComboBoxText.new() or Gtk.ComboBoxText.new_with_entry().

You can add items to a Gtk.ComboBoxText with Gtk.ComboBoxText.append_text(), Gtk.ComboBoxText.insert_text() or Gtk.ComboBoxText.prepend_text() and remove options with Gtk.ComboBoxText.remove().

If the Gtk.ComboBoxText contains an entry (via the “has-entry” property), its contents can be retrieved using Gtk.ComboBoxText.get_active_text(). The entry itself can be accessed by calling Gtk.Bin.get_child() on the combo box.

You should not call Gtk.ComboBox.set_model() or attempt to pack more cells into this combo box via its Gtk.CellLayout interface.

Gtk.ComboBoxText as Gtk.Buildable

The Gtk.ComboBoxText implementation of the Gtk.Buildable 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 Gtk.ComboBoxText 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

Gtk.ComboBoxText 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.

classmethod new()[source]
Returns:A new Gtk.ComboBoxText
Return type:Gtk.Widget

Creates a new Gtk.ComboBoxText, which is a Gtk.ComboBox just displaying strings.

New in version 2.24.

classmethod new_with_entry()[source]
Returns:a new Gtk.ComboBoxText
Return type:Gtk.Widget

Creates a new Gtk.ComboBoxText, which is a Gtk.ComboBox just displaying strings. The combo box created by this function has an entry.

New in version 2.24.

append(id, text)[source]
Parameters:
  • id (str or None) – a string ID for this value, or None
  • text (str) – A string

Appends text to the list of strings stored in self. If id is non-None then it is used as the ID of the row.

This is the same as calling Gtk.ComboBoxText.insert() with a position of -1.

New in version 2.24.

append_text(text)[source]
Parameters:text (str) – A string

Appends text to the list of strings stored in self.

This is the same as calling Gtk.ComboBoxText.insert_text() with a position of -1.

New in version 2.24.

get_active_text()[source]
Returns:a newly allocated string containing the currently active text. Must be freed with GLib.free().
Return type:str

Returns the currently active string in self, or None if none is selected. If self contains an entry, this function will return its contents (which will not necessarily be an item from the list).

New in version 2.24.

insert(position, id, text)[source]
Parameters:
  • position (int) – An index to insert text
  • id (str or None) – a string ID for this value, or None
  • text (str) – A string to display

Inserts text at position in the list of strings stored in self. If id is non-None then it is used as the ID of the row. See Gtk.ComboBox :id-column.

If position is negative then text is appended.

New in version 3.0.

insert_text(position, text)[source]
Parameters:
  • position (int) – An index to insert text
  • text (str) – A string

Inserts text at position in the list of strings stored in self.

If position is negative then text is appended.

This is the same as calling Gtk.ComboBoxText.insert() with a None ID string.

New in version 2.24.

prepend(id, text)[source]
Parameters:
  • id (str or None) – a string ID for this value, or None
  • text (str) – a string

Prepends text to the list of strings stored in self. If id is non-None then it is used as the ID of the row.

This is the same as calling Gtk.ComboBoxText.insert() with a position of 0.

New in version 2.24.

prepend_text(text)[source]
Parameters:text (str) – A string

Prepends text to the list of strings stored in self.

This is the same as calling Gtk.ComboBoxText.insert_text() with a position of 0.

New in version 2.24.

remove(position)[source]
Parameters:position (int) – Index of the item to remove

Removes the string at position from self.

New in version 2.24.

remove_all()[source]

Removes all the text entries from the combo box.

New in version 3.0.