gtk4/org.gtkkn.bindings.gtk/TreeModelSort

TreeModelSort

open class TreeModelSort( val gtkTreeModelSortPointer: <Error class: unknown class><<Error class: unknown class>>) : TreeDragSource, TreeModel, TreeSortable(source)

⚠️ Deprecated ⚠️

This is deprecated since version 4.10.

Use class@Gtk.SortListModel instead

---

A GtkTreeModel which makes an underlying tree model sortable

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

|[ 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); } ]|

Constructors

TreeModelSort

constructor(childModel: TreeModel)

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

constructor(gtkTreeModelSortPointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

gtkTreeDragSourcePointer

open override val gtkTreeDragSourcePointer: <Error class: unknown class><<Error class: unknown class>>

gtkTreeModelPointer

open override val gtkTreeModelPointer: <Error class: unknown class><<Error class: unknown class>>

gtkTreeModelSortPointer

val gtkTreeModelSortPointer: <Error class: unknown class><<Error class: unknown class>>

gtkTreeSortablePointer

open override val gtkTreeSortablePointer: <Error class: unknown class><<Error class: unknown class>>

model

open val model: TreeModel

The model of the tree model sort.

Functions

clearCache

open fun clearCache()

This is deprecated since version 4.10.

---

convertChildIterToIter

open fun convertChildIterToIter(sortIter: TreeIter, childIter: TreeIter): Boolean

This is deprecated since version 4.10.

---

convertChildPathToPath

open fun convertChildPathToPath(childPath: TreePath): TreePath?

This is deprecated since version 4.10.

---

convertIterToChildIter

open fun convertIterToChildIter(childIter: TreeIter, sortedIter: TreeIter)

This is deprecated since version 4.10.

---

convertPathToChildPath

open fun convertPathToChildPath(sortedPath: TreePath): TreePath?

This is deprecated since version 4.10.

---

dragDataDelete

open fun dragDataDelete(path: TreePath): Boolean

This is deprecated since version 4.10.

dragDataGet

open fun dragDataGet(path: TreePath): <Error class: unknown class>?

This is deprecated since version 4.10.

filterNew

open fun filterNew(root: TreePath? = null): TreeModel

This is deprecated since version 4.10.

---

foreach

open fun foreach(func: TreeModelForeachFunc)

This is deprecated since version 4.10.

---

getColumnType

open fun getColumnType(index: <Error class: unknown class>): <Error class: unknown class>

This is deprecated since version 4.10.

---

getFlags

open fun getFlags(): TreeModelFlags

This is deprecated since version 4.10.

---

getIter

open fun getIter(iter: TreeIter, path: TreePath): Boolean

This is deprecated since version 4.10.

---

getIterFirst

open fun getIterFirst(iter: TreeIter): Boolean

This is deprecated since version 4.10.

---

getIterFromString

open fun getIterFromString(iter: TreeIter, pathString: String): Boolean

This is deprecated since version 4.10.

---

getNColumns

open fun getNColumns(): <Error class: unknown class>

This is deprecated since version 4.10.

---

getPath

open fun getPath(iter: TreeIter): TreePath

This is deprecated since version 4.10.

---

getStringFromIter

open fun getStringFromIter(iter: TreeIter): String?

This is deprecated since version 4.10.

---

getValue

open fun getValue(iter: TreeIter, column: <Error class: unknown class>, value: <Error class: unknown class>)

This is deprecated since version 4.10.

---

hasDefaultSortFunc

open fun hasDefaultSortFunc(): Boolean

This is deprecated since version 4.10.

---

iterChildren

open fun iterChildren(iter: TreeIter, parent: TreeIter? = null): Boolean

This is deprecated since version 4.10.

---

iterHasChild

open fun iterHasChild(iter: TreeIter): Boolean

This is deprecated since version 4.10.

---

iterIsValid

open fun iterIsValid(iter: TreeIter): Boolean

This is deprecated since version 4.10.

---

iterNChildren

open fun iterNChildren(iter: TreeIter? = null): <Error class: unknown class>

This is deprecated since version 4.10.

---

iterNext

open fun iterNext(iter: TreeIter): Boolean

This is deprecated since version 4.10.

---

iterNthChild

open fun iterNthChild(iter: TreeIter, parent: TreeIter? = null, n: <Error class: unknown class>): Boolean

This is deprecated since version 4.10.

---

iterParent

open fun iterParent(iter: TreeIter, child: TreeIter): Boolean

This is deprecated since version 4.10.

---

iterPrevious

open fun iterPrevious(iter: TreeIter): Boolean

This is deprecated since version 4.10.

---

onRowChanged

open fun onRowChanged( connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (path: TreePath, iter: TreeIter) -> Unit): <Error class: unknown class>

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

onRowDeleted

open fun onRowDeleted( connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (path: TreePath) -> Unit): <Error class: unknown class>

This signal is emitted when a row has been deleted.

onRowHasChildToggled

open fun onRowHasChildToggled( connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (path: TreePath, iter: TreeIter) -> Unit): <Error class: unknown class>

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

onRowInserted

open fun onRowInserted( connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (path: TreePath, iter: TreeIter) -> Unit): <Error class: unknown class>

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

onRowsReordered

open fun onRowsReordered( connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (path: TreePath, iter: TreeIter, <Error class: unknown class>?) -> Unit): <Error class: unknown class>

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

onSortColumnChanged

open fun onSortColumnChanged(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: () -> Unit): <Error class: unknown class>

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.

refNode

open fun refNode(iter: TreeIter)

This is deprecated since version 4.10.

---

resetDefaultSortFunc

open fun resetDefaultSortFunc()

This is deprecated since version 4.10.

---

rowChanged