Skip to main content

Type Alias: GtkTreeViewProps

GtkTreeViewProps = WidgetProps & object

Defined in: generated/jsx.ts:10858

Props for the GtkTreeView widget.

Type Declaration

NameTypeDescriptionDefined in
activateOnSingleClick?booleanThe activate-on-single-click property specifies whether the "row-activated" signal will be emitted after a single click.generated/jsx.ts:10863
enableGridLines?Gtk.TreeViewGridLines-generated/jsx.ts:10864
enableSearch?boolean-generated/jsx.ts:10865
enableTreeLines?boolean-generated/jsx.ts:10866
expanderColumn?Gtk.TreeViewColumn | null-generated/jsx.ts:10867
fixedHeightMode?booleanSetting 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.generated/jsx.ts:10875
hadjustment?Gtk.AdjustmentHorizontal GtkAdjustment of the scrollable widget. This adjustment is shared between the scrollable widget and its parent.generated/jsx.ts:10911
headersClickable?boolean-generated/jsx.ts:10876
headersVisible?boolean-generated/jsx.ts:10877
hoverExpand?booleanEnables or disables the hover expansion mode of tree_view. Hover expansion makes rows expand or collapse if the pointer moves over them. This mode is primarily intended for treeviews in popups, e.g. in GtkComboBox or GtkEntryCompletion.generated/jsx.ts:10886
hoverSelection?booleanEnables 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. This mode is primarily intended for treeviews in popups, e.g. in GtkComboBox or GtkEntryCompletion.generated/jsx.ts:10896
hscrollPolicy?Gtk.ScrollablePolicyDetermines when horizontal scrolling should start.generated/jsx.ts:10913
levelIndentation?numberExtra indentation for each level.generated/jsx.ts:10898
model?Gtk.TreeModel | null-generated/jsx.ts:10899
onColumnsChanged()?(self) => void | nullThe number of columns of the treeview has changed.generated/jsx.ts:10923
onCursorChanged()?(self) => void | nullThe position of the cursor (focused cell) has changed.generated/jsx.ts:10925
onExpandCollapseCursorRow()?(self, object, p0, p1) => boolean | null-generated/jsx.ts:10926
onMoveCursor()?(self, step, direction, extend, modify) => boolean | nullThe GtkTreeView::move-cursor signal is a [keybinding signal]SignalAction which gets emitted when the user presses one of the cursor keys. Applications should not connect to it, but may emit it with g_signal_emit_by_name() if they need to control the cursor programmatically. In contrast to gtk_tree_view_set_cursor() and gtk_tree_view_set_cursor_on_cell() when moving horizontally GtkTreeView::move-cursor does not reset the current selection.generated/jsx.ts:10938
onNotify?(self, propName) => void | nullCalled when any property on this widget changes. Param The widget that emitted the notification Param The name of the property that changed (in kebab-case)generated/jsx.ts:10987
onRowActivated()?(self, path, column) => void | nullThe "row-activated" signal is emitted when the method TreeView.row_activated is called. This signal is emitted when the user double-clicks a treeview row with the TreeView.activate-on-single-click property set to %FALSE, or when the user single-clicks a row when that property set to %TRUE. This signal is also emitted when a non-editable row is selected and one of the keys: Space, Shift+Space, Return or Enter is pressed. For selection handling refer to the tree widget conceptual overview as well as GtkTreeSelection.generated/jsx.ts:10961
onRowCollapsed()?(self, iter, path) => void | nullThe given row has been collapsed (child nodes are hidden).generated/jsx.ts:10963
onRowExpanded()?(self, iter, path) => void | nullThe given row has been expanded (child nodes are shown).generated/jsx.ts:10965
onSelectAll()?(self) => boolean | null-generated/jsx.ts:10966
onSelectCursorParent()?(self) => boolean | null-generated/jsx.ts:10967
onSelectCursorRow()?(self, object) => boolean | null-generated/jsx.ts:10968
onStartInteractiveSearch()?(self) => boolean | null-generated/jsx.ts:10969
onTestCollapseRow()?(self, iter, path) => boolean | nullThe given row is about to be collapsed (hide its children nodes). Use this signal if you need to control the collapsibility of individual rows.generated/jsx.ts:10974
onTestExpandRow()?(self, iter, path) => boolean | nullThe given row is about to be expanded (show its children nodes). Use this signal if you need to control the expandability of individual rows.generated/jsx.ts:10979
onToggleCursorRow()?(self) => boolean | null-generated/jsx.ts:10980
onUnselectAll()?(self) => boolean | null-generated/jsx.ts:10981
ref?Ref<Gtk.TreeView>-generated/jsx.ts:11014
reorderable?boolean-generated/jsx.ts:10900
rubberBanding?boolean-generated/jsx.ts:10901
searchColumn?number-generated/jsx.ts:10902
showExpanders?boolean%TRUE if the view has expanders.generated/jsx.ts:10904
tooltipColumn?number-generated/jsx.ts:10905
vadjustment?Gtk.AdjustmentVertical GtkAdjustment of the scrollable widget. This adjustment is shared between the scrollable widget and its parent.generated/jsx.ts:10919
vscrollPolicy?Gtk.ScrollablePolicyDetermines when vertical scrolling should start.generated/jsx.ts:10921