gtk4/org.gtkkn.bindings.gtk/TreeViewColumn

TreeViewColumn

open class TreeViewColumn(pointer: <Error class: unknown class><<Error class: unknown class>>) : Buildable, CellLayout

A visible column in a class@Gtk.TreeView widget

The GtkTreeViewColumn object represents a visible column in a GtkTreeView widget. It allows to set properties of the column header, and functions as a holding pen for the cell renderers which determine how the data in the column is displayed.

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, and to the class@Gtk.TreeView documentation for specifics about the CSS node structure for treeviews and their headers.

Skipped during bindings generation

parameter x_offset: x_offset: Out parameter is not supported
parameter x_offset: x_offset: Out parameter is not supported
method set_attributes: Varargs parameter is not supported
method cell-area: Property has no getter nor setter
constructor new_with_attributes: Varargs parameter is not supported

Constructors

TreeViewColumn

constructor()

Creates a new GtkTreeViewColumn.

constructor(area: CellArea)

Creates a new GtkTreeViewColumn using @area to render its cells.

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

Types

Companion

object Companion

Properties

alignment

open var alignment: <Error class: unknown class>

clickable

open var clickable: Boolean

expand

open var expand: Boolean

fixedWidth

open var fixedWidth: <Error class: unknown class>

gtkBuildablePointer

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

gtkCellLayoutPointer

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

gtkTreeViewColumnPointer

val gtkTreeViewColumnPointer: <Error class: unknown class><<Error class: unknown class>>

maxWidth

open var maxWidth: <Error class: unknown class>

minWidth

open var minWidth: <Error class: unknown class>

reorderable

open var reorderable: Boolean

resizable

open var resizable: Boolean

sizing

open var sizing: TreeViewColumnSizing

sortColumnId

open var sortColumnId: <Error class: unknown class>

Logical sort column ID this column sorts on when selected for sorting. Setting the sort column ID makes the column header clickable. Set to -1 to make the column unsortable.

sortIndicator

open var sortIndicator: Boolean

sortOrder

open var sortOrder: SortType

spacing

open var spacing: <Error class: unknown class>

title

open var title: String

visible

open var visible: Boolean

widget

open var widget: Widget?

width

open val width: <Error class: unknown class>

xOffset

open val xOffset: <Error class: unknown class>

Functions

addAttribute

open override fun addAttribute(cell: CellRenderer, attribute: String, column: <Error class: unknown class>)

Adds an attribute mapping to the list in @tree_column.

cellIsVisible

open fun cellIsVisible(): Boolean

Returns true if any of the cells packed into the @tree_column are visible. For this to be meaningful, you must first initialize the cells with gtk_tree_view_column_cell_set_cell_data()

cellSetCellData

open fun cellSetCellData(treeModel: TreeModel, iter: TreeIter, isExpander: Boolean, isExpanded: Boolean)

Sets the cell renderer based on the @tree_model and @iter. That is, for every attribute mapping in @tree_column, it will get a value from the set column on the @iter, and use that value to set the attribute on the cell renderer. This is used primarily by the GtkTreeView.

clear

open override fun clear()

Unsets all the mappings on all renderers on the @tree_column.

clearAttributes

open override fun clearAttributes(cell: CellRenderer)

Clears all existing attributes previously set with gtk_tree_view_column_set_attributes().

clicked

open fun clicked()

Emits the “clicked” signal on the column. This function will only work if

connectClicked

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

Emitted when the column's header has been clicked.

focusCell

open fun focusCell(cell: CellRenderer)

Sets the current keyboard focus to be at @cell, if the column contains 2 or more editable and activatable cells.

getArea

open fun getArea(): CellArea?

Returns the underlying GtkCellArea which might be @cell_layout if called on a GtkCellArea or might be null if no GtkCellArea is used by @cell_layout.

getBuildableId

open fun getBuildableId(): String?

Gets the ID of the @buildable object.

getButton

open fun getButton(): Widget

Returns the button used in the treeview column header

getCells

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

Returns the cell renderers which have been added to @cell_layout.

getTreeView

open fun getTreeView(): Widget?

Returns the GtkTreeView wherein @tree_column has been inserted. If @column is currently not inserted in any tree view, null is returned.

packEnd

open override fun packEnd(cell: CellRenderer, expand: Boolean)

Adds the @cell to end of the column. If @expand is false, then the @cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which @expand is true.

packStart

open override fun packStart(cell: CellRenderer, expand: Boolean)

Packs the @cell into the beginning of the column. If @expand is false, then the @cell is allocated no more space than it needs. Any unused space is divided evenly between cells for which @expand is true.

queueResize

open fun queueResize()

Flags the column, and the cell renderers added to this column, to have their sizes renegotiated.

reorder

open fun reorder(cell: CellRenderer, position: <Error class: unknown class>)

Re-inserts @cell at @position.

setCellDataFunc

open fun setCellDataFunc(cell: CellRenderer, func: CellLayoutDataFunc?)

Sets the GtkCellLayoutDataFunc to use for @cell_layout.

open fun setCellDataFunc(cellRenderer: CellRenderer, func: TreeCellDataFunc?)

Sets the GtkTreeCellDataFunc to use for the column.