Gtk.ListStore

g GObject.GInterface GObject.GInterface Gtk.Buildable Gtk.Buildable GObject.GInterface->Gtk.Buildable Gtk.TreeDragDest Gtk.TreeDragDest GObject.GInterface->Gtk.TreeDragDest Gtk.TreeDragSource Gtk.TreeDragSource GObject.GInterface->Gtk.TreeDragSource Gtk.TreeModel Gtk.TreeModel GObject.GInterface->Gtk.TreeModel Gtk.TreeSortable Gtk.TreeSortable GObject.GInterface->Gtk.TreeSortable GObject.Object GObject.Object Gtk.ListStore Gtk.ListStore GObject.Object->Gtk.ListStore Gtk.Buildable->Gtk.ListStore Gtk.TreeDragDest->Gtk.ListStore Gtk.TreeDragSource->Gtk.ListStore Gtk.TreeModel->Gtk.ListStore Gtk.TreeSortable->Gtk.ListStore

Subclasses:None

Methods

Inherited:GObject.Object (37), Gtk.Buildable (10), 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_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)

Properties

None

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

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

The Gtk.ListStore can accept most GObject.Object types 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.Objects are handled a little differently. The Gtk.ListStore 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 Gtk.TreeModel.row_changed() to emit the #GtkTreeModel::row_changed signal. This most commonly affects lists with GdkPixbuf.Pixbufs stored.

An example for creating a simple list store:

enum {
  COLUMN_STRING,
  COLUMN_INT,
  COLUMN_BOOLEAN,
  N_COLUMNS
};

{
  GtkListStore *list_store;
  GtkTreePath *path;
  GtkTreeIter iter;
  gint i;

  list_store = gtk_list_store_new (N_COLUMNS,
                                   G_TYPE_STRING,
                                   G_TYPE_INT,
                                   G_TYPE_BOOLEAN);

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

      some_data = get_some_data (i);

      // Add a new row to the model
      gtk_list_store_append (list_store, &iter);
      gtk_list_store_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.
      g_free (some_data);
    }

  // Modify a particular row
  path = gtk_tree_path_new_from_string ("4");
  gtk_tree_model_get_iter (GTK_TREE_MODEL (list_store),
                           &iter,
                           path);
  gtk_tree_path_free (path);
  gtk_list_store_set (list_store, &iter,
                      COLUMN_BOOLEAN, TRUE,
                      -1);
}
Performance Considerations

Internally, the Gtk.ListStore was implemented with a linked list with a tail pointer prior to GTK+ 2.6. As a result, it was fast at data insertion and deletion, and not fast at random data access. The Gtk.ListStore sets the Gtk.TreeModelFlags.ITERS_PERSIST flag, which means that Gtk.TreeIters 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_list_store_insert_with_values() and Gtk.ListStore.insert_with_valuesv() 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 Gtk.TreeModel signaling. In contrast, using e.g. Gtk.ListStore.append() and then Gtk.ListStore.set() will first create a row, which triggers the Gtk.TreeModel ::row-inserted signal on Gtk.ListStore. The row, however, is still empty, and any signal handler connecting to Gtk.TreeModel ::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 Gtk.ListStore inside a Gtk.TreeModelFilter and are using a Gtk.TreeModelFilterVisibleFunc. Using any of the non-atomic operations to append rows to the Gtk.ListStore will cause the Gtk.TreeModelFilterVisibleFunc 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 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:

<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>
classmethod new(types)[source]
Parameters:types ([GObject.GType]) – an array of GObject.GType types for the columns, from first to last
Returns:a new Gtk.ListStore
Return type:Gtk.ListStore

Non-vararg creation function. Used primarily by language bindings.

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 .

clear()[source]

Removes all rows from the list store.

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.

insert_after(sibling, row=None)[source]
Parameters:
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.

insert_before(sibling, row=None)[source]
Parameters:
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.

insert_with_valuesv(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 Gtk.TreeIter to set to the new row, or None.

Return type:

iter: Gtk.TreeIter

A variant of gtk_list_store_insert_with_values() which takes the columns and values as two arrays, instead of varargs. This function is mainly intended for language-bindings.

New in version 2.6.

iter_is_valid(iter)[source]
Parameters:iter (Gtk.TreeIter) – A Gtk.TreeIter.
Returns:True if the iter is valid, False if the iter is invalid.
Return type:bool

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

Checks if the given iter is a valid iter for this Gtk.ListStore.

New in version 2.2.

move_after(iter, position)[source]
Parameters:

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.

New in version 2.2.

move_before(iter, position)[source]
Parameters:

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.

New in version 2.2.

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.

remove(iter)[source]
Parameters:iter (Gtk.TreeIter) – A valid Gtk.TreeIter
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.

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.

New in version 2.2.

set(iter, columns, values)[source]
Parameters:

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.

New in version 2.12.

set_column_types(types)[source]
Parameters:types ([GObject.GType]) – An array length n of GObject.GTypes

This function is meant primarily for GObject.Objects that inherit from Gtk.ListStore, and should only be used when constructing a new Gtk.ListStore. It will not function after a row has been added, or a method on the Gtk.TreeModel interface is called.

set_value(iter, column, value)[source]
Parameters:

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()).

swap(a, b)[source]
Parameters:

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

New in version 2.2.