gtk4/org.gtkkn.bindings.gtk/TreeSortable

TreeSortable

The interface for sortable models used by GtkTreeView

GtkTreeSortable is an interface to be implemented by tree models which support sorting. The GtkTreeView uses the methods provided by this interface to sort the model.

Skipped during bindings generation

parameter sort_column_id: sort_column_id: Out parameter is not supported

Inheritors

ListStore

TreeModelSort

TreeStore

Types

Companion

object Companion

Properties

gtkTreeModelPointer

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

gtkTreeSortablePointer

abstract val gtkTreeSortablePointer: <Error class: unknown class><<Error class: unknown class>>

Functions

connectRowChanged

open fun connectRowChanged(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.

connectRowDeleted

open fun connectRowDeleted(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.

connectRowHasChildToggled

open fun connectRowHasChildToggled(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.

connectRowInserted

open fun connectRowInserted(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.

connectSortColumnChanged

open fun connectSortColumnChanged(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.

filterNew

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

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

foreach

open fun foreach(func: TreeModelForeachFunc)

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

getColumnType

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

Returns the type of the column.

getFlags

open fun getFlags(): TreeModelFlags

Returns a set of flags supported by this interface.

getIter

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

Sets @iter to a valid iterator pointing to @path.

getIterFirst

open fun getIterFirst(iter: TreeIter): Boolean

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

getIterFromString

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

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

getNColumns

open fun getNColumns(): Int

Returns the number of columns supported by @tree_model.

getPath

open fun getPath(iter: TreeIter): TreePath

Returns a newly-created GtkTreePath referenced by @iter.

getStringFromIter

open fun getStringFromIter(iter: TreeIter): String?

Generates a string representation of the iter.

getValue

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

Initializes and sets @value to that at @column.

hasDefaultSortFunc

open fun hasDefaultSortFunc(): Boolean

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.

iterChildren

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

Sets @iter to point to the first child of @parent.

iterHasChild

open fun iterHasChild(iter: TreeIter): Boolean

Returns true if @iter has children, false otherwise.

iterNChildren

open fun iterNChildren(iter: TreeIter? = null): Int

Returns the number of children that @iter has.

iterNext

open fun iterNext(iter: TreeIter): Boolean

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

iterNthChild

open fun iterNthChild(iter: TreeIter, parent: TreeIter? = null, n: Int): Boolean

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

iterParent

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

Sets @iter to be the parent of @child.

iterPrevious

open fun iterPrevious(iter: TreeIter): Boolean

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

refNode

open fun refNode(iter: TreeIter)

Lets the tree ref the node.

rowChanged

open fun rowChanged(path: TreePath, iter: TreeIter)

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

rowDeleted

open fun rowDeleted(path: TreePath)

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

rowHasChildToggled

open fun rowHasChildToggled(path: TreePath, iter: TreeIter)

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

rowInserted

open fun rowInserted(path: TreePath, iter: TreeIter)

Emits the ::row-inserted signal on @tree_model.

setDefaultSortFunc

open fun setDefaultSortFunc(sortFunc: TreeIterCompareFunc)

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

open fun setSortColumnId(sortColumnId: Int, order: SortType)

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

open fun setSortFunc(sortColumnId: Int, sortFunc: TreeIterCompareFunc)

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

open fun sortColumnChanged()

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

unrefNode

open fun unrefNode(iter: TreeIter)

Lets the tree unref the node.