TreeModelSort

The gtk.TreeModelSort 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 gtk.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.TreeView widgets each with a view of the same data. As the model is wrapped here by a gtk.TreeModelSort, the two gtk.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.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.TreeSelection 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);
}

class TreeModelSort : ObjectG , TreeDragSourceIF , TreeModelIF , TreeSortableIF {

protected

GtkTreeModelSort* gtkTreeModelSort;

GtkTreeModelSort* getTreeModelSortStruct(bool transferOwnership);

void* getStruct();

this(GtkTreeModelSort* gtkTreeModelSort, bool ownedRef);

static GType getType();

void clearCache();

bool convertChildIterToIter(TreeIter sortIter, TreeIter childIter);

TreePath convertChildPathToPath(TreePath childPath);

void convertIterToChildIter(TreeIter childIter, TreeIter sortedIter);

TreePath convertPathToChildPath(TreePath sortedPath);

TreeModelIF getModel();

bool iterIsValid(TreeIter iter);

void resetDefaultSortFunc();

this(TreeModelIF childModel);

}

Constructors

this this(GtkTreeModelSort* gtkTreeModelSort, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(TreeModelIF childModel): Creates a new gtk.TreeModel, with child_model as the child model.

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 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(TreeIter sortIter, 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 TreePath convertChildPathToPath(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(TreeIter childIter, TreeIter sortedIter): Sets child_iter to point to the row pointed to by sorted_iter.
convertPathToChildPath TreePath convertPathToChildPath(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 TreeModelIF getModel(): Returns the model the gtk.TreeModelSort is sorting.
getStruct void* getStruct(): the main Gtk struct as a void*
getTreeModelSortStruct GtkTreeModelSort* getTreeModelSortStruct(bool transferOwnership): Get the main Gtk struct
iterIsValid bool iterIsValid(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.TreeModelSort is in “unsorted” state.

Static functions

getType GType getType()

Variables

gtkTreeModelSort GtkTreeModelSort* gtkTreeModelSort;: the main Gtk struct

Inherited Members

From ObjectG

gObject GObject* gObject;: the main Gtk struct
getObjectGStruct GObject* getObjectGStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
opCast T opCast()
getDObject RT getDObject(U obj, bool ownedRef): Gets a D Object from the objects table of associations.
setProperty void setProperty(string propertyName, T value)
addOnNotify gulong addOnNotify(void delegate(ParamSpec, ObjectG) dlg, string property, ConnectFlags connectFlags): The notify signal is emitted on an object when one of its properties has been changed. Note that getting this signal doesn't guarantee that the value of the property has actually changed, it may also be emitted when the setter for the property is called to reinstate the previous value.
getType GType getType()
compatControl size_t compatControl(size_t what, void* data)
interfaceFindProperty ParamSpec interfaceFindProperty(TypeInterface gIface, string propertyName): Find the gobject.ParamSpec with the given name for an interface. Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().
interfaceInstallProperty void interfaceInstallProperty(TypeInterface gIface, ParamSpec pspec): Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created gobject.ParamSpec, but normally ObjectClass.overrideProperty will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.
interfaceListProperties ParamSpec[] interfaceListProperties(TypeInterface gIface): Lists the properties of an interface.Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().
addToggleRef void addToggleRef(GToggleNotify notify, void* data): Increases the reference count of the object by one and sets a callback to be called when all other references to the object are dropped, or when this is already the last reference to the object and another reference is established.
addWeakPointer void addWeakPointer(void* weakPointerLocation): Adds a weak reference from weak_pointer to object to indicate that the pointer located at weak_pointer_location is only valid during the lifetime of object. When the object is finalized, weak_pointer will be set to NULL.
bindProperty Binding bindProperty(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags): Creates a binding between source_property on source and target_property on target. Whenever the source_property is changed the target_property is updated using the same value. For instance:
bindPropertyFull Binding bindPropertyFull(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags, GBindingTransformFunc transformTo, GBindingTransformFunc transformFrom, void* userData, GDestroyNotify notify): Complete version of g_object_bind_property().
bindPropertyWithClosures Binding bindPropertyWithClosures(string sourceProperty, ObjectG target, string targetProperty, GBindingFlags flags, Closure transformTo, 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.
dupData void* dupData(string key, GDuplicateFunc dupFunc, void* userData): This is a variant of g_object_get_data() which returns a 'duplicate' of the value. dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object.
dupQdata void* dupQdata(GQuark quark, GDuplicateFunc dupFunc, void* userData): This is a variant of g_object_get_qdata() which returns a 'duplicate' of the value. dup_func defines the meaning of 'duplicate' in this context, it could e.g. take a reference on a ref-counted object.
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 g_object_ref_sink().
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 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 g_object_set_data()).
getProperty void getProperty(string propertyName, Value value): Gets a property of an object.
getQdata void* getQdata(GQuark quark): This function gets back user data pointers stored via g_object_set_qdata().
getValist void getValist(string firstPropertyName, void* varArgs): Gets properties of an object.
getv void getv(string[] names, 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(ParamSpec pspec): Emits a "notify" signal for the property specified by pspec on object.
ref_ ObjectG ref_(): Increases the reference count of object.
refSink ObjectG refSink(): Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
removeToggleRef void removeToggleRef(GToggleNotify notify, void* data): Removes a reference added with g_object_add_toggle_ref(). The reference count of the object is decreased by one.
removeWeakPointer void removeWeakPointer(void* weakPointerLocation): Removes a weak reference from object that was previously added using g_object_add_weak_pointer(). The weak_pointer_location has to match the one used with g_object_add_weak_pointer().
replaceData bool replaceData(string key, void* oldval, void* newval, GDestroyNotify destroy, GDestroyNotify oldDestroy): Compares the user data for the key key on object with oldval, and if they are the same, replaces oldval with newval.
replaceQdata bool replaceQdata(GQuark quark, void* oldval, void* newval, GDestroyNotify destroy, GDestroyNotify oldDestroy): Compares the user data for the key quark on object with oldval, and if they are the same, replaces oldval with newval.
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.
setDataFull void setDataFull(string key, void* data, GDestroyNotify destroy): Like g_object_set_data() except it adds notification for when the association is destroyed, either by setting it to a different value or when the object is destroyed.
setProperty void setProperty(string propertyName, Value value): Sets a property on an object.
setQdata void setQdata(GQuark quark, void* data): This sets an opaque, named pointer on an object. The name is specified through a GQuark (retrived e.g. via g_quark_from_static_string()), and the pointer can be gotten back from the object with g_object_get_qdata() until the object is finalized. Setting a previously set user data pointer, overrides (frees) the old pointer set, using NULL as pointer essentially removes the data stored.
setQdataFull void setQdataFull(GQuark quark, void* data, GDestroyNotify destroy): This function works like g_object_set_qdata(), but in addition, a void (*destroy) (gpointer) function may be specified which is called with data as argument when the object is finalized, or the data is being overwritten by a call to g_object_set_qdata() with the same quark.
setValist void setValist(string firstPropertyName, void* varArgs): Sets properties on an object.
setv void setv(string[] names, Value[] values): Sets n_properties properties for an object. Properties to be set will be taken from values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
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(GQuark quark): This function gets back user data pointers stored via g_object_set_qdata() 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 g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.
unref void unref(): Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).
watchClosure void watchClosure(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 Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_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.
weakRef void weakRef(GWeakNotify notify, void* data): Adds a weak reference callback to an object. Weak references are used for notification when an object is finalized. They are called "weak references" because they allow you to safely hold a pointer to an object without calling g_object_ref() (g_object_ref() adds a strong reference, that is, forces the object to stay alive).
weakUnref void weakUnref(GWeakNotify notify, void* data): Removes a weak reference callback to an object.
clearObject void clearObject(ObjectG objectPtr): Clears a reference to a GObject

From TreeDragSourceIF

getTreeDragSourceStruct GtkTreeDragSource* getTreeDragSourceStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
getType GType getType()
dragDataDelete bool dragDataDelete(TreePath path): 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!
dragDataGet bool dragDataGet(TreePath path, SelectionData selectionData): 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!
rowDraggable bool rowDraggable(TreePath path): 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.
getRowDragData bool getRowDragData(SelectionData selectionData, TreeModelIF treeModel, TreePath path): Obtains a tree_model and path from selection data of target type GTK_TREE_MODEL_ROW. Normally called from a drag_data_received handler. This function can only be used if selection_data originates from the same process that’s calling this function, because a pointer to the tree model is being passed around. If you aren’t in the same process, then you'll get memory corruption. In the GtkTreeDragDest drag_data_received handler, you can assume that selection data of type GTK_TREE_MODEL_ROW is in from the current process. The returned path must be freed with TreePath.free.
setRowDragData bool setRowDragData(SelectionData selectionData, TreeModelIF treeModel, TreePath path): Sets selection data of target type GTK_TREE_MODEL_ROW. Normally used in a drag_data_get handler.

From TreeModelIF

getTreeModelStruct GtkTreeModel* getTreeModelStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
getValueString string getValueString(TreeIter iter, int column): Get the value of a column as a char array. this is the same calling getValue and get the string from the value object
getValueInt int getValueInt(TreeIter iter, int column): Get the value of a column as a char array. this is the same calling getValue and get the int from the value object
getIter int getIter(TreeIter iter, TreePath path): Sets iter to a valid iterator pointing to path.
getValue Value getValue(TreeIter iter, int column, Value value): Initializes and sets value to that at column. When done with value, Value.unset needs to be called to free any allocated memory.
getType GType getType()
foreach_ void foreach_(GtkTreeModelForeachFunc func, void* userData): Calls func on each node in model in a depth-first fashion.
getColumnType GType getColumnType(int index): Returns the type of the column.
getFlags GtkTreeModelFlags getFlags(): Returns a set of flags supported by this interface.
getIterFirst bool getIterFirst(TreeIter iter): 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.
getIterFromString bool getIterFromString(TreeIter iter, string pathString): Sets iter to a valid iterator pointing to path_string, if it exists. Otherwise, iter is left invalid and FALSE is returned.
getNColumns int getNColumns(): Returns the number of columns supported by tree_model.
getPath TreePath getPath(TreeIter iter): Returns a newly-created [GtkTreePath-struct|GtkTreePath-struct] referenced by iter.
getStringFromIter string getStringFromIter(TreeIter iter): Generates a string representation of the iter.
getValist void getValist(TreeIter iter, void* varArgs): See TreeModel.get, this version takes a va_list for language bindings to use.
iterChildren bool iterChildren(TreeIter iter, TreeIter parent): Sets iter to point to the first child of parent.
iterHasChild bool iterHasChild(TreeIter iter): Returns TRUE if iter has children, FALSE otherwise.
iterNChildren int iterNChildren(TreeIter iter): Returns the number of children that iter has.
iterNext bool iterNext(TreeIter iter): Sets iter to point to the node following it at the current level.
iterNthChild bool iterNthChild(TreeIter iter, TreeIter parent, int n): Sets iter to be the child of parent, using the given index.
iterParent bool iterParent(TreeIter iter, TreeIter child): Sets iter to be the parent of child.
iterPrevious bool iterPrevious(TreeIter iter): Sets iter to point to the previous node at the current level.
refNode void refNode(TreeIter iter): Lets the tree ref the node.
rowChanged void rowChanged(TreePath path, TreeIter iter): Emits the row-changed signal on tree_model.
rowDeleted void rowDeleted(TreePath path): Emits the row-deleted signal on tree_model.
rowHasChildToggled void rowHasChildToggled(TreePath path, TreeIter iter): Emits the row-has-child-toggled signal on tree_model. This should be called by models after the child state of a node changes.
rowInserted void rowInserted(TreePath path, TreeIter iter): Emits the row-inserted signal on tree_model.
rowsReordered void rowsReordered(TreePath path, TreeIter iter, int* newOrder): Emits the rows-reordered signal on tree_model.
rowsReorderedWithLength void rowsReorderedWithLength(TreePath path, TreeIter iter, int[] newOrder): Emits the rows-reordered signal on tree_model.
unrefNode void unrefNode(TreeIter iter): Lets the tree unref the node.
addOnRowChanged gulong addOnRowChanged(void delegate(TreePath, TreeIter, TreeModelIF) dlg, ConnectFlags connectFlags): This signal is emitted when a row in the model has changed.
addOnRowDeleted gulong addOnRowDeleted(void delegate(TreePath, TreeModelIF) dlg, ConnectFlags connectFlags): This signal is emitted when a row has been deleted.
addOnRowHasChildToggled gulong addOnRowHasChildToggled(void delegate(TreePath, TreeIter, TreeModelIF) dlg, ConnectFlags connectFlags): This signal is emitted when a row has gotten the first child row or lost its last child row.
addOnRowInserted gulong addOnRowInserted(void delegate(TreePath, TreeIter, TreeModelIF) dlg, ConnectFlags connectFlags): This signal is emitted when a new row has been inserted in the model.
addOnRowsReordered gulong addOnRowsReordered(void delegate(TreePath, TreeIter, void*, TreeModelIF) dlg, ConnectFlags connectFlags): This signal is emitted when the children of a node in the gtk.TreeModel have been reordered.

From TreeSortableIF

getTreeSortableStruct GtkTreeSortable* getTreeSortableStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
getType GType getType()
getSortColumnId bool getSortColumnId(int sortColumnId, GtkSortType 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(GtkTreeIterCompareFunc sortFunc, void* userData, GDestroyNotify destroy): 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, GtkSortType order): Sets the current sort column to be sort_column_id. The sortable will resort itself to reflect this change, after emitting a 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, GtkTreeIterCompareFunc sortFunc, void* userData, GDestroyNotify destroy): 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 sort-column-changed signal on sortable.
addOnSortColumnChanged gulong addOnSortColumnChanged(void delegate(TreeSortableIF) dlg, ConnectFlags connectFlags): 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.

gtk TreeModelSort classes

TreeModelSort