gtk4/org.gtkkn.bindings.gtk/TreeView

TreeView

open class TreeView(pointer: <Error class: unknown class><<Error class: unknown class>>) : Widget, Scrollable

A widget for displaying both trees and lists

Widget that displays any object that implements the iface@Gtk.TreeModel interface.

Please refer to the section-tree-widget.html for an overview of all the objects and data types related to the tree widget and how they work together.

Coordinate systems in GtkTreeView API

Several different coordinate systems are exposed in the GtkTreeView API. These are:

Widget coordinates: Coordinates relative to the widget (usually widget->window).
Bin window coordinates: Coordinates relative to the window that GtkTreeView renders to.
Tree coordinates: Coordinates relative to the entire scrollable area of GtkTreeView. These coordinates start at (0, 0) for row 0 of the tree.

Several functions are available for converting between the different coordinate systems. The most common translations are between widget and bin window coordinates and between bin window and tree coordinates. For the former you can use method@Gtk.TreeView.convert_widget_to_bin_window_coords (and vice versa), for the latter method@Gtk.TreeView.convert_bin_window_to_tree_coords (and vice versa).

`GtkTreeView` as `GtkBuildable`

The GtkTreeView implementation of the GtkBuildable interface accepts class@Gtk.TreeViewColumn objects as <child> elements and exposes the internal class@Gtk.TreeSelection in UI definitions.

An example of a UI definition fragment with GtkTreeView:

<object class="GtkTreeView" id="treeview">
  <property name="model">liststore1</property>
  <child>
    <object class="GtkTreeViewColumn" id="test-column">
      <property name="title">Test</property>
      <child>
        <object class="GtkCellRendererText" id="test-renderer"/>
        <attributes>
          <attribute name="text">1</attribute>
        </attributes>
      </child>
    </object>
  </child>
  <child internal-child="selection">
    <object class="GtkTreeSelection" id="selection">
      <signal name="changed" handler="on_treeview_selection_changed"/>
    </object>
  </child>
</object>

CSS nodes

treeview.view
├── header
│   ├── button
│   │   ╰── [sort-indicator]
┊   ┊
│   ╰── button
│       ╰── [sort-indicator]
│
├── [rubberband]
╰── [dndtarget]

GtkTreeView has a main CSS node with name treeview and style class .view. It has a subnode with name header, which is the parent for all the column header widgets' CSS nodes.

Each column header consists of a button, which among other content, has a child with name sort-indicator, which carries the .ascending or .descending style classes when the column header should show a sort indicator. The CSS is expected to provide a suitable image using the -gtk-icon-source property.

For rubberband selection, a subnode with name rubberband is used.

For the drop target location during DND, a subnode with name dndtarget is used.

Skipped during bindings generation

parameter tx: tx: Out parameter is not supported
parameter wx: wx: Out parameter is not supported
parameter bx: bx: Out parameter is not supported
parameter wx: wx: Out parameter is not supported
parameter bx: bx: Out parameter is not supported
parameter tx: tx: Out parameter is not supported
parameter path: path: Out parameter is not supported
parameter path: path: Out parameter is not supported
parameter path: path: Out parameter is not supported
parameter path: path: Out parameter is not supported
parameter model: model: Out parameter is not supported
parameter start_path: start_path: Out parameter is not supported
parameter path: path: Out parameter is not supported
method enable-grid-lines: Property has no getter nor setter

Constructors

TreeView

constructor()

Creates a new GtkTreeView widget.

constructor(model: TreeModel)

Creates a new GtkTreeView widget with the model initialized to @model.

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

Types

Companion

object Companion

Properties

accessibleRole

open val accessibleRole: AccessibleRole

The accessible role of the given GtkAccessible implementation.

activateOnSingleClick

open var activateOnSingleClick: Boolean

The activate-on-single-click property specifies whether the "row-activated" signal will be emitted after a single click.

canFocus

open var canFocus: Boolean

Whether the widget or any of its descendents can accept the input focus.

canTarget

open var canTarget: Boolean

Whether the widget can receive pointer events.

cssClasses

open var cssClasses: List<String>

A list of css classes applied to this widget.

cssName

open val cssName: String

The name of this widget in the CSS tree.

cursor

open var cursor: <Error class: unknown class>?

The cursor used by @widget.

enableSearch

open var enableSearch: Boolean

enableTreeLines

open var enableTreeLines: Boolean

expanderColumn

open var expanderColumn: TreeViewColumn?

fixedHeightMode

open var fixedHeightMode: Boolean

Setting the ::fixed-height-mode property to true speeds up GtkTreeView by assuming that all rows have the same height. Only enable this option if all rows are the same height. Please see gtk_tree_view_set_fixed_height_mode() for more information on this option.

focusable

open var focusable: Boolean

Whether this widget itself will accept the input focus.

focusOnClick

open var focusOnClick: Boolean

Whether the widget should grab focus when it is clicked with the mouse.

gtkAccessiblePointer

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

gtkBuildablePointer

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

gtkConstraintTargetPointer

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

gtkScrollablePointer

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

gtkTreeViewPointer

val gtkTreeViewPointer: <Error class: unknown class><<Error class: unknown class>>

gtkWidgetPointer

val gtkWidgetPointer: <Error class: unknown class><<Error class: unknown class>>

hadjustment

open var hadjustment: Adjustment?

Horizontal GtkAdjustment of the scrollable widget.

halign

open var halign: Align

How to distribute horizontal space if widget gets extra space.

hasTooltip

open var hasTooltip: Boolean

Enables or disables the emission of the ::query-tooltip signal on @widget.

headersClickable

open var headersClickable: Boolean

headersVisible

open var headersVisible: Boolean

hexpand

open var hexpand: Boolean

Whether to expand horizontally.

hexpandSet

open var hexpandSet: Boolean

Whether to use the hexpand property.

hoverExpand

open var hoverExpand: Boolean

Enables or disables the hover expansion mode of @tree_view. Hover expansion makes rows expand or collapse if the pointer moves over them.

hoverSelection

open var hoverSelection: Boolean

Enables or disables the hover selection mode of @tree_view. Hover selection makes the selected row follow the pointer. Currently, this works only for the selection modes %GTK_SELECTION_SINGLE and %GTK_SELECTION_BROWSE.

hscrollPolicy

open var hscrollPolicy: ScrollablePolicy

Determines when horizontal scrolling should start.

layoutManager

open var layoutManager: LayoutManager?

The GtkLayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

levelIndentation

open var levelIndentation: Int

Extra indentation for each level.

marginBottom

open var marginBottom: Int

Margin on bottom side of widget.

marginEnd

open var marginEnd: Int

Margin on end of widget, horizontally.

marginStart

open var marginStart: Int

Margin on start of widget, horizontally.

marginTop

open var marginTop: Int

Margin on top side of widget.

model

open var model: TreeModel?

name

open var name: String

The name of the widget.

opacity

open var opacity: Double

The requested opacity of the widget.

overflow

open var overflow: Overflow

How content outside the widget's content area is treated.

parent

open val parent: Widget?

The parent widget of this widget.

receivesDefault

open var receivesDefault: Boolean

Whether the widget will receive the default action when it is focused.

reorderable

open var reorderable: Boolean

root

open val root: Root?

The GtkRoot widget of the widget tree containing this widget.

rubberBanding

open var rubberBanding: Boolean

scaleFactor

open val scaleFactor: Int

The scale factor of the widget.

searchColumn

open var searchColumn: Int

showExpanders

open var showExpanders: Boolean

true if the view has expanders.

tooltipColumn

open var tooltipColumn: Int

tooltipMarkup

open var tooltipMarkup: String?

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

tooltipText

open var tooltipText: String?

Sets the text of tooltip to be the given string.

vadjustment

open var vadjustment: Adjustment?

Vertical GtkAdjustment of the scrollable widget.

valign

open var valign: Align

How to distribute vertical space if widget gets extra space.

vexpand

open var vexpand: Boolean

Whether to expand vertically.

vexpandSet

open var vexpandSet: Boolean

Whether to use the vexpand property.

vscrollPolicy

open var vscrollPolicy: ScrollablePolicy

Determines when vertical scrolling should start.

Functions

actionSetEnabled

open fun actionSetEnabled(actionName: String, enabled: Boolean)

Enable or disable an action installed with gtk_widget_class_install_action().

activate

open fun activate(): Boolean

For widgets that can be “activated” (buttons, menu items, etc.), this function activates them.

activateAction

open fun activateAction(name: String, args: <Error class: unknown class>? = null): Boolean

Looks up the action in the action groups associated with

activateDefault

open fun activateDefault()

Activates the default.activate action from @widget.

addController

open fun addController(controller: EventController)

Adds @controller to @widget so that it will receive events.

addCssClass

open fun addCssClass(cssClass: String)

Adds a style class to @widget.

addMnemonicLabel

open fun addMnemonicLabel(label: Widget)

Adds a widget to the list of mnemonic labels for this widget.

addTickCallback

open fun addTickCallback(callback: TickCallback): <Error class: unknown class>

Queues an animation frame update and adds a callback to be called before each frame.

allocate

open fun allocate(width: Int, height: Int, baseline: Int, transform: <Error class: unknown class>? = null)

This function is only used by GtkWidget subclasses, to assign a size, position and (optionally) baseline to their child widgets.

announce

open fun announce(message: String, priority: AccessibleAnnouncementPriority)

Requests the user's screen reader to announce the given message.

appendColumn

open fun appendColumn(column: TreeViewColumn): Int

Appends @column to the list of columns. If @tree_view has “fixed_height” mode enabled, then @column must have its “sizing” property set to be GTK_TREE_VIEW_COLUMN_FIXED.

childFocus

open fun childFocus(direction: DirectionType): Boolean

Called by widgets as the user moves around the window using keyboard shortcuts.

collapseAll

open fun collapseAll()

Recursively collapses all visible, expanded nodes in @tree_view.

collapseRow

open fun collapseRow(path: TreePath): Boolean

Collapses a row (hides its child rows, if they exist).

columnsAutosize

open fun columnsAutosize()

Resizes all columns to their optimal width. Only works after the treeview has been realized.

computeBounds

open fun computeBounds(target: Widget, outBounds: <Error class: unknown class>): Boolean

Computes the bounds for @widget in the coordinate space of @target.

computeExpand

open fun computeExpand(orientation: Orientation): Boolean

Computes whether a container should give this widget extra space when possible.

computePoint

open fun computePoint(target: Widget, point: <Error class: unknown class>, outPoint: <Error class: unknown class>): Boolean

Translates the given @point in @widget's coordinates to coordinates relative to @target’s coordinate system.

computeTransform

open fun computeTransform(target: Widget, outTransform: <Error class: unknown class>): Boolean

Computes a matrix suitable to describe a transformation from

connectColumnsChanged

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

The number of columns of the treeview has changed.

connectCursorChanged

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

The position of the cursor (focused cell) has changed.

connectDestroy

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

Signals that all holders of a reference to the widget should release the reference that they hold.

connectDirectionChanged

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

Emitted when the text direction of a widget changes.

connectExpandCollapseCursorRow

fun connectExpandCollapseCursorRow(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (object: Boolean, p0: Boolean, p1: Boolean) -> Boolean): <Error class: unknown class>

connectHide

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

Emitted when @widget is hidden.

connectKeynavFailed

fun connectKeynavFailed(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (direction: DirectionType) -> Boolean): <Error class: unknown class>

Emitted if keyboard navigation fails.

connectMap

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

Emitted when @widget is going to be mapped.

connectMnemonicActivate

fun connectMnemonicActivate(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (groupCycling: Boolean) -> Boolean): <Error class: unknown class>

Emitted when a widget is activated via a mnemonic.

connectMoveCursor

fun connectMoveCursor(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (step: MovementStep, direction: Int, extend: Boolean, modify: Boolean) -> Boolean): <Error class: unknown class>

The GtkTreeView::move-cursor signal is a class@Gtk.SignalAction which gets emitted when the user presses one of the cursor keys.

connectMoveFocus

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

Emitted when the focus is moved.

connectQueryTooltip

fun connectQueryTooltip(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (x: Int, y: Int, keyboardMode: Boolean, tooltip: Tooltip) -> Boolean): <Error class: unknown class>

Emitted when the widget’s tooltip is about to be shown.

connectRealize

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

Emitted when @widget is associated with a GdkSurface.

connectRowActivated

fun connectRowActivated(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (path: TreePath, column: TreeViewColumn?) -> Unit): <Error class: unknown class>

The "row-activated" signal is emitted when the method method@Gtk.TreeView.row_activated is called.

connectRowCollapsed

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

The given row has been collapsed (child nodes are hidden).

connectRowExpanded

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

The given row has been expanded (child nodes are shown).

connectSelectAll

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

connectSelectCursorParent

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

connectSelectCursorRow

fun connectSelectCursorRow(connectFlags: <Error class: unknown class> = ConnectFlags(0u), handler: (object: Boolean) -> Boolean): <Error class: unknown class>

connectShow

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

Emitted when @widget is shown.

connectStartInteractiveSearch

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

connectStateFlagsChanged

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

Emitted when the widget state changes.

connectTestCollapseRow

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

The given row is about to be collapsed (hide its children nodes). Use this signal if you need to control the collapsibility of individual rows.

connectTestExpandRow

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

The given row is about to be expanded (show its children nodes). Use this signal if you need to control the expandability of individual rows.

connectToggleCursorRow

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

connectUnmap

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

Emitted when @widget is going to be unmapped.

connectUnrealize

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

Emitted when the GdkSurface associated with @widget is destroyed.

connectUnselectAll

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

contains

open fun contains(x: Double, y: Double): Boolean

Tests if the point at (@x, @y) is contained in @widget.

createPangoLayout

open fun createPangoLayout(text: String? = null): <Error class: unknown class>

Creates a new PangoLayout with the appropriate font map, font description, and base direction for drawing text for this widget.

createRowDragIcon

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

Creates a cairo_surface_t representation of the row at @path. This image is used for a drag icon.

disposeTemplate

open fun disposeTemplate(widgetType: <Error class: unknown class>)

Clears the template children for the given widget.

dragCheckThreshold

open fun dragCheckThreshold(startX: Int, startY: Int, currentX: Int, currentY: Int): Boolean

Checks to see if a drag movement has passed the GTK drag threshold.

enableModelDragDest

open fun enableModelDragDest(formats: <Error class: unknown class>, actions: <Error class: unknown class>)

Turns @tree_view into a drop destination for automatic DND. Calling this method sets GtkTreeView:reorderable to false.

enableModelDragSource

open fun enableModelDragSource(startButtonMask: <Error class: unknown class>, formats: <Error class: unknown class>, actions: <Error class: unknown class>)

Turns @tree_view into a drag source for automatic DND. Calling this method sets GtkTreeView:reorderable to false.

errorBell

open fun errorBell()

Notifies the user about an input-related error on this widget.

expandAll

open fun expandAll()

Recursively expands all nodes in the @tree_view.

expandRow

open fun expandRow(path: TreePath, openAll: Boolean): Boolean

Opens the row so its children are visible.

expandToPath

open fun expandToPath(path: TreePath)

Expands the row at @path. This will also expand all parent rows of

getAccessibleParent

open fun getAccessibleParent(): Accessible?

Retrieves the accessible parent for an accessible object.

getAccessibleRole

open fun getAccessibleRole(): AccessibleRole

Retrieves the accessible role of an accessible object.

getActivateOnSingleClick

open fun getActivateOnSingleClick(): Boolean

Gets the setting set by gtk_tree_view_set_activate_on_single_click().

getAllocatedBaseline

open fun getAllocatedBaseline(): Int

Returns the baseline that has currently been allocated to @widget.

getAllocatedHeight

open fun getAllocatedHeight(): Int

Returns the height that has currently been allocated to @widget.

getAllocatedWidth

open fun getAllocatedWidth(): Int

Returns the width that has currently been allocated to @widget.

getAncestor

open fun getAncestor(widgetType: <Error class: unknown class>): Widget?

Gets the first ancestor of @widget with type @widget_type.

getAtContext

open fun getAtContext(): ATContext

Retrieves the accessible implementation for the given GtkAccessible.

getBackgroundArea

open fun getBackgroundArea(path: TreePath? = null, column: TreeViewColumn? = null, rect: <Error class: unknown class>)

Fills the bounding rectangle in bin_window coordinates for the cell at the row specified by @path and the column specified by @column. If @path is null, or points to a node not found in the tree, the @y and @height fields of the rectangle will be filled with 0. If @column is null, the @x and @width fields will be filled with 0. The returned rectangle is equivalent to the

getBaseline

open fun getBaseline(): Int

Returns the baseline that has currently been allocated to @widget.

getBorder

open fun getBorder(border: Border): Boolean

Returns the size of a non-scrolling border around the outside of the scrollable.

getBuildableId

open fun getBuildableId(): String?

Gets the ID of the @buildable object.

getCanFocus

open fun getCanFocus(): Boolean

Determines whether the input focus can enter @widget or any of its children.

getCanTarget

open fun getCanTarget(): Boolean

Queries whether @widget can be the target of pointer events.

getCellArea

open fun getCellArea(path: TreePath? = null, column: TreeViewColumn? = null, rect: <Error class: unknown class>)

Fills the bounding rectangle in bin_window coordinates for the cell at the row specified by @path and the column specified by @column. If @path is null, or points to a path not currently displayed, the @y and @height fields of the rectangle will be filled with 0. If @column is null, the @x and @width fields will be filled with 0. The sum of all cell rects does not cover the entire tree; there are extra pixels in between rows, for example. The returned rectangle is equivalent to the @cell_area passed to gtk_cell_renderer_render(). This function is only valid if @tree_view is realized.

getChildVisible

open fun getChildVisible(): Boolean

Gets the value set with gtk_widget_set_child_visible().

getClipboard

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

Gets the clipboard object for @widget.

getColor

open fun getColor(color: <Error class: unknown class>)

Gets the current foreground color for the widget’s CSS style.

getColumn

open fun getColumn(n: Int): TreeViewColumn?

Gets the GtkTreeViewColumn at the given position in the #tree_view.

getColumns

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

Returns a GList of all the GtkTreeViewColumns currently in @tree_view. The returned list must be freed with g_list_free ().

getCssClasses

open fun getCssClasses(): List<String>

Returns the list of style classes applied to @widget.

getCssName

open fun getCssName(): String

Returns the CSS name that is used for @self.

getCursor

open fun getCursor(): <Error class: unknown class>?

Queries the cursor set on @widget.

getDirection

open fun getDirection(): TextDirection

Gets the reading direction for a particular widget.

getDisplay

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

Get the GdkDisplay for the toplevel window associated with this widget.

getEnableSearch

open fun getEnableSearch(): Boolean

Returns whether or not the tree allows to start interactive searching by typing in text.

getEnableTreeLines

open fun getEnableTreeLines(): Boolean

Returns whether or not tree lines are drawn in @tree_view.

getExpanderColumn

open fun getExpanderColumn(): TreeViewColumn?

Returns the column that is the current expander column, or null if none has been set. This column has the expander arrow drawn next to it.

getFirstAccessibleChild

open fun getFirstAccessibleChild(): Accessible?

Retrieves the first accessible child of an accessible object.

getFirstChild

open fun getFirstChild(): Widget?

Returns the widget’s first child.

getFixedHeightMode

open fun getFixedHeightMode(): Boolean

Returns whether fixed height mode is turned on for @tree_view.

getFocusable

open fun getFocusable(): Boolean

Determines whether @widget can own the input focus.

getFocusChild

open fun getFocusChild(): Widget?

Returns the current focus child of @widget.

getFocusOnClick

open fun getFocusOnClick(): Boolean

Returns whether the widget should grab focus when it is clicked with the mouse.

getFontMap

open fun getFontMap(): <Error class: unknown class>?

Gets the font map of @widget.

getFrameClock

open fun getFrameClock(): <Error class: unknown class>?

Obtains the frame clock for a widget.

getGridLines

open fun getGridLines(): TreeViewGridLines

Returns which grid lines are enabled in @tree_view.

getHadjustment

open fun getHadjustment(): Adjustment?

Retrieves the GtkAdjustment used for horizontal scrolling.

getHalign

open fun getHalign(): Align

Gets the horizontal alignment of @widget.

getHasTooltip

open fun getHasTooltip(): Boolean

Returns the current value of the has-tooltip property.

getHeadersClickable

open fun getHeadersClickable(): Boolean

Returns whether all header columns are clickable.

getHeadersVisible

open fun getHeadersVisible(): Boolean

Returns true if the headers on the @tree_view are visible.

getHeight

open fun getHeight(): Int

Returns the content height of the widget.

getHexpand

open fun getHexpand(): Boolean

Gets whether the widget would like any available extra horizontal space.

getHexpandSet

open fun getHexpandSet(): Boolean

Gets whether gtk_widget_set_hexpand() has been used to explicitly set the expand flag on this widget.

getHoverExpand

open fun getHoverExpand(): Boolean

Returns whether hover expansion mode is turned on for @tree_view.

getHoverSelection

open fun getHoverSelection(): Boolean

Returns whether hover selection mode is turned on for @tree_view.

getHscrollPolicy

open fun getHscrollPolicy(): ScrollablePolicy

Gets the horizontal GtkScrollablePolicy.

getLastChild

open fun getLastChild(): Widget?

Returns the widget’s last child.

getLayoutManager

open fun getLayoutManager(): LayoutManager?

Retrieves the layout manager used by @widget.

getLevelIndentation

open fun getLevelIndentation(): Int

Returns the amount, in pixels, of extra indentation for child levels in @tree_view.

getMapped

open fun getMapped(): Boolean

Whether the widget is mapped.

getMarginBottom

open fun getMarginBottom(): Int

Gets the bottom margin of @widget.

getMarginEnd

open fun getMarginEnd(): Int

Gets the end margin of @widget.

getMarginStart

open fun getMarginStart(): Int

Gets the start margin of @widget.

getMarginTop

open fun getMarginTop(): Int

Gets the top margin of @widget.

getModel

open fun getModel(): TreeModel?

Returns the model the GtkTreeView is based on. Returns null if the model is unset.

getName

open fun getName(): String

Retrieves the name of a widget.

getNative

open fun getNative(): Native?

Returns the nearest GtkNative ancestor of @widget.

getNColumns

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

Queries the number of columns in the given @tree_view.

getNextAccessibleSibling

open fun getNextAccessibleSibling(): Accessible?

Retrieves the next accessible sibling of an accessible object

getNextSibling

open fun getNextSibling(): Widget?

Returns the widget’s next sibling.

getOpacity

open fun getOpacity(): Double

#Fetches the requested opacity for this widget.

getOverflow

open fun getOverflow(): Overflow

Returns the widget’s overflow value.

getParent

open fun getParent(): Widget?

Returns the parent widget of @widget.

getPlatformState

open fun getPlatformState(state: AccessiblePlatformState): Boolean

Query a platform state, such as focus.

getPreferredSize

open fun getPreferredSize(minimumSize: Requisition?, naturalSize: Requisition?)

Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management.

getPrevSibling

open fun getPrevSibling(): Widget?

Returns the widget’s previous sibling.

getPrimaryClipboard

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

Gets the primary clipboard of @widget.

getRealized

open fun getRealized(): Boolean

Determines whether @widget is realized.

getReceivesDefault

open fun getReceivesDefault(): Boolean

Determines whether @widget is always treated as the default widget within its toplevel when it has the focus, even if another widget is the default.

getReorderable

open fun getReorderable(): Boolean

Retrieves whether the user can reorder the tree via drag-and-drop. See gtk_tree_view_set_reorderable().

getRequestMode

open fun getRequestMode(): SizeRequestMode

Gets whether the widget prefers a height-for-width layout or a width-for-height layout.

getRoot

open fun getRoot(): Root?

Returns the GtkRoot widget of @widget.

getRubberBanding

open fun getRubberBanding(): Boolean

Returns whether rubber banding is turned on for @tree_view. If the selection mode is %GTK_SELECTION_MULTIPLE, rubber banding will allow the user to select multiple rows by dragging the mouse.

getScaleFactor

open fun getScaleFactor(): Int

Retrieves the internal scale factor that maps from window coordinates to the actual device pixels.

getSearchColumn

open fun getSearchColumn(): Int

Gets the column searched on by the interactive search code.

getSearchEntry

open fun getSearchEntry(): Editable?

Returns the GtkEntry which is currently in use as interactive search entry for @tree_view. In case the built-in entry is being used, null will be returned.

getSelection

open fun getSelection(): TreeSelection

Gets the GtkTreeSelection associated with @tree_view.

getSensitive

open fun getSensitive(): Boolean

Returns the widget’s sensitivity.

getSettings

open fun getSettings(): Settings

Gets the settings object holding the settings used for this widget.

getShowExpanders

open fun getShowExpanders(): Boolean

Returns whether or not expanders are drawn in @tree_view.

getSize

open fun getSize(orientation: Orientation): Int

Returns the content width or height of the widget.

getStateFlags

open fun getStateFlags(): StateFlags

Returns the widget state as a flag set.

getStyleContext

open fun getStyleContext(): StyleContext

Returns the style context associated to @widget.

getTemplateChild

open fun getTemplateChild(widgetType: <Error class: unknown class>, name: String): <Error class: unknown class>

Fetch an object build from the template XML for @widget_type in this @widget instance.

getTooltipColumn

open fun getTooltipColumn(): Int

Returns the column of @tree_view’s model which is being used for displaying tooltips on @tree_view’s rows.

getTooltipMarkup

open fun getTooltipMarkup(): String?

Gets the contents of the tooltip for @widget.

getTooltipText

open fun getTooltipText(): String?

Gets the contents of the tooltip for @widget.

getVadjustment

open fun getVadjustment(): Adjustment?

Retrieves the GtkAdjustment used for vertical scrolling.

getValign

open fun getValign(): Align

Gets the vertical alignment of @widget.

getVexpand

open fun getVexpand(): Boolean

Gets whether the widget would like any available extra vertical space.

getVexpandSet

open fun getVexpandSet(): Boolean

Gets whether gtk_widget_set_vexpand() has been used to explicitly set the expand flag on this widget.

getVisible

open fun getVisible(): Boolean

Determines whether the widget is visible.

getVisibleRect

open fun getVisibleRect(visibleRect: <Error class: unknown class>)

Fills @visible_rect with the currently-visible region of the buffer, in tree coordinates. Convert to bin_window coordinates with gtk_tree_view_convert_tree_to_bin_window_coords(). Tree coordinates start at 0,0 for row 0 of the tree, and cover the entire scrollable area of the tree.

getVscrollPolicy

open fun getVscrollPolicy(): ScrollablePolicy

Gets the vertical GtkScrollablePolicy.

getWidth

open fun getWidth(): Int

Returns the content width of the widget.

grabFocus

open fun grabFocus(): Boolean

Causes @widget to have the keyboard focus for the GtkWindow it's inside.

hasCssClass

open fun hasCssClass(cssClass: String): Boolean

Returns whether @css_class is currently applied to @widget.

hasDefault

open fun hasDefault(): Boolean

Determines whether @widget is the current default widget within its toplevel.

hasFocus

open fun hasFocus(): Boolean

Determines if the widget has the global input focus.

hasVisibleFocus

open fun hasVisibleFocus(): Boolean

Determines if the widget should show a visible indication that it has the global input focus.

hide

open fun hide()

Reverses the effects of gtk_widget_show().

inDestruction

open fun inDestruction(): Boolean

Returns whether the widget is currently being destroyed.

initTemplate

open fun initTemplate()

Creates and initializes child widgets defined in templates.

insertActionGroup

open fun insertActionGroup(name: String, group: <Error class: unknown class>? = null)

Inserts @group into @widget.

insertAfter

open fun insertAfter(parent: Widget, previousSibling: Widget? = null)

Inserts @widget into the child widget list of @parent.

insertBefore

open fun insertBefore(parent: Widget, nextSibling: Widget? = null)

Inserts @widget into the child widget list of @parent.

insertColumn

open fun insertColumn(column: TreeViewColumn, position: Int): Int

This inserts the @column into the @tree_view at @position. If @position is -1, then the column is inserted at the end. If @tree_view has “fixed_height” mode enabled, then @column must have its “sizing” property set to be GTK_TREE_VIEW_COLUMN_FIXED.

insertColumnWithDataFunc

open fun insertColumnWithDataFunc(position: Int, title: String, cell: CellRenderer, func: TreeCellDataFunc): Int

Convenience function that inserts a new column into the GtkTreeView with the given cell renderer and a GtkTreeCellDataFunc to set cell renderer attributes (normally using data from the model). See also gtk_tree_view_column_set_cell_data_func(), gtk_tree_view_column_pack_start(). If @tree_view has “fixed_height” mode enabled, then the new column will have its “sizing” property set to be GTK_TREE_VIEW_COLUMN_FIXED.

isAncestor

open fun isAncestor(ancestor: Widget): Boolean

Determines whether @widget is somewhere inside @ancestor, possibly with intermediate containers.

isDrawable

open fun isDrawable(): Boolean

Determines whether @widget can be drawn to.

isFocus

open fun isFocus(): Boolean

Determines if the widget is the focus widget within its toplevel.

isRubberBandingActive

open fun isRubberBandingActive(): Boolean

Returns whether a rubber banding operation is currently being done in @tree_view.

isSensitive

open fun isSensitive(): Boolean

Returns the widget’s effective sensitivity.

isVisible

open fun isVisible(): Boolean

Determines whether the widget and all its parents are marked as visible.

keynavFailed

open fun keynavFailed(direction: DirectionType): Boolean

Emits the ::keynav-failed signal on the widget.

listMnemonicLabels

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

Returns the widgets for which this widget is the target of a mnemonic.

map

open fun map()

Causes a widget to be mapped if it isn’t already.

mapExpandedRows

open fun mapExpandedRows(func: TreeViewMappingFunc)

Calls @func on all expanded rows.

mnemonicActivate

open fun mnemonicActivate(groupCycling: Boolean): Boolean

Emits the ::mnemonic-activate signal.

moveColumnAfter

open fun moveColumnAfter(column: TreeViewColumn, baseColumn: TreeViewColumn? = null)

Moves @column to be after to @base_column. If @base_column is null, then

observeChildren

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

Returns a GListModel to track the children of @widget.

observeControllers

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

Returns a GListModel to track the class@Gtk.EventControllers of @widget.

pick

open fun pick(x: Double, y: Double, flags: PickFlags): Widget?

Finds the descendant of @widget closest to the point (@x, @y).

queueAllocate

open fun queueAllocate()

Flags the widget for a rerun of the vfunc@Gtk.Widget.size_allocate function.

queueDraw

open fun queueDraw()

Schedules this widget to be redrawn in the paint phase of the current or the next frame.

queueResize

open fun queueResize()

Flags a widget to have its size renegotiated.

realize

open fun realize()

Creates the GDK resources associated with a widget.

removeColumn

open fun removeColumn(column: TreeViewColumn): Int

Removes @column from @tree_view.

removeController

open fun removeController(controller: EventController)

Removes @controller from @widget, so that it doesn't process events anymore.

removeCssClass

open fun removeCssClass(cssClass: String)

Removes a style from @widget.

removeMnemonicLabel

open fun removeMnemonicLabel(label: Widget)

Removes a widget from the list of mnemonic labels for this widget.

removeTickCallback

open fun removeTickCallback(id: <Error class: unknown class>)

Removes a tick callback previously registered with gtk_widget_add_tick_callback().

resetProperty

open fun resetProperty(property: AccessibleProperty)

Resets the accessible @property to its default value.

resetRelation

open fun resetRelation(relation: AccessibleRelation)

Resets the accessible @relation to its default value.

resetState

open fun resetState(state: AccessibleState)

Resets the accessible @state to its default value.

rowActivated

open fun rowActivated(path: TreePath, column: TreeViewColumn? = null)

Activates the cell determined by @path and @column.

rowExpanded

open fun rowExpanded(path: TreePath): Boolean

Returns true if the node pointed to by @path is expanded in @tree_view.

scrollToCell

open fun scrollToCell(path: TreePath? = null, column: TreeViewColumn? = null, useAlign: Boolean, rowAlign: Float, colAlign: Float)

Moves the alignments of @tree_view to the position specified by @column and

scrollToPoint

open fun scrollToPoint(treeX: Int, treeY: Int)

Scrolls the tree view such that the top-left corner of the visible area is @tree_x, @tree_y, where @tree_x and @tree_y are specified in tree coordinates. The @tree_view must be realized before this function is called. If it isn't, you probably want to be using gtk_tree_view_scroll_to_cell().

setAccessibleParent

open fun setAccessibleParent(parent: Accessible? = null, nextSibling: Accessible? = null)

Sets the parent and sibling of an accessible object.

setActivateOnSingleClick

open fun setActivateOnSingleClick(single: Boolean)

Cause the GtkTreeView::row-activated signal to be emitted on a single click instead of a double click.

setCanFocus

open fun setCanFocus(canFocus: Boolean)

Specifies whether the input focus can enter the widget or any of its children.

setCanTarget

open fun setCanTarget(canTarget: Boolean)

Sets whether @widget can be the target of pointer events.

setChildVisible

open fun setChildVisible(childVisible: Boolean)

Sets whether @widget should be mapped along with its parent.

setColumnDragFunction

open fun setColumnDragFunction(func: TreeViewColumnDropFunc)

Sets a user function for determining where a column may be dropped when dragged. This function is called on every column pair in turn at the beginning of a column drag to determine where a drop can take place. The arguments passed to @func are: the @tree_view, the GtkTreeViewColumn being dragged, the two GtkTreeViewColumns determining the drop spot, and

setCssClasses

open fun setCssClasses(classes: List<String>)

Clear all style classes applied to @widget and replace them with @classes.

setCursor

open fun setCursor(cursor: <Error class: unknown class>? = null)

Sets the cursor to be shown when pointer devices point towards @widget.

setCursor_

open fun setCursor_(path: TreePath, focusColumn: TreeViewColumn? = null, startEditing: Boolean)

Sets the current keyboard focus to be at @path, and selects it. This is useful when you want to focus the user’s attention on a particular row. If

setCursorFromName

open fun setCursorFromName(name: String? = null)

Sets a named cursor to be shown when pointer devices point towards @widget.

setCursorOnCell

open fun setCursorOnCell(path: TreePath, focusColumn: TreeViewColumn? = null, focusCell: CellRenderer? = null, startEditing: Boolean)

Sets the current keyboard focus to be at @path, and selects it. This is useful when you want to focus the user’s attention on a particular row. If

setDirection

open fun setDirection(dir: TextDirection)

Sets the reading direction on a particular widget.

setDragDestRow

open fun setDragDestRow(path: TreePath? = null, pos: TreeViewDropPosition)

Sets the row that is highlighted for feedback. If @path is null, an existing highlight is removed.

setEnableSearch

open fun setEnableSearch(enableSearch: Boolean)

If @enable_search is set, then the user can type in text to search through the tree interactively (this is sometimes called "typeahead find").

setEnableTreeLines

open fun setEnableTreeLines(enabled: Boolean)

Sets whether to draw lines interconnecting the expanders in @tree_view. This does not have any visible effects for lists.

setExpanderColumn

open fun setExpanderColumn(column: TreeViewColumn? = null)

Sets the column to draw the expander arrow at. It must be in @tree_view. If @column is null, then the expander arrow is always at the first visible column.

setFixedHeightMode

open fun setFixedHeightMode(enable: Boolean)

Enables or disables the fixed height mode of @tree_view. Fixed height mode speeds up GtkTreeView by assuming that all rows have the same height. Only enable this option if all rows are the same height and all columns are of type %GTK_TREE_VIEW_COLUMN_FIXED.

setFocusable

open fun setFocusable(focusable: Boolean)

Specifies whether @widget can own the input focus.

setFocusChild

open fun setFocusChild(child: Widget? = null)

Set @child as the current focus child of @widget.

setFocusOnClick

open fun setFocusOnClick(focusOnClick: Boolean)

Sets whether the widget should grab focus when it is clicked with the mouse.

setFontMap

open fun setFontMap(fontMap: <Error class: unknown class>? = null)

Sets the font map to use for Pango rendering.

setGridLines

open fun setGridLines(gridLines: TreeViewGridLines)

Sets which grid lines to draw in @tree_view.

setHadjustment

open fun setHadjustment(hadjustment: Adjustment? = null)

Sets the horizontal adjustment of the GtkScrollable.

setHalign

open fun setHalign(align: Align)

Sets the horizontal alignment of @widget.

setHasTooltip

open fun setHasTooltip(hasTooltip: Boolean)

Sets the has-tooltip property on @widget to @has_tooltip.

setHeadersClickable

open fun setHeadersClickable(setting: Boolean)

Allow the column title buttons to be clicked.

setHeadersVisible

open fun setHeadersVisible(headersVisible: Boolean)

Sets the visibility state of the headers.

setHexpand

open fun setHexpand(expand: Boolean)

Sets whether the widget would like any available extra horizontal space.

setHexpandSet

open fun setHexpandSet(set: Boolean)

Sets whether the hexpand flag will be used.

setHoverExpand

open fun setHoverExpand(expand: Boolean)

Enables or disables the hover expansion mode of @tree_view. Hover expansion makes rows expand or collapse if the pointer moves over them.

setHoverSelection

open fun setHoverSelection(hover: Boolean)

setHscrollPolicy

open fun setHscrollPolicy(policy: ScrollablePolicy)

Sets the GtkScrollablePolicy.

setLayoutManager

open fun setLayoutManager(layoutManager: LayoutManager? = null)

Sets the layout manager delegate instance that provides an implementation for measuring and allocating the children of @widget.

setLevelIndentation

open fun setLevelIndentation(indentation: Int)

Sets the amount of extra indentation for child levels to use in @tree_view in addition to the default indentation. The value should be specified in pixels, a value of 0 disables this feature and in this case only the default indentation will be used. This does not have any visible effects for lists.

setMarginBottom

open fun setMarginBottom(margin: Int)

Sets the bottom margin of @widget.

setMarginEnd

open fun setMarginEnd(margin: Int)

Sets the end margin of @widget.

setMargins

fun Widget.setMargins(all: Int)

Set all margins to the same value.

fun Widget.setMargins(horizontal: Int = 0, vertical: Int = 0)

Set start and end margin to horizontal and top and bottom margin to vertical

fun Widget.setMargins(start: Int = 0, top: Int = 0, end: Int = 0, bottom: Int = 0)

Set margins.

setMarginStart

open fun setMarginStart(margin: Int)

Sets the start margin of @widget.

setMarginTop

open fun setMarginTop(margin: Int)

Sets the top margin of @widget.

setModel

open fun setModel(model: TreeModel? = null)

Sets the model for a GtkTreeView. If the @tree_view already has a model set, it will remove it before setting the new model. If @model is null, then it will unset the old model.

setName

open fun setName(name: String)

Sets a widgets name.

setOpacity

open fun setOpacity(opacity: Double)

Request the @widget to be rendered partially transparent.

setOverflow

open fun setOverflow(overflow: Overflow)

Sets how @widget treats content that is drawn outside the widget's content area.

setParent

open fun setParent(parent: Widget)

Sets @parent as the parent widget of @widget.

setReceivesDefault

open fun setReceivesDefault(receivesDefault: Boolean)

Specifies whether @widget will be treated as the default widget within its toplevel when it has the focus, even if another widget is the default.

setReorderable

open fun setReorderable(reorderable: Boolean)

This function is a convenience function to allow you to reorder models that support the GtkTreeDragSourceIface and the GtkTreeDragDestIface. Both GtkTreeStore and GtkListStore support these. If @reorderable is true, then the user can reorder the model by dragging and dropping rows. The developer can listen to these changes by connecting to the model’s GtkTreeModel::row-inserted and GtkTreeModel::row-deleted signals. The reordering is implemented by setting up the tree view as a drag source and destination. Therefore, drag and drop can not be used in a reorderable view for any other purpose.

setRowSeparatorFunc

open fun setRowSeparatorFunc(func: TreeViewRowSeparatorFunc)

Sets the row separator function, which is used to determine whether a row should be drawn as a separator. If the row separator function is null, no separators are drawn. This is the default value.

setRubberBanding

open fun setRubberBanding(enable: Boolean)

Enables or disables rubber banding in @tree_view. If the selection mode is %GTK_SELECTION_MULTIPLE, rubber banding will allow the user to select multiple rows by dragging the mouse.

setSearchColumn

open fun setSearchColumn(column: Int)

Sets @column as the column where the interactive search code should search in for the current model.

setSearchEntry

open fun setSearchEntry(entry: Editable? = null)

Sets the entry which the interactive search code will use for this

setSearchEqualFunc

open fun setSearchEqualFunc(searchEqualFunc: TreeViewSearchEqualFunc)

Sets the compare function for the interactive search capabilities; note that somewhat like strcmp() returning 0 for equality GtkTreeViewSearchEqualFunc returns false on matches.

setSensitive

open fun setSensitive(sensitive: Boolean)

Sets the sensitivity of a widget.

setShowExpanders

open fun setShowExpanders(enabled: Boolean)

Sets whether to draw and enable expanders and indent child rows in

setSizeRequest

open fun setSizeRequest(width: Int, height: Int)

Sets the minimum size of a widget.

setStateFlags

open fun setStateFlags(flags: StateFlags, clear: Boolean)

Turns on flag values in the current widget state.

setTooltipCell

open fun setTooltipCell(tooltip: Tooltip, path: TreePath? = null, column: TreeViewColumn? = null, cell: CellRenderer? = null)

Sets the tip area of @tooltip to the area @path, @column and @cell have in common. For example if @path is null and @column is set, the tip area will be set to the full area covered by @column. See also gtk_tooltip_set_tip_area().

setTooltipColumn

open fun setTooltipColumn(column: Int)

If you only plan to have simple (text-only) tooltips on full rows, you can use this function to have GtkTreeView handle these automatically for you. @column should be set to the column in @tree_view’s model containing the tooltip texts, or -1 to disable this feature.

setTooltipMarkup

open fun setTooltipMarkup(markup: String? = null)

Sets @markup as the contents of the tooltip, which is marked up with Pango markup.

setTooltipRow

open fun setTooltipRow(tooltip: Tooltip, path: TreePath)

Sets the tip area of @tooltip to be the area covered by the row at @path. See also gtk_tree_view_set_tooltip_column() for a simpler alternative. See also gtk_tooltip_set_tip_area().

setTooltipText