TreeModel

Deprecated since version 4.10: Use ListModel instead

class TreeModel(*args, **kwargs)

Implementations: ListStore, TreeModelFilter, TreeModelSort, TreeStore

The tree interface used by GtkTreeView

The GtkTreeModel interface defines a generic tree interface for use by the GtkTreeView widget. It is an abstract interface, and is designed to be usable with any appropriate data structure. The programmer just has to implement this interface on their own data type for it to be viewable by a GtkTreeView widget.

The model is represented as a hierarchical tree of strongly-typed, columned data. In other words, the model can be seen as a tree where every node has different values depending on which column is being queried. The type of data found in a column is determined by using the GType system (ie. int, %GTK_TYPE_BUTTON, %G_TYPE_POINTER, etc). The types are homogeneous per column across all nodes. It is important to note that this interface only provides a way of examining a model and observing changes. The implementation of each individual model decides how and if changes are made.

In order to make life simpler for programmers who do not need to write their own specialized model, two generic models are provided — the GtkTreeStore and the GtkListStore. To use these, the developer simply pushes data into these models as necessary. These models provide the data structure as well as all appropriate tree interfaces. As a result, implementing drag and drop, sorting, and storing data is trivial. For the vast majority of trees and lists, these two models are sufficient.

Models are accessed on a node/column level of granularity. One can query for the value of a model at a certain node and a certain column on that node. There are two structures used to reference a particular node in a model. They are the TreePath and the TreeIter (“iter” is short for iterator). Most of the interface consists of operations on a TreeIter.

A path is essentially a potential node. It is a location on a model that may or may not actually correspond to a node on a specific model. A TreePath can be converted into either an array of unsigned integers or a string. The string form is a list of numbers separated by a colon. Each number refers to the offset at that level. Thus, the path 0 refers to the root node and the path 2:4 refers to the fifth child of the third node.

By contrast, a TreeIter is a reference to a specific node on a specific model. It is a generic struct with an integer and three generic pointers. These are filled in by the model in a model-specific way. One can convert a path to an iterator by calling get_iter(). These iterators are the primary way of accessing a model and are similar to the iterators used by GtkTextBuffer. They are generally statically allocated on the stack and only used for a short time. The model interface defines a set of operations using them for navigating the model.

It is expected that models fill in the iterator with private data. For example, the GtkListStore model, which is internally a simple linked list, stores a list node in one of the pointers. The ``GtkTreeModel``Sort stores an array and an offset in two of the pointers. Additionally, there is an integer field. This field is generally filled with a unique stamp per model. This stamp is for catching errors resulting from using invalid iterators with a model.

The lifecycle of an iterator can be a little confusing at first. Iterators are expected to always be valid for as long as the model is unchanged (and doesn’t emit a signal). The model is considered to own all outstanding iterators and nothing needs to be done to free them from the user’s point of view. Additionally, some models guarantee that an iterator is valid for as long as the node it refers to is valid (most notably the GtkTreeStore and GtkListStore). Although generally uninteresting, as one always has to allow for the case where iterators do not persist beyond a signal, some very important performance enhancements were made in the sort model. As a result, the ITERS_PERSIST flag was added to indicate this behavior.

To help show some common operation of a model, some examples are provided. The first example shows three ways of getting the iter at the location 3:2:5. While the first method shown is easier, the second is much more common, as you often get paths from callbacks.

Acquiring a GtkTreeIter

// Three ways of getting the iter pointing to the location
GtkTreePath *path;
GtkTreeIter iter;
GtkTreeIter parent_iter;

// get the iterator from a string
gtk_tree_model_get_iter_from_string (model,
                                     &iter,
                                     "3:2:5");

// get the iterator from a path
path = gtk_tree_path_new_from_string ("3:2:5");
gtk_tree_model_get_iter (model, &iter, path);
gtk_tree_path_free (path);

// walk the tree to find the iterator
gtk_tree_model_iter_nth_child (model, &iter,
                               NULL, 3);
parent_iter = iter;
gtk_tree_model_iter_nth_child (model, &iter,
                               &parent_iter, 2);
parent_iter = iter;
gtk_tree_model_iter_nth_child (model, &iter,
                               &parent_iter, 5);

This second example shows a quick way of iterating through a list and getting a string and an integer from each row. The populate_model() function used below is not shown, as it is specific to the GtkListStore. For information on how to write such a function, see the GtkListStore documentation.

Reading data from a GtkTreeModel

enum
{
  STRING_COLUMN,
  INT_COLUMN,
  N_COLUMNS
};

...

GtkTreeModel *list_store;
GtkTreeIter iter;
gboolean valid;
int row_count = 0;

// make a new list_store
list_store = gtk_list_store_new (N_COLUMNS,
                                 G_TYPE_STRING,
                                 G_TYPE_INT);

// Fill the list store with data
populate_model (list_store);

// Get the first iter in the list, check it is valid and walk
// through the list, reading each row.

valid = gtk_tree_model_get_iter_first (list_store,
                                       &iter);
while (valid)
 {
   char *str_data;
   int    int_data;

   // Make sure you terminate calls to :func:`~gi.repository.Gtk.TreeModel.get` with a “-1” value
   gtk_tree_model_get (list_store, &iter,
                       STRING_COLUMN, &str_data,
                       INT_COLUMN, &int_data,
                       -1);

   // Do something with the data
   g_print ("Row ``%d``: (``%s``,``%d``)\n",
            row_count, str_data, int_data);
   g_free (str_data);

   valid = gtk_tree_model_iter_next (list_store,
                                     &iter);
   row_count++;
 }

The GtkTreeModel interface contains two methods for reference counting: ref_node() and unref_node(). These two methods are optional to implement. The reference counting is meant as a way for views to let models know when nodes are being displayed. GtkTreeView will take a reference on a node when it is visible, which means the node is either in the toplevel or expanded. Being displayed does not mean that the node is currently directly visible to the user in the viewport. Based on this reference counting scheme a caching model, for example, can decide whether or not to cache a node based on the reference count. A file-system based model would not want to keep the entire file hierarchy in memory, but just the folders that are currently expanded in every current view.

When working with reference counting, the following rules must be taken into account:

  • Never take a reference on a node without owning a reference on its parent. This means that all parent nodes of a referenced node must be referenced as well.

  • Outstanding references on a deleted node are not released. This is not possible because the node has already been deleted by the time the row-deleted signal is received.

  • Models are not obligated to emit a signal on rows of which none of its siblings are referenced. To phrase this differently, signals are only required for levels in which nodes are referenced. For the root level however, signals must be emitted at all times (however the root level is always referenced when any view is attached).

Methods

class TreeModel
filter_new(root: TreePath | None = None) → TreeModel

Creates a new GtkTreeModel, with child_model as the child_model and root as the virtual root.

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

root – A GtkTreePath

foreach(func: Callable[[...], bool], *user_data: Any) → None

Calls func on each node in model in a depth-first fashion.

If func returns True, then the tree ceases to be walked, and foreach() returns.

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

  • func – a function to be called on each row

  • user_data – user data to passed to func

get(treeiter, *columns)

Gets the value of one or more cells in the row referenced by iter.

The variable argument list should contain integer column numbers, each column number followed by a place to store the value being retrieved. The list is terminated by a -1. For example, to get a value from column 0 with type str, you would write: gtk_tree_model_get (model, iter, 0, &place_string_here, -1), where place_string_here is a gchararray to be filled with the string.

Returned values with type object have to be unreferenced, values with type str or Boxed have to be freed. Other values are passed by value.

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

  • treeiter

  • columns

get_column_type(index_: int) → type

Returns the type of the column.

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

index – the column index

get_flags() → TreeModelFlags

Returns a set of flags supported by this interface.

The flags are a bitwise combination of GtkTreeModel``Flags. The flags supported should not change during the lifetime of the ``tree_model.

Deprecated since version 4.10: Please do not use it in newly written code

get_iter(path)

Sets iter to a valid iterator pointing to path.

If path does not exist, iter is set to an invalid iterator and False is returned.

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

path – the GtkTreePath

get_iter_first() → tuple[bool, TreeIter]

Initializes iter with the first iterator in the tree (the one at the path “0”).

Returns False if the tree is empty, True otherwise.

Deprecated since version 4.10: Please do not use it in newly written code

get_iter_from_string(path_string: str) → tuple[bool, TreeIter]

Sets iter to a valid iterator pointing to path_string, if it exists.

Otherwise, iter is left invalid and False is returned.

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

path_string – a string representation of a GtkTreePath

get_n_columns() → int

Returns the number of columns supported by tree_model.

Deprecated since version 4.10: Please do not use it in newly written code

get_path(iter: TreeIter) → TreePath

Returns a newly-created GtkTreePath referenced by iter.

This path should be freed with free().

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

iter – the GtkTreeIter

get_string_from_iter(iter: TreeIter) → str | None

Generates a string representation of the iter.

This string is a “:” separated list of numbers. For example, “4:10:0:3” would be an acceptable return value for this string.

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

iter – a GtkTreeIter

get_value(iter: TreeIter, column: int) → Any

Initializes and sets value to that at column.

When done with value, unset() needs to be called to free any allocated memory.

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

  • iter – the GtkTreeIter

  • column – the column to lookup the value at

iter_children(parent: TreeIter | None = None) → tuple[bool, TreeIter]

Sets iter to point to the first child of parent.

If parent has no children, False is returned and iter is set to be invalid. parent will remain a valid node after this function has been called.

If parent is None returns the first node, equivalent to gtk_tree_model_get_iter_first (tree_model, iter);

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

parent – the GtkTreeIter

iter_has_child(iter: TreeIter) → bool

Returns True if iter has children, False otherwise.

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

iter – the GtkTreeIter to test for children

iter_n_children(iter: TreeIter | None = None) → int

Returns the number of children that iter has.

As a special case, if iter is None, then the number of toplevel nodes is returned.

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

iter – the GtkTreeIter

iter_next(aiter)

Sets iter to point to the node following it at the current level.

If there is no next iter, False is returned and iter is set to be invalid.

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

aiter

iter_nth_child(parent: TreeIter | None, n: int) → tuple[bool, TreeIter]

Sets iter to be the child of parent, using the given index.

The first index is 0. If n is too big, or parent has no children, iter is set to an invalid iterator and False is returned. parent will remain a valid node after this function has been called. As a special case, if parent is None, then the n-th root node is set.

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

  • parent – the GtkTreeIter to get the child from

  • n – the index of the desired child

iter_parent(child: TreeIter) → tuple[bool, TreeIter]

Sets iter to be the parent of child.

If child is at the toplevel, and doesn’t have a parent, then iter is set to an invalid iterator and False is returned. child will remain a valid node after this function has been called.

iter will be initialized before the lookup is performed, so child and iter cannot point to the same memory location.

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

child – the GtkTreeIter

iter_previous(aiter)

Sets iter to point to the previous node at the current level.

If there is no previous iter, False is returned and iter is set to be invalid.

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

aiter

row_changed(path, iter)

Emits the ::row-changed signal on tree_model.

See row_changed.

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

  • path – a GtkTreePath pointing to the changed row

  • iter – a valid GtkTreeIter pointing to the changed row

row_deleted(path)

Emits the ::row-deleted signal on tree_model.

See row_deleted.

This should be called by models after a row has been removed. The location pointed to by path should be the location that the row previously was at. It may not be a valid location anymore.

Nodes that are deleted are not unreffed, this means that any outstanding references on the deleted node should not be released.

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

path – a GtkTreePath pointing to the previous location of the deleted row

row_has_child_toggled(path, iter)

Emits the ::row-has-child-toggled signal on tree_model.

See row_has_child_toggled.

This should be called by models after the child state of a node changes.

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

  • path – a GtkTreePath pointing to the changed row

  • iter – a valid GtkTreeIter pointing to the changed row

row_inserted(path, iter)

Emits the ::row-inserted signal on tree_model.

See row_inserted.

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

  • path – a GtkTreePath pointing to the inserted row

  • iter – a valid GtkTreeIter pointing to the inserted row

rows_reordered(path, iter, new_order)

Emits the ::rows-reordered signal on tree_model.

See rows_reordered.

This should be called by models when their rows have been reordered.

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

  • path – a GtkTreePath pointing to the tree node whose children have been reordered

  • iter – a valid GtkTreeIter pointing to the node whose children have been reordered, or None if the depth of path is 0

  • new_order – an array of integers mapping the current position of each child to its old position before the re-ordering, i.e. ``new_order```[newpos] = oldpos`

set_row(treeiter, row)
Parameters:

  • treeiter

  • row

sort_new_with_model()

Signals

class TreeModel.signals
row_changed(path: TreePath, iter: TreeIter) → None

This signal is emitted when a row in the model has changed.

Parameters:

  • path – a GtkTreePath identifying the changed row

  • iter – a valid GtkTreeIter pointing to the changed row

row_deleted(path: TreePath) → None

This signal is emitted when a row has been deleted.

Note that no iterator is passed to the signal handler, since the row is already deleted.

This should be called by models after a row has been removed. The location pointed to by path should be the location that the row previously was at. It may not be a valid location anymore.

Parameters:

path – a GtkTreePath identifying the row

row_has_child_toggled(path: TreePath, iter: TreeIter) → None

This signal is emitted when a row has gotten the first child row or lost its last child row.

Parameters:

  • path – a GtkTreePath identifying the row

  • iter – a valid GtkTreeIter pointing to the row

row_inserted(path: TreePath, iter: TreeIter) → None

This signal is emitted when a new row has been inserted in the model.

Note that the row may still be empty at this point, since it is a common pattern to first insert an empty row, and then fill it with the desired values.

Parameters:

  • path – a GtkTreePath identifying the new row

  • iter – a valid GtkTreeIter pointing to the new row

Virtual Methods

class TreeModel
do_get_column_type(index_: int) → type

Returns the type of the column.

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

index – the column index

do_get_flags() → TreeModelFlags

Returns a set of flags supported by this interface.

The flags are a bitwise combination of GtkTreeModel``Flags. The flags supported should not change during the lifetime of the ``tree_model.

Deprecated since version 4.10: Please do not use it in newly written code

do_get_iter(path: TreePath) → tuple[bool, TreeIter]

Sets iter to a valid iterator pointing to path.

If path does not exist, iter is set to an invalid iterator and False is returned.

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

path – the GtkTreePath

do_get_n_columns() → int

Returns the number of columns supported by tree_model.

Deprecated since version 4.10: Please do not use it in newly written code

do_get_path(iter: TreeIter) → TreePath

Returns a newly-created GtkTreePath referenced by iter.

This path should be freed with free().

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

iter – the GtkTreeIter

do_get_value(iter: TreeIter, column: int) → Any

Initializes and sets value to that at column.

When done with value, unset() needs to be called to free any allocated memory.

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

  • iter – the GtkTreeIter

  • column – the column to lookup the value at

do_iter_children(parent: TreeIter | None = None) → tuple[bool, TreeIter]

Sets iter to point to the first child of parent.

If parent has no children, False is returned and iter is set to be invalid. parent will remain a valid node after this function has been called.

If parent is None returns the first node, equivalent to gtk_tree_model_get_iter_first (tree_model, iter);

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

parent – the GtkTreeIter

do_iter_has_child(iter: TreeIter) → bool

Returns True if iter has children, False otherwise.

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

iter – the GtkTreeIter to test for children

do_iter_n_children(iter: TreeIter | None = None) → int

Returns the number of children that iter has.

As a special case, if iter is None, then the number of toplevel nodes is returned.

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

iter – the GtkTreeIter

do_iter_next(iter: TreeIter) → bool

Sets iter to point to the node following it at the current level.

If there is no next iter, False is returned and iter is set to be invalid.

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

iter – the GtkTreeIter

do_iter_nth_child(parent: TreeIter | None, n: int) → tuple[bool, TreeIter]

Sets iter to be the child of parent, using the given index.

The first index is 0. If n is too big, or parent has no children, iter is set to an invalid iterator and False is returned. parent will remain a valid node after this function has been called. As a special case, if parent is None, then the n-th root node is set.

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

  • parent – the GtkTreeIter to get the child from

  • n – the index of the desired child

do_iter_parent(child: TreeIter) → tuple[bool, TreeIter]

Sets iter to be the parent of child.

If child is at the toplevel, and doesn’t have a parent, then iter is set to an invalid iterator and False is returned. child will remain a valid node after this function has been called.

iter will be initialized before the lookup is performed, so child and iter cannot point to the same memory location.

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

child – the GtkTreeIter

do_iter_previous(iter: TreeIter) → bool

Sets iter to point to the previous node at the current level.

If there is no previous iter, False is returned and iter is set to be invalid.

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

iter – the GtkTreeIter

do_ref_node(iter: TreeIter) → None

Lets the tree ref the node.

This is an optional method for models to implement. To be more specific, models may ignore this call as it exists primarily for performance reasons.

This function is primarily meant as a way for views to let caching models know when nodes are being displayed (and hence, whether or not to cache that node). Being displayed means a node is in an expanded branch, regardless of whether the node is currently visible in the viewport. For example, a file-system based model would not want to keep the entire file-hierarchy in memory, just the sections that are currently being displayed by every current view.

A model should be expected to be able to get an iter independent of its reffed state.

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

iter – the GtkTreeIter

do_row_changed(path: TreePath, iter: TreeIter) → None

Emits the ::row-changed signal on tree_model.

See row_changed.

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

  • path – a GtkTreePath pointing to the changed row

  • iter – a valid GtkTreeIter pointing to the changed row

do_row_deleted(path: TreePath) → None

Emits the ::row-deleted signal on tree_model.

See row_deleted.

This should be called by models after a row has been removed. The location pointed to by path should be the location that the row previously was at. It may not be a valid location anymore.

Nodes that are deleted are not unreffed, this means that any outstanding references on the deleted node should not be released.

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

path – a GtkTreePath pointing to the previous location of the deleted row

do_row_has_child_toggled(path: TreePath, iter: TreeIter) → None

Emits the ::row-has-child-toggled signal on tree_model.

See row_has_child_toggled.

This should be called by models after the child state of a node changes.

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

  • path – a GtkTreePath pointing to the changed row

  • iter – a valid GtkTreeIter pointing to the changed row

do_row_inserted(path: TreePath, iter: TreeIter) → None

Emits the ::row-inserted signal on tree_model.

See row_inserted.

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

  • path – a GtkTreePath pointing to the inserted row

  • iter – a valid GtkTreeIter pointing to the inserted row

do_unref_node(iter: TreeIter) → None

Lets the tree unref the node.

This is an optional method for models to implement. To be more specific, models may ignore this call as it exists primarily for performance reasons. For more information on what this means, see ref_node().

Please note that nodes that are deleted are not unreffed.

Deprecated since version 4.10: Please do not use it in newly written code

Parameters:

iter – the GtkTreeIter