gtk4/org.gtkkn.bindings.gtk/TreeStore

TreeStore

open class TreeStore(pointer: <Error class: unknown class><<Error class: unknown class>>) : Buildable, TreeDragDest, TreeDragSource, TreeModel, TreeSortable

A tree-like data structure that can be used with the GtkTreeView

The GtkTreeStore object is a list model for use with a GtkTreeView widget. It implements the GtkTreeModel interface, and consequently, can use all of the methods available there. It also implements the GtkTreeSortable interface so it can be sorted by the view. Finally, it also implements the tree gtk3-GtkTreeView-drag-and-drop interfaces.

GtkTreeStore as GtkBuildable

The GtkTreeStore implementation of the GtkBuildable interface allows to specify the model columns with a element that may contain multiple elements, each specifying one model column. The “type” attribute specifies the data type for the column.

An example of a UI Definition fragment for a tree store: ||

Skipped during bindings generation

parameter columns: Array parameter of type gint is not supported
parameter types: Array parameter of type GType is not supported
parameter columns: Array parameter of type gint is not supported
parameter types: Array parameter of type GType is not supported

Constructors

TreeStore

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

Types

Companion

object Companion

Properties

gtkBuildablePointer

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

gtkTreeDragDestPointer

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

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>>

gtkTreeSortablePointer

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

gtkTreeStorePointer

val gtkTreeStorePointer: <Error class: unknown class><<Error class: unknown class>>

Functions

append

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

Appends a new row to @tree_store. If @parent is non-null, then it will append the new row after the last child of @parent, otherwise it will append a row to the top level. @iter will be changed to point to this new row. The row will be empty after this function is called. To fill in values, you need to call gtk_tree_store_set() or gtk_tree_store_set_value().

clear

open fun clear()

Removes all rows from @tree_store

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.

dragDataDelete

open fun dragDataDelete(path: TreePath): Boolean

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

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

Asks the GtkTreeDragSource to return a GdkContentProvider representing the row at @path. Should robustly handle a @path no longer found in the model!

dragDataReceived

open fun dragDataReceived(dest: TreePath, value: <Error class: unknown class>): Boolean

Asks the GtkTreeDragDest to insert a row before the path @dest, deriving the contents of the row from @value. If @dest is outside the tree so that inserting before it is impossible, false will be returned. Also, false may be returned if the new row is not created for some model-specific reason. Should robustly handle a @dest no longer found in the model!

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.

getBuildableId

open fun getBuildableId(): String?

Gets the ID of the @buildable object.

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.

insert

open fun insert(iter: TreeIter, parent: TreeIter? = null, position: Int)

Creates a new row at @position. If parent is non-null, then the row will be made a child of @parent. Otherwise, the row will be created at the toplevel. If @position is -1 or is larger than the number of rows at that level, then the new row will be inserted to the end of the list. @iter will be changed to point to this new row. The row will be empty after this function is called. To fill in values, you need to call gtk_tree_store_set() or gtk_tree_store_set_value().

insertAfter

open fun insertAfter(iter: TreeIter, parent: TreeIter? = null, sibling: TreeIter? = null)

Inserts a new row after @sibling. If @sibling is null, then the row will be prepended to @parent ’s children. If @parent and @sibling are null, then the row will be prepended to the toplevel. If both @sibling and @parent are set, then @parent must be the parent of @sibling. When @sibling is set,

insertBefore

open fun insertBefore(iter: TreeIter, parent: TreeIter? = null, sibling: TreeIter? = null)

Inserts a new row before @sibling. If @sibling is null, then the row will be appended to @parent ’s children. If @parent and @sibling are null, then the row will be appended to the toplevel. If both @sibling and @parent are set, then @parent must be the parent of @sibling. When @sibling is set,

isAncestor

open fun isAncestor(iter: TreeIter, descendant: TreeIter): Boolean

Returns true if @iter is an ancestor of @descendant. That is, @iter is the parent (or grandparent or great-grandparent) of @descendant.

iterChildren

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

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

iterDepth

open fun iterDepth(iter: TreeIter): Int

Returns the depth of @iter. This will be 0 for anything on the root level, 1 for anything down a level, etc.

iterHasChild

open fun iterHasChild(iter: TreeIter): Boolean

Returns true if @iter has children, false otherwise.

iterIsValid

open fun iterIsValid(iter: TreeIter): Boolean

Checks if the given iter is a valid iter for this GtkTreeStore.

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.

moveAfter

open fun moveAfter(iter: TreeIter, position: TreeIter? = null)

Moves @iter in @tree_store to the position after @position. @iter and

moveBefore

open fun moveBefore(iter: TreeIter, position: TreeIter? = null)

Moves @iter in @tree_store to the position before @position. @iter and

prepend

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

Prepends a new row to @tree_store. If @parent is non-null, then it will prepend the new row before the first child of @parent, otherwise it will prepend a row to the top level. @iter will be changed to point to this new row. The row will be empty after this function is called. To fill in values, you need to call gtk_tree_store_set() or gtk_tree_store_set_value().

refNode

open fun refNode(iter: TreeIter)

Lets the tree ref the node.

remove

open fun remove(iter: TreeIter): Boolean

Removes @iter from @tree_store. After being removed, @iter is set to the next valid row at that level, or invalidated if it previously pointed to the last one.

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.

rowDraggable

open fun rowDraggable(path: TreePath): Boolean

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.

rowDropPossible

open fun rowDropPossible(destPath: TreePath, value: <Error class: unknown class>): Boolean

Determines whether a drop is possible before the given @dest_path, at the same depth as @dest_path. i.e., can we drop the data in

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.

setValue

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

Sets the data in the cell specified by @iter and @column. The type of @value must be convertible to the type of the column.

sortColumnChanged

open fun sortColumnChanged()

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

swap

open fun swap(a: TreeIter, b: TreeIter)

Swaps @a and @b in the same level of @tree_store. Note that this function only works with unsorted stores.

unrefNode

open fun unrefNode(iter: TreeIter)

Lets the tree unref the node.