TreeModelSort

A GtkTreeModel which makes an underlying tree model sortable

The gtk.tree_model_sort.TreeModelSort is a model which implements the gtk.tree_sortable.TreeSortable 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 gtk.tree_model_sort.TreeModelSort is not guaranteed to be stable.

The use of this is best demonstrated through an example. In the following sample code we create two gtk.tree_view.TreeView widgets each with a view of the same data. As the model is wrapped here by a gtk.tree_model_sort.TreeModelSort, the two gtk.tree_view.TreeViews 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 gtk.tree_model_sort.TreeModelSort

{
  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 gtk.tree_selection.TreeSelection 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

void
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,
                                         &sort_model,
                                         &sort_iter))
    return;

  // 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,
                      -1);

  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),
                                                  &child_iter,
                                                  &sort_iter);

  // 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,
                      -1);
  g_free (modified_data);
}
More...

Members

Functions

clearCache
void clearCache()

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.TreeModel.refNode. 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.

convertChildIterToIter
bool convertChildIterToIter(gtk.tree_iter.TreeIter sortIter, gtk.tree_iter.TreeIter childIter)

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.

convertChildPathToPath
gtk.tree_path.TreePath convertChildPathToPath(gtk.tree_path.TreePath childPath)

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.

convertIterToChildIter
void convertIterToChildIter(gtk.tree_iter.TreeIter childIter, gtk.tree_iter.TreeIter sortedIter)

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

convertPathToChildPath
gtk.tree_path.TreePath convertPathToChildPath(gtk.tree_path.TreePath sortedPath)

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.

getModel
gtk.tree_model.TreeModel getModel()

Returns the model the gtk.tree_model_sort.TreeModelSort is sorting.

iterIsValid
bool iterIsValid(gtk.tree_iter.TreeIter iter)

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

resetDefaultSortFunc
void resetDefaultSortFunc()

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 gtk.tree_model_sort.TreeModelSort is in “unsorted” state.

Static functions

newWithModel
gtk.tree_model_sort.TreeModelSort newWithModel(gtk.tree_model.TreeModel childModel)

Creates a new gtk.tree_model_sort.TreeModelSort, with child_model as the child model.

Mixed In Members

From mixin TreeDragSourceT!()

dragDataDelete
bool dragDataDelete(gtk.tree_path.TreePath path)

Asks the gtk.tree_drag_source.TreeDragSource 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!

dragDataGet
gdk.content_provider.ContentProvider dragDataGet(gtk.tree_path.TreePath path)

Asks the gtk.tree_drag_source.TreeDragSource to return a gdk.content_provider.ContentProvider representing the row at path. Should robustly handle a path no longer found in the model!

rowDraggable
bool rowDraggable(gtk.tree_path.TreePath path)

Asks the gtk.tree_drag_source.TreeDragSource 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.

From mixin TreeModelT!()

filterNew
gtk.tree_model.TreeModel filterNew(gtk.tree_path.TreePath root)

Creates a new gtk.tree_model.TreeModel, with child_model as the child_model and root as the virtual root.

foreach_
void foreach_(gtk.types.TreeModelForeachFunc func)

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

getColumnType
gobject.types.GType getColumnType(int index)

Returns the type of the column.

getFlags
gtk.types.TreeModelFlags getFlags()

Returns a set of flags supported by this interface.

getIter
bool getIter(gtk.tree_iter.TreeIter iter, gtk.tree_path.TreePath path)

Sets iter to a valid iterator pointing to path.

getIterFirst
bool getIterFirst(gtk.tree_iter.TreeIter iter)

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

getIterFromString
bool getIterFromString(gtk.tree_iter.TreeIter iter, string pathString)

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

getNColumns
int getNColumns()

Returns the number of columns supported by tree_model.

getPath
gtk.tree_path.TreePath getPath(gtk.tree_iter.TreeIter iter)

Returns a newly-created gtk.tree_path.TreePath referenced by iter.

getStringFromIter
string getStringFromIter(gtk.tree_iter.TreeIter iter)

Generates a string representation of the iter.

getValue
void getValue(gtk.tree_iter.TreeIter iter, int column, gobject.value.Value value)

Initializes and sets value to that at column.

iterChildren
bool iterChildren(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter parent)

Sets iter to point to the first child of parent.

iterHasChild
bool iterHasChild(gtk.tree_iter.TreeIter iter)

Returns true if iter has children, false otherwise.

iterNChildren
int iterNChildren(gtk.tree_iter.TreeIter iter)

Returns the number of children that iter has.

iterNext
bool iterNext(gtk.tree_iter.TreeIter iter)

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

iterNthChild
bool iterNthChild(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter parent, int n)

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

iterParent
bool iterParent(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter child)

Sets iter to be the parent of child.

iterPrevious
bool iterPrevious(gtk.tree_iter.TreeIter iter)

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

refNode
void refNode(gtk.tree_iter.TreeIter iter)

Lets the tree ref the node.

rowChanged
void rowChanged(gtk.tree_path.TreePath path, gtk.tree_iter.TreeIter iter)

Emits the ::row-changed signal on tree_model.

rowDeleted
void rowDeleted(gtk.tree_path.TreePath path)

Emits the ::row-deleted signal on tree_model.

rowHasChildToggled
void rowHasChildToggled(gtk.tree_path.TreePath path, gtk.tree_iter.TreeIter iter)

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

rowInserted
void rowInserted(gtk.tree_path.TreePath path, gtk.tree_iter.TreeIter iter)

Emits the ::row-inserted signal on tree_model.

rowsReordered
void rowsReordered(gtk.tree_path.TreePath path, gtk.tree_iter.TreeIter iter, int[] newOrder)

Emits the ::rows-reordered signal on tree_model.

unrefNode
void unrefNode(gtk.tree_iter.TreeIter iter)

Lets the tree unref the node.

connectRowChanged
ulong connectRowChanged(T callback, Flag!"After" after)

Connect to RowChanged signal.

connectRowDeleted
ulong connectRowDeleted(T callback, Flag!"After" after)

Connect to RowDeleted signal.

connectRowHasChildToggled
ulong connectRowHasChildToggled(T callback, Flag!"After" after)

Connect to RowHasChildToggled signal.

connectRowInserted
ulong connectRowInserted(T callback, Flag!"After" after)

Connect to RowInserted signal.

From mixin TreeSortableT!()

getSortColumnId
bool getSortColumnId(int sortColumnId, gtk.types.SortType order)

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.

hasDefaultSortFunc
bool hasDefaultSortFunc()

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.

setDefaultSortFunc
void setDefaultSortFunc(gtk.types.TreeIterCompareFunc sortFunc)

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.

setSortColumnId
void setSortColumnId(int sortColumnId, gtk.types.SortType order)

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:

setSortFunc
void setSortFunc(int sortColumnId, gtk.types.TreeIterCompareFunc sortFunc)

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.

sortColumnChanged
void sortColumnChanged()

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

connectSortColumnChanged
ulong connectSortColumnChanged(T callback, Flag!"After" after)

Connect to SortColumnChanged signal.

Inherited Members

From ObjectG

setGObject
void setGObject(void* cObj, Flag!"Take" take)

Set the GObject of a D ObjectG wrapper.

cPtr
void* cPtr(Flag!"Dup" dup)

Get a pointer to the underlying C object.

ref_
void* ref_(void* gObj)

Calls g_object_ref() on a GObject.

unref
unref(void* gObj)

Calls g_object_unref() on a GObject.

getType
GType getType()

Get the GType of an object.

gType
GType gType [@property getter]

GObject GType property.

self
ObjectG self()

Convenience method to return this cast to a type. For use in D with statements.

getDObject
T getDObject(void* cptr, Flag!"Take" take)

Template to get the D object from a C GObject and cast it to the given D object type.

connectSignalClosure
ulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after)

Connect a D closure to an object signal.

setProperty
void setProperty(string propertyName, T val)

Template for setting a GObject property.

getProperty
T getProperty(string propertyName)

Template for getting a GObject property.

compatControl
size_t compatControl(size_t what, void* data)
bindProperty
gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags)

Creates a binding between source_property on source and target_property on target.

bindPropertyFull
gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.Closure transformFrom)

Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

forceFloating
void forceFloating()

This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling gobject.object.ObjectG.refSink.

freezeNotify
void freezeNotify()

Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.

getData
void* getData(string key)

Gets a named field from the objects table of associations (see gobject.object.ObjectG.setData).

getProperty
void getProperty(string propertyName, gobject.value.Value value)

Gets a property of an object.

getQdata
void* getQdata(glib.types.Quark quark)

This function gets back user data pointers stored via gobject.object.ObjectG.setQdata.

getv
void getv(string[] names, gobject.value.Value[] values)

Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

isFloating
bool isFloating()

Checks whether object has a floating[floating-ref] reference.

notify
void notify(string propertyName)

Emits a "notify" signal for the property property_name on object.

notifyByPspec
void notifyByPspec(gobject.param_spec.ParamSpec pspec)

Emits a "notify" signal for the property specified by pspec on object.

refSink
gobject.object.ObjectG refSink()

Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.

runDispose
void runDispose()

Releases all references to other objects. This can be used to break reference cycles.

setData
void setData(string key, void* data)

Each object carries around a table of associations from strings to pointers. This function lets you set an association.

setProperty
void setProperty(string propertyName, gobject.value.Value value)

Sets a property on an object.

stealData
void* stealData(string key)

Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

stealQdata
void* stealQdata(glib.types.Quark quark)

This function gets back user data pointers stored via gobject.object.ObjectG.setQdata and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

thawNotify
void thawNotify()

Reverts the effect of a previous call to gobject.object.ObjectG.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

watchClosure
void watchClosure(gobject.closure.Closure closure)

This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectG.ref_ and gobject.object.ObjectG.unref are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

connectNotify
ulong connectNotify(string detail, T callback, Flag!"After" after)

Connect to Notify signal.

From TreeDragSource

dragDataDelete
bool dragDataDelete(gtk.tree_path.TreePath path)

Asks the gtk.tree_drag_source.TreeDragSource 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!

dragDataGet
gdk.content_provider.ContentProvider dragDataGet(gtk.tree_path.TreePath path)

Asks the gtk.tree_drag_source.TreeDragSource to return a gdk.content_provider.ContentProvider representing the row at path. Should robustly handle a path no longer found in the model!

rowDraggable
bool rowDraggable(gtk.tree_path.TreePath path)

Asks the gtk.tree_drag_source.TreeDragSource 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.

From TreeModel

filterNew
gtk.tree_model.TreeModel filterNew(gtk.tree_path.TreePath root)

Creates a new gtk.tree_model.TreeModel, with child_model as the child_model and root as the virtual root.

foreach_
void foreach_(gtk.types.TreeModelForeachFunc func)

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

getColumnType
gobject.types.GType getColumnType(int index)

Returns the type of the column.

getFlags
gtk.types.TreeModelFlags getFlags()

Returns a set of flags supported by this interface.

getIter
bool getIter(gtk.tree_iter.TreeIter iter, gtk.tree_path.TreePath path)

Sets iter to a valid iterator pointing to path.

getIterFirst
bool getIterFirst(gtk.tree_iter.TreeIter iter)

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

getIterFromString
bool getIterFromString(gtk.tree_iter.TreeIter iter, string pathString)

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

getNColumns
int getNColumns()

Returns the number of columns supported by tree_model.

getPath
gtk.tree_path.TreePath getPath(gtk.tree_iter.TreeIter iter)

Returns a newly-created gtk.tree_path.TreePath referenced by iter.

getStringFromIter
string getStringFromIter(gtk.tree_iter.TreeIter iter)

Generates a string representation of the iter.

getValue
void getValue(gtk.tree_iter.TreeIter iter, int column, gobject.value.Value value)

Initializes and sets value to that at column.

iterChildren
bool iterChildren(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter parent)

Sets iter to point to the first child of parent.

iterHasChild
bool iterHasChild(gtk.tree_iter.TreeIter iter)

Returns true if iter has children, false otherwise.

iterNChildren
int iterNChildren(gtk.tree_iter.TreeIter iter)

Returns the number of children that iter has.

iterNext
bool iterNext(gtk.tree_iter.TreeIter iter)

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

iterNthChild
bool iterNthChild(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter parent, int n)

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

iterParent
bool iterParent(gtk.tree_iter.TreeIter iter, gtk.tree_iter.TreeIter child)

Sets iter to be the parent of child.

iterPrevious
bool iterPrevious(gtk.tree_iter.TreeIter iter)

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

refNode
void refNode(gtk.tree_iter.TreeIter iter)

Lets the tree ref the node.

rowChanged
void rowChanged(gtk.tree_path.TreePath path, gtk.tree_iter.TreeIter iter)

Emits the ::row-changed signal on tree_model.

rowDeleted
void rowDeleted(gtk.tree_path.TreePath path)

Emits the ::row-deleted signal on tree_model.

rowHasChildToggled
void rowHasChildToggled(gtk.tree_path.TreePath path, gtk.tree_iter.TreeIter iter)

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

rowInserted
void rowInserted(gtk.tree_path.TreePath path, gtk.tree_iter.TreeIter iter)

Emits the ::row-inserted signal on tree_model.

rowsReordered
void rowsReordered(gtk.tree_path.TreePath path, gtk.tree_iter.TreeIter iter, int[] newOrder)

Emits the ::rows-reordered signal on tree_model.

unrefNode
void unrefNode(gtk.tree_iter.TreeIter iter)

Lets the tree unref the node.

connectRowChanged
ulong connectRowChanged(T callback, Flag!"After" after)

Connect to RowChanged signal.

connectRowDeleted
ulong connectRowDeleted(T callback, Flag!"After" after)

Connect to RowDeleted signal.

connectRowHasChildToggled
ulong connectRowHasChildToggled(T callback, Flag!"After" after)

Connect to RowHasChildToggled signal.

connectRowInserted
ulong connectRowInserted(T callback, Flag!"After" after)

Connect to RowInserted signal.

From TreeSortable

getSortColumnId
bool getSortColumnId(int sortColumnId, gtk.types.SortType order)

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.

hasDefaultSortFunc
bool hasDefaultSortFunc()

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.

setDefaultSortFunc
void setDefaultSortFunc(gtk.types.TreeIterCompareFunc sortFunc)

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.

setSortColumnId
void setSortColumnId(int sortColumnId, gtk.types.SortType order)

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:

setSortFunc
void setSortFunc(int sortColumnId, gtk.types.TreeIterCompareFunc sortFunc)

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.

sortColumnChanged
void sortColumnChanged()

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

connectSortColumnChanged
ulong connectSortColumnChanged(T callback, Flag!"After" after)

Connect to SortColumnChanged signal.

Detailed Description

Deprecated: Use gtk.sort_list_model.SortListModel instead