gtk4/org.gtkkn.bindings.gtk/TreeSelection

TreeSelection

open class TreeSelection(pointer: <Error class: unknown class><<Error class: unknown class>>)

The selection object for GtkTreeView

The GtkTreeSelection object is a helper object to manage the selection for a GtkTreeView widget. The GtkTreeSelection object is automatically created when a new GtkTreeView widget is created, and cannot exist independently of this widget. The primary reason the GtkTreeSelection objects exists is for cleanliness of code and API. That is, there is no conceptual reason all these functions could not be methods on the GtkTreeView widget instead of a separate function.

The GtkTreeSelection object is gotten from a GtkTreeView by calling gtk_tree_view_get_selection(). It can be manipulated to check the selection status of the tree, as well as select and deselect individual rows. Selection is done completely view side. As a result, multiple views of the same model can have completely different selections. Additionally, you cannot change the selection of a row on the model that is not currently displayed by the view without expanding its parents first.

One of the important things to remember when monitoring the selection of a view is that the GtkTreeSelection::changed signal is mostly a hint. That is, it may only emit one signal when a range of rows is selected. Additionally, it may on occasion emit a GtkTreeSelection::changed signal when nothing has happened (mostly as a result of programmers calling select_row on an already selected row).

Skipped during bindings generation

parameter model: model: Out parameter is not supported
parameter model: model: Out parameter is not supported

Constructors

TreeSelection

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

Types

Companion

object Companion

Properties

gtkTreeSelectionPointer

val gtkTreeSelectionPointer: <Error class: unknown class><<Error class: unknown class>>

mode

open var mode: SelectionMode

Selection mode. See gtk_tree_selection_set_mode() for more information on this property.

Functions

connectChanged

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

Emitted whenever the selection has (possibly) changed. Please note that this signal is mostly a hint. It may only be emitted once when a range of rows are selected, and it may occasionally be emitted when nothing has happened.

countSelectedRows

open fun countSelectedRows(): Int

Returns the number of rows that have been selected in @tree.

getMode

open fun getMode(): SelectionMode

Gets the selection mode for @selection. See gtk_tree_selection_set_mode().

getTreeView

open fun getTreeView(): TreeView

Returns the tree view associated with @selection.

iterIsSelected

open fun iterIsSelected(iter: TreeIter): Boolean

Returns true if the row at @iter is currently selected.

pathIsSelected

open fun pathIsSelected(path: TreePath): Boolean

Returns true if the row pointed to by @path is currently selected. If @path does not point to a valid location, false is returned

selectAll

open fun selectAll()

Selects all the nodes. @selection must be set to %GTK_SELECTION_MULTIPLE mode.

selectedForeach

open fun selectedForeach(func: TreeSelectionForeachFunc)

Calls a function for each selected node. Note that you cannot modify the tree or selection from within this function. As a result, gtk_tree_selection_get_selected_rows() might be more useful.

selectIter

open fun selectIter(iter: TreeIter)

Selects the specified iterator.

selectPath

open fun selectPath(path: TreePath)

Select the row at @path.

selectRange

open fun selectRange(startPath: TreePath, endPath: TreePath)

Selects a range of nodes, determined by @start_path and @end_path inclusive.

setMode

open fun setMode(type: SelectionMode)

Sets the selection mode of the @selection. If the previous type was %GTK_SELECTION_MULTIPLE, then the anchor is kept selected, if it was previously selected.

setSelectFunction

open fun setSelectFunction(func: TreeSelectionFunc)

Sets the selection function.

unselectAll

open fun unselectAll()

Unselects all the nodes.

unselectIter

open fun unselectIter(iter: TreeIter)

Unselects the specified iterator.

unselectPath

open fun unselectPath(path: TreePath)

Unselects the row at @path.

unselectRange

open fun unselectRange(startPath: TreePath, endPath: TreePath)

Unselects a range of nodes, determined by @start_path and @end_path inclusive.