GimpUi.IntStore¶

Subclasses:: GimpUi.EnumStore

Methods¶

Inherited:: Gtk.ListStore (18), GObject.Object (37), Gtk.Buildable (10), Gtk.TreeDragDest (2), Gtk.TreeDragSource (3), Gtk.TreeModel (28), Gtk.TreeSortable (6)
Structs:: GObject.ObjectClass (5)

class	`lookup_by_user_data` (model, user_data)
class	`lookup_by_value` (model, value)
class	`new` (labels)

Virtual Methods¶

Inherited:: GObject.Object (7), Gtk.Buildable (10), Gtk.TreeDragDest (2), Gtk.TreeDragSource (3), Gtk.TreeModel (19), Gtk.TreeSortable (6)

Properties¶

Name	Type	Flags	Short Description
`user-data-type`	`GObject.GType`	r/w/co	The `GObject.GType` of the user_data column

Signals¶

Inherited:: GObject.Object (1), Gtk.TreeModel (5), Gtk.TreeSortable (1)

Fields¶

Inherited:: GObject.Object (1), Gtk.TreeModel (5), Gtk.TreeSortable (1)

Name	Type	Access	Description
parent_instance	`Gtk.ListStore`	r

Class Details¶

class GimpUi.IntStore(*column_types)¶

Bases:: Gtk.ListStore
Abstract:: No
Structure:: GimpUi.IntStoreClass

A model for integer based name-value pairs (e.g. enums)

classmethod lookup_by_user_data(model, user_data)¶

Parameters:

model (Gtk.TreeModel) – a GimpUi.IntStore
user_data (object or None) – a object “user-data” to lookup in the model

Returns:

True if the user-data has been located and iter is valid, False otherwise.

iter:: return location for the iter of the given user_data

Return type:

(bool, iter: Gtk.TreeIter)

Iterate over the model looking for user_data.

New in version 2.10.

classmethod lookup_by_value(model, value)¶

Parameters:

model (Gtk.TreeModel) – a GimpUi.IntStore
value (int) – an integer value to lookup in the model

Returns:

True if the value has been located and iter is valid, False otherwise.

iter:: return location for the iter of the given value

Return type:

(bool, iter: Gtk.TreeIter)

Iterate over the model looking for value.

New in version 2.2.

classmethod new(labels)¶

Parameters:: labels ([str]) – an array of labels
Returns:: a new Gtk.ListStore.
Return type:: Gtk.ListStore

A variant of GimpUi.IntStore.new() that takes an array of labels. The array indices are used as values.

New in version 3.0.

Property Details¶

GimpUi.IntStore.props.user_data_type¶

Name:: user-data-type
Type:: GObject.GType
Default Value:: <GType void>
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Sets the GObject.GType for the GimpUi.IntStoreColumns.USER_DATA column.

You need to set this property when constructing the store if you want to use the GimpUi.IntStoreColumns.USER_DATA column and want to have the store handle ref-counting of your user data.

New in version 2.4.