Gtk.ListStore¶

Subclasses:: None

Methods¶

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

class	`new` (types)
	`append` (row=None)
	`clear` ()
	`insert` (position, row=None)
	`insert_after` (sibling, row=None)
	`insert_before` (sibling, row=None)
	`insert_with_values` (position, columns, values)
	`insert_with_valuesv` (position, columns, values)
	`iter_is_valid` (iter)
	`move_after` (iter, position)
	`move_before` (iter, position)
	`prepend` (row=None)
	`remove` (iter)
	`reorder` (new_order)
	`set` (iter, columns, values)
	`set_column_types` (types)
	`set_value` (iter, column, value)
	`swap` (a, b)

Virtual Methods¶

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

Properties¶

None

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	`GObject.Object`	r

Class Details¶

class Gtk.ListStore(*column_types)¶

Bases:: GObject.Object, Gtk.Buildable, Gtk.TreeDragDest, Gtk.TreeDragSource, Gtk.TreeModel, Gtk.TreeSortable
Abstract:: No
Structure:: Gtk.ListStoreClass

A list-like data structure that can be used with the [class`Gtk`.TreeView].

The GtkListStore object is a list model for use with a GtkTreeView widget. It implements the GtkTreeModel interface, and consequentialy, can use all of the methods available there. It also implements the GtkTreeSortable interface so it can be sorted by the view. Finally, it also implements the tree drag and drop interfaces.

The GtkListStore can accept most GType``s as a column type, though it can’t accept all custom types. Internally, it will keep a copy of data passed in (such as a string or a boxed pointer). Columns that accept ``GObject``s are handled a little differently. The ``GtkListStore will keep a reference to the object instead of copying the value. As a result, if the object is modified, it is up to the application writer to call [method`Gtk`.TreeModel.row_changed] to emit the [signal`Gtk`.TreeModel::row_changed] signal. This most commonly affects lists with [class`Gdk`.Texture]s stored.

An example for creating a simple list store:

```c enum { COLUMN_STRING, COLUMN_INT, COLUMN_BOOLEAN, N_COLUMNS };

{ Gtk.ListStore *list_store; Gtk.TreePath *path; Gtk.TreeIter iter; int i;

list_store = Gtk.ListStore.new (N_COLUMNS, GObject.TYPE_STRING, GObject.TYPE_INT, GObject.TYPE_BOOLEAN);

for (i = 0; i < 10; i++) { str *some_data;

some_data = get_some_data (i);

// Add a new row to the model Gtk.ListStore.append (list_store, &iter); Gtk.ListStore.set (list_store, &iter, COLUMN_STRING, some_data, COLUMN_INT, i, COLUMN_BOOLEAN, False, -1);

// As the store will keep a copy of the string internally, // we free some_data. GLib.free (some_data); }

// Modify a particular row path = Gtk.TreePath.new_from_string (“4”); Gtk.TreeModel.get_iter (GTK_TREE_MODEL (list_store), &iter, path); Gtk.TreePath.free (path); Gtk.ListStore.set (list_store, &iter, COLUMN_BOOLEAN, True, -1); } ```

GtkListStore is deprecated since GTK 4.10, and should not be used in newly written code. You should use [class`Gio`.ListStore] instead, and the various list models provided by GTK.

Performance Considerations

Internally, the GtkListStore was originally implemented with a linked list with a tail pointer. As a result, it was fast at data insertion and deletion, and not fast at random data access. The GtkListStore sets the GTK_TREE_MODEL_ITERS_PERSIST flag, which means that ``GtkTreeIter``s can be cached while the row exists. Thus, if access to a particular row is needed often and your code is expected to run on older versions of GTK, it is worth keeping the iter around.

Atomic Operations

It is important to note that only the methods Gtk.ListStore.insert_with_values() and Gtk.ListStore.insert_with_values() are atomic, in the sense that the row is being appended to the store and the values filled in in a single operation with regard to GtkTreeModel signaling. In contrast, using e.g. Gtk.ListStore.append() and then Gtk.ListStore.set() will first create a row, which triggers the GtkTreeModel::row-inserted signal on GtkListStore. The row, however, is still empty, and any signal handler connecting to GtkTreeModel::row-inserted on this particular store should be prepared for the situation that the row might be empty. This is especially important if you are wrapping the GtkListStore inside a GtkTreeModel``Filter and are using a ``GtkTreeModel``FilterVisibleFunc. Using any of the non-atomic operations to append rows to the ``GtkListStore will cause the ``GtkTreeModel``FilterVisibleFunc to be visited with an empty row first; the function must be prepared for that.

Gtk.ListStore as Gtk.Buildable

The Gtk.ListStore implementation of the [iface`Gtk`.Buildable] interface allows to specify the model columns with a <columns> element that may contain multiple <column> elements, each specifying one model column. The “type” attribute specifies the data type for the column.

Additionally, it is possible to specify content for the list store in the UI definition, with the <data> element. It can contain multiple <row> elements, each specifying to content for one row of the list model. Inside a <row>, the <col> elements specify the content for individual cells.

Note that it is probably more common to define your models in the code, and one might consider it a layering violation to specify the content of a list store in a UI definition, data, not presentation, and common wisdom is to separate the two, as far as possible.

An example of a UI Definition fragment for a list store:

``xml <object class=”GtkListStore”>

<columns>
<column type=”gchararray”/> <column type=”gchararray”/> <column type=”gint”/>

</columns> <data>

<row>
<col id=”0”>John</col> <col id=”1”>Doe</col> <col id=”2”>25</col>

</row> <row>

<col id=”0”>Johan</col> <col id=”1”>Dahlin</col> <col id=”2”>50</col>

</row>

</data>

</object> ``

Deprecated since version 4.10: Use [class`Gio`.ListStore] instead

classmethod new(types)[source]¶

Parameters:: types ([GObject.GType]) – an array of GType types for the columns, from first to last
Returns:: a new GtkListStore
Return type:: Gtk.ListStore

Creates a new GtkListStore.

This function is meant to be used by language bindings.

Deprecated since version 4.10: Use [class`Gio`.ListStore] instead

append(row=None)[source]¶

Parameters:: row ([object] or None) – a list of values to apply to the newly append row or None
Returns:: Gtk.TreeIter of the appended row
Return type:: Gtk.TreeIter

If row is None the appended row will be empty and to fill in values you need to call Gtk.ListStore.set() or Gtk.ListStore.set_value().

If row isn’t None it has to be a list of values which will be used to fill the row .

Deprecated since version 4.10: Use list models

clear()[source]¶: Removes all rows from the list store.

Deprecated since version 4.10: Use list models

insert(position, row=None)[source]¶

Parameters:

position (int) – the position the new row will be inserted at
row ([object] or None) – a list of values to apply to the newly inserted row or None

Returns:

Gtk.TreeIter of the inserted row

Return type:

Gtk.TreeIter

If row is None the inserted row will be empty and to fill in values you need to call Gtk.ListStore.set() or Gtk.ListStore.set_value().

If row isn’t None it has to be a list of values which will be used to fill the row.

If position is -1 or is larger than the number of rows on the list, then the new row will be appended to the list.

Deprecated since version 4.10: Use list models

insert_after(sibling, row=None)[source]¶

Parameters:

sibling (Gtk.TreeIter or None) – A valid Gtk.TreeIter, or None
row ([object] or None) – a list of values to apply to the newly inserted row or None

Returns:

Gtk.TreeIter pointing to the new row

Return type:

Gtk.TreeIter

Inserts a new row after sibling. If sibling is None, then the row will be prepended to the beginning of the list.

The row will be empty if row is None. To fill in values, you need to call :obj:`Gtk.ListStore.set() or Gtk.ListStore.set_value().

If row isn’t None it has to be a list of values which will be used to fill the row.

Deprecated since version 4.10: Use list models

insert_before(sibling, row=None)[source]¶

Parameters:

sibling (Gtk.TreeIter or None) – A valid Gtk.TreeIter, or None
row ([object] or None) – a list of values to apply to the newly inserted row or None

Returns:

Gtk.TreeIter pointing to the new row

Return type:

Gtk.TreeIter

Inserts a new row before sibling. If sibling is None, then the row will be appended to the end of the list.

The row will be empty if row is None. To fill in values, you need to call :obj:`Gtk.ListStore.set() or Gtk.ListStore.set_value().

If row isn’t None it has to be a list of values which will be used to fill the row.

Deprecated since version 4.10: Use list models

insert_with_values(position, columns, values)[source]¶

Parameters:

position (int) – position to insert the new row, or -1 for last
columns ([int]) – an array of column numbers
values ([GObject.Value]) – an array of GValues

Returns:

An unset GtkTreeIter to set to the new row

Return type:

iter: Gtk.TreeIter

A variant of Gtk.ListStore.insert_with_values() which takes the columns and values as two arrays, instead of varargs.

This function is mainly intended for language-bindings.

Deprecated since version 4.10: Use list models

insert_with_valuesv(position, columns, values)¶: insert_with_values(position: int, columns: [int], values: [GObject.Value]) -> iter: Gtk.TreeIter

iter_is_valid(iter)[source]¶

Parameters:: iter (Gtk.TreeIter) – the iterator to check
Returns:: True if the iter is valid, False if the iter is invalid.
Return type:: bool

Checks if the given iter is a valid iter for this GtkListStore.

This function is slow. Only use it for debugging and/or testing purposes.

Deprecated since version 4.10: Use list models

move_after(iter, position)[source]¶

Parameters:

iter (Gtk.TreeIter) – A GtkTreeIter
position (Gtk.TreeIter or None) – A GtkTreeIter

Moves iter in self to the position after position. Note that this function only works with unsorted stores. If position is None, iter will be moved to the start of the list.

Deprecated since version 4.10: Use list models

move_before(iter, position)[source]¶

Parameters:

iter (Gtk.TreeIter) – A GtkTreeIter
position (Gtk.TreeIter or None) – A GtkTreeIter

Moves iter in self to the position before position. Note that this function only works with unsorted stores. If position is None, iter will be moved to the end of the list.

Deprecated since version 4.10: Use list models

prepend(row=None)[source]¶

Parameters:: row ([object] or None) – a list of values to apply to the newly prepend row or None
Returns:: Gtk.TreeIter of the prepended row
Return type:: Gtk.TreeIter

If row is None the prepended row will be empty and to fill in values you need to call Gtk.ListStore.set() or Gtk.ListStore.set_value().

If row isn’t None it has to be a list of values which will be used to fill the row.

Deprecated since version 4.10: Use list models

remove(iter)[source]¶

Parameters:: iter (Gtk.TreeIter) – A valid GtkTreeIter
Returns:: True if iter is valid, False if not.
Return type:: bool

Removes the given row from the list store. After being removed, iter is set to be the next valid row, or invalidated if it pointed to the last row in self.

Deprecated since version 4.10: Use list models

reorder(new_order)[source]¶

Parameters:: new_order ([int]) – an array of integers mapping the new position of each child to its old position before the re-ordering, i.e. new_order [newpos] = oldpos. It must have exactly as many items as the list store’s length.

Reorders self to follow the order indicated by new_order. Note that this function only works with unsorted stores.

Deprecated since version 4.10: Use list models

set(iter, columns, values)[source]¶

Parameters:

iter (Gtk.TreeIter) – A valid GtkTreeIter for the row being modified
columns ([int]) – an array of column numbers
values ([GObject.Value]) – an array of GValues

A variant of gtk_list_store_set_valist() which takes the columns and values as two arrays, instead of varargs. This function is mainly intended for language-bindings and in case the number of columns to change is not known until run-time.

Deprecated since version 4.10: Use list models

set_column_types(types)[source]¶

Parameters:: types ([GObject.GType]) – An array length n of ``GType``s

Sets the types of the columns of a list store.

This function is meant primarily for objects that inherit from GtkListStore, and should only be used when constructing a new instance.

This function cannot be called after a row has been added, or a method on the GtkTreeModel interface is called.

Deprecated since version 4.10: Use list models

set_value(iter, column, value)[source]¶

Parameters:

iter (Gtk.TreeIter) – A valid GtkTreeIter for the row being modified
column (int) – column number to modify
value (GObject.Value) – new value for the cell

Sets the data in the cell specified by iter and column. The type of value must be convertible to the type of the column.

value can also be a Python value and will be converted to a GObject.Value using the corresponding column type (See Gtk.ListStore.set_column_types()).

Deprecated since version 4.10: Use list models

swap(a, b)[source]¶

Parameters:

a (Gtk.TreeIter) – A GtkTreeIter
b (Gtk.TreeIter) – Another GtkTreeIter

Swaps a and b in self. Note that this function only works with unsorted stores.

Deprecated since version 4.10: Use list models