GimpUi.StringComboBox¶

Subclasses:: None

Methods¶

Inherited:: Gtk.ComboBox (40), Gtk.Bin (1), Gtk.Container (35), Gtk.Widget (278), GObject.Object (37), Gtk.Buildable (10), Gtk.CellEditable (3), Gtk.CellLayout (9)
Structs:: Gtk.ContainerClass (5), Gtk.WidgetClass (12), GObject.ObjectClass (5)

class	`new` (model, id_column, label_column)
	`get_active` ()
	`set_active` (id)
	`set_sensitivity` (func, *data)

Virtual Methods¶

Inherited:: Gtk.ComboBox (2), Gtk.Container (10), Gtk.Widget (82), GObject.Object (7), Gtk.Buildable (10), Gtk.CellEditable (3), Gtk.CellLayout (9)

Properties¶

Inherited:: Gtk.ComboBox (16), Gtk.Container (3), Gtk.Widget (39), Gtk.CellEditable (1)

Name	Type	Flags	Short Description
`ellipsize`	`Pango.EllipsizeMode`	r/w	Ellipsize mode for the text cell renderer
`label-column`	`int`	r/w/co	The model column that holds the label
`value`	`str`	r/w/en	Value of active item

Style Properties¶

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

Signals¶

Inherited:: Gtk.ComboBox (5), Gtk.Container (4), Gtk.Widget (69), GObject.Object (1), Gtk.CellEditable (2)

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 GimpUi.StringComboBox(**kwargs)¶

Bases:: Gtk.ComboBox
Abstract:: No
Structure:: GimpUi.StringComboBoxClass

A Gtk.ComboBox subclass to select strings.

classmethod new(model, id_column, label_column)¶

Parameters:

model (Gtk.TreeModel) – a Gtk.TreeModel
id_column (int) – the model column of the ID
label_column (int) – the modl column of the label

Returns:

a new GimpUi.StringComboBox.

Return type:

Gtk.Widget

New in version 2.4.

get_active()¶

Returns:: newly allocated ID string or None if nothing was selected
Return type:: str

Retrieves the value of the selected (active) item in the self.

New in version 2.4.

set_active(id)¶

Parameters:: id (str) – the ID of the item to select
Returns:: True on success or False if there was no item for this value.
Return type:: bool

Looks up the item that belongs to the given id and makes it the selected item in the self.

New in version 2.4.

set_sensitivity(func, *data)¶

Parameters:

func (GimpUi.StringSensitivityFunc) – a function that returns a boolean value, or None to unset
data (object or None) – data to pass to func

Sets a function that is used to decide about the sensitivity of rows in the self. Use this if you want to set certain rows insensitive.

Calling Gtk.Widget.queue_draw() on the self will cause the sensitivity to be updated.

New in version 3.0.

Property Details¶

GimpUi.StringComboBox.props.ellipsize¶

Name:: ellipsize
Type:: Pango.EllipsizeMode
Default Value:: Pango.EllipsizeMode.NONE
Flags:: READABLE, WRITABLE

Specifies the preferred place to ellipsize text in the combo-box, if the cell renderer does not have enough room to display the entire string.

New in version 2.4.

GimpUi.StringComboBox.props.label_column¶

Name:: label-column
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The column in the associated Gtk.TreeModel that holds strings to be used as labels in the combo-box.

New in version 2.4.

GimpUi.StringComboBox.props.value¶

Name:: value
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, EXPLICIT_NOTIFY

The active value (different from the “active” property of Gtk.ComboBox which is the active index).

New in version 3.0.