Description [src]

class Gtk.TreeModelSort : GObject.Object {
  parent: GObject

The GtkTreeModelSort is a model which implements the GtkTreeSortable interface. It does not hold any data itself, but rather is created with a child model and proxies its data. It has identical column types to this child model, and the changes in the child are propagated. The primary purpose of this model is to provide a way to sort a different model without modifying it. Note that the sort function used by GtkTreeModelSort is not guaranteed to be stable.

The use of this is best demonstrated through an example. In the following sample code we create two GtkTreeView widgets each with a view of the same data. As the model is wrapped here by a GtkTreeModelSort, the two GtkTreeViews can each sort their view of the data without affecting the other. By contrast, if we simply put the same model in each widget, then sorting the first would sort the second.

Using a GtkTreeModelSort

  GtkTreeView *tree_view1;
  GtkTreeView *tree_view2;
  GtkTreeModel *sort_model1;
  GtkTreeModel *sort_model2;
  GtkTreeModel *child_model;

  // get the child model
  child_model = get_my_model ();

  // Create the first tree
  sort_model1 = gtk_tree_model_sort_new_with_model (child_model);
  tree_view1 = gtk_tree_view_new_with_model (sort_model1);

  // Create the second tree
  sort_model2 = gtk_tree_model_sort_new_with_model (child_model);
  tree_view2 = gtk_tree_view_new_with_model (sort_model2);

  // Now we can sort the two models independently
  gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (sort_model1),
                                        COLUMN_1, GTK_SORT_ASCENDING);
  gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (sort_model2),
                                        COLUMN_1, GTK_SORT_DESCENDING);

To demonstrate how to access the underlying child model from the sort model, the next example will be a callback for the GtkTreeSelection GtkTreeSelection::changed signal. In this callback, we get a string from COLUMN_1 of the model. We then modify the string, find the same selected row on the child model, and change the row there.

Accessing the child model of in a selection changed callback

selection_changed (GtkTreeSelection *selection, gpointer data)
  GtkTreeModel *sort_model = NULL;
  GtkTreeModel *child_model;
  GtkTreeIter sort_iter;
  GtkTreeIter child_iter;
  char *some_data = NULL;
  char *modified_data;

  // Get the current selected row and the model.
  if (! gtk_tree_selection_get_selected (selection,

  // Look up the current value on the selected row and get
  // a new value to change it to.
  gtk_tree_model_get (GTK_TREE_MODEL (sort_model), &sort_iter,
                      COLUMN_1, &some_data,

  modified_data = change_the_data (some_data);
  g_free (some_data);

  // Get an iterator on the child model, instead of the sort model.
  gtk_tree_model_sort_convert_iter_to_child_iter (GTK_TREE_MODEL_SORT (sort_model),

  // Get the child model and change the value of the row. In this
  // example, the child model is a GtkListStore. It could be any other
  // type of model, though.
  child_model = gtk_tree_model_sort_get_model (GTK_TREE_MODEL_SORT (sort_model));
  gtk_list_store_set (GTK_LIST_STORE (child_model), &child_iter,
                      COLUMN_1, &modified_data,
  g_free (modified_data);


hierarchy this GtkTreeModelSort implements_0 GtkTreeDragSource this--implements_0 implements_1 GtkTreeModel this--implements_1 implements_2 GtkTreeSortable this--implements_2 ancestor_0 GObject ancestor_0--this




Creates a new GtkTreeModelSort, with child_model as the child model.

Instance methods


This function should almost never be called. It clears the tree_model_sort of any cached iterators that haven’t been reffed with gtk_tree_model_ref_node(). This might be useful if the child model being sorted is static (and doesn’t change often) and there has been a lot of unreffed access to nodes. As a side effect of this function, all unreffed iters will be invalid.


Sets sort_iter to point to the row in tree_model_sort that corresponds to the row pointed at by child_iter. If sort_iter was not set, FALSE is returned. Note: a boolean is only returned since 2.14.


Converts child_path to a path relative to tree_model_sort. That is, child_path points to a path in the child model. The returned path will point to the same row in the sorted model. If child_path isn’t a valid path on the child model, then NULL is returned.


Sets child_iter to point to the row pointed to by sorted_iter.


Converts sorted_path to a path on the child model of tree_model_sort. That is, sorted_path points to a location in tree_model_sort. The returned path will point to the same location in the model not being sorted. If sorted_path does not point to a location in the child model, NULL is returned.


Returns the model the GtkTreeModelSort is sorting.


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

Available since: 2.2


This resets the default sort function to be in the “unsorted” state. That is, it is in the same order as the child model. It will re-sort the model to be in the same order as the child model only if the GtkTreeModelSort is in “unsorted” state.

Methods inherited from GObject (42)
Methods inherited from GtkTreeDragSource (3)

Asks the GtkTreeDragSource to delete the row at path, because it was moved somewhere else via drag-and-drop. Returns FALSE if the deletion fails because path no longer exists, or for some model-specific reason. Should robustly handle a path no longer found in the model!


Asks the GtkTreeDragSource to fill in selection_data with a representation of the row at path. selection_data->target gives the required type of the data. Should robustly handle a path no longer found in the model!


Asks the GtkTreeDragSource whether a particular row can be used as the source of a DND operation. If the source doesn’t implement this interface, the row is assumed draggable.

Methods inherited from GtkTreeModel (28)

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

Available since: 2.4


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


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 G_TYPE_STRING, 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.


Returns the type of the column.


Returns a set of flags supported by this interface.


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.


Initializes iter with the first iterator in the tree (the one at the path “0”) and returns TRUE. Returns FALSE if the tree is empty.


Sets iter to a valid iterator pointing to path_string, if it exists. Otherwise, iter is left invalid and FALSE is returned.


Returns the number of columns supported by tree_model.


Returns a newly-created GtkTreePath-struct referenced by iter.


Generates a string representation of the iter.

Available since: 2.2


See gtk_tree_model_get(), this version takes a va_list for language bindings to use.


Initializes and sets value to that at column.


Sets iter to point to the first child of parent.


Returns TRUE if iter has children, FALSE otherwise.


Returns the number of children that iter has.


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


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


Sets iter to be the parent of child.


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

Available since: 3.0


Lets the tree ref the node.


Emits the GtkTreeModel::row-changed signal on tree_model.


Emits the GtkTreeModel::row-deleted signal on tree_model.

Methods inherited from GtkTreeSortable (6)

Fills in sort_column_id and order with the current sort column and the order. It returns TRUE unless the sort_column_id is GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID or GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID.


Returns TRUE if the model has a default sort function. This is used primarily by GtkTreeViewColumns in order to determine if a model can go back to the default state, or not.


Sets the default comparison function used when sorting to be sort_func. If the current sort column id of sortable is GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, then the model will sort using this function.


Sets the current sort column to be sort_column_id. The sortable will resort itself to reflect this change, after emitting a GtkTreeSortable::sort-column-changed signal. sort_column_id may either be a regular column id, or one of the following special values:


Sets the comparison function used when sorting to be sort_func. If the current sort column id of sortable is the same as sort_column_id, then the model will sort using this function.


Emits a GtkTreeSortable::sort-column-changed signal on sortable.


No description available.


Signals inherited from GObject (1)
Signals inherited from GtkTreeModel (5)

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


This signal is emitted when a row has been deleted.


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


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


This signal is emitted when the children of a node in the GtkTreeModel have been reordered.

Signals inherited from GtkTreeSortable (1)

The ::sort-column-changed signal is emitted when the sort column or sort order of sortable is changed. The signal is emitted before the contents of sortable are resorted.

Class structure

struct GtkTreeModelSortClass {
  GObjectClass parent_class;
  void (* _gtk_reserved1) (
  void (* _gtk_reserved2) (
  void (* _gtk_reserved3) (
  void (* _gtk_reserved4) (
Class members
  No description available.
void (* _gtk_reserved1) (
  No description available.
void (* _gtk_reserved2) (
  No description available.
void (* _gtk_reserved3) (
  No description available.
void (* _gtk_reserved4) (
  No description available.