Gtk.CellRendererCombo

g GObject.InitiallyUnowned GObject.InitiallyUnowned Gtk.CellRenderer Gtk.CellRenderer GObject.InitiallyUnowned->Gtk.CellRenderer GObject.Object GObject.Object GObject.Object->GObject.InitiallyUnowned Gtk.CellRendererText Gtk.CellRendererText Gtk.CellRenderer->Gtk.CellRendererText Gtk.CellRendererCombo Gtk.CellRendererCombo Gtk.CellRendererText->Gtk.CellRendererCombo

Subclasses:None

Properties

Inherited:Gtk.CellRendererText (48), Gtk.CellRenderer (16)
Name Type Flags Short Description
has-entry bool r/w/en If False, don’t allow to enter strings other than the chosen ones
model Gtk.TreeModel r/w The model containing the possible values for the combo box
text-column int r/w/en A column in the data source model to get the strings from

Signals

Inherited:Gtk.CellRendererText (1), Gtk.CellRenderer (2), GObject.Object (1)
Name Short Description
changed This signal is emitted each time after the user selected an item in the combo box, either by using the mouse or the arrow keys.

Fields

Inherited:Gtk.CellRendererText (1), Gtk.CellRenderer (2), GObject.Object (1)
Name Type Access Description
parent Gtk.CellRendererText r  

Class Details

class Gtk.CellRendererCombo(**kwargs)
Bases:Gtk.CellRendererText
Abstract:No
Structure:Gtk.CellRendererComboClass

Gtk.CellRendererCombo renders text in a cell like Gtk.CellRendererText from which it is derived. But while Gtk.CellRendererText offers a simple entry to edit the text, Gtk.CellRendererCombo offers a Gtk.ComboBox widget to edit the text. The values to display in the combo box are taken from the tree model specified in the Gtk.CellRendererCombo :model property.

The combo cell renderer takes care of adding a text cell renderer to the combo box and sets it to display the column specified by its Gtk.CellRendererCombo :text-column property. Further properties of the combo box can be set in a handler for the Gtk.CellRenderer ::editing-started signal.

The Gtk.CellRendererCombo cell renderer was added in GTK+ 2.6.

classmethod new()[source]
Returns:the new cell renderer
Return type:Gtk.CellRenderer

Creates a new Gtk.CellRendererCombo. Adjust how text is drawn using object properties. Object properties can be set globally (with g_object_set()). Also, with Gtk.TreeViewColumn, you can bind a property to a value in a Gtk.TreeModel. For example, you can bind the “text” property on the cell renderer to a string value in the model, thus rendering a different string in each row of the Gtk.TreeView.

New in version 2.6.

Signal Details

Gtk.CellRendererCombo.signals.changed(cell_renderer_combo, path_string, new_iter)
Signal Name:

changed

Flags:

RUN_LAST

Parameters:
  • cell_renderer_combo (Gtk.CellRendererCombo) – The object which received the signal
  • path_string (str) – a string of the path identifying the edited cell (relative to the tree view model)
  • new_iter (Gtk.TreeIter) – the new iter selected in the combo box (relative to the combo box model)

This signal is emitted each time after the user selected an item in the combo box, either by using the mouse or the arrow keys. Contrary to Gtk.ComboBox, Gtk.CellRendererCombo ::changed is not emitted for changes made to a selected item in the entry. The argument new_iter corresponds to the newly selected item in the combo box and it is relative to the Gtk.TreeModel set via the model property on Gtk.CellRendererCombo.

Note that as soon as you change the model displayed in the tree view, the tree view will immediately cease the editing operating. This means that you most probably want to refrain from changing the model until the combo cell renderer emits the edited or editing_canceled signal.

New in version 2.14.

Property Details

Gtk.CellRendererCombo.props.has_entry
Name:has-entry
Type:bool
Default Value:True
Flags:READABLE, WRITABLE, EXPLICIT_NOTIFY

If True, the cell renderer will include an entry and allow to enter values other than the ones in the popup list.

New in version 2.6.

Gtk.CellRendererCombo.props.model
Name:model
Type:Gtk.TreeModel
Default Value:None
Flags:READABLE, WRITABLE

Holds a tree model containing the possible values for the combo box. Use the text_column property to specify the column holding the values.

New in version 2.6.

Gtk.CellRendererCombo.props.text_column
Name:text-column
Type:int
Default Value:-1
Flags:READABLE, WRITABLE, EXPLICIT_NOTIFY

Specifies the model column which holds the possible values for the combo box.

Note that this refers to the model specified in the model property, not the model backing the tree view to which this cell renderer is attached.

Gtk.CellRendererCombo automatically adds a text cell renderer for this column to its combo box.

New in version 2.6.