Tree

public Tree();

Creates an empty Tree with one column and no root. Create the root through CreateItem.

public bool AllowReselect { get; set; }

Allows repeat notification when the selection path chooses an already selected cell/row. Does not enable Multi or make programmatic TreeItem.Select emit signals in Multi.

public bool AllowRmbSelect { get; set; }

Allows right-mouse selection of a row. This is an input policy: it does not open a context menu, change SelectMode or restrict programmatic selection.

public bool AllowSearch { get; set; }

Allows keyboard prefix search against original labels, ignoring case. Navigates rows rather than filtering data or creating a search box. In Multi, search moves only the cursor without adding to selection. gui/timers/incremental_search_max_interval_msec controls the typing interval.

public bool AutoTooltip { get; set; }

Use the cell label/value as a tooltip when no explicit tooltip is set. Does not generate an accessibility description or replace action-button tooltips. Set false to disable this fallback; clearing the row’s explicit tooltip alone is insufficient.

public bool ColumnTitlesVisible { get; set; }

Shows column headers, default false. Prefer setting this before populating or measuring columns. Limitation: showing headers dynamically after GetColumnWidth can retain stale cached widths. To recompute, retain each column’s IsColumnClippingContent, set SetColumnClipContent to the opposite value, then restore it.

public int Columns { get; set; }

Column count, at least 1; default 1. Set before populating. Reducing it discards trailing cell data throughout the tree. Changes are blocked during mouse selection processing.

public int DropModeFlags { get; set; }

Drop-target zones: 0 disables them, OnItem (1) targets a row, Inbetween (2) targets between rows, and 3 enables both. Controls target calculation/highlighting rather than data transfer. Implement validation and model changes in drag-and-drop handlers; account for SetAcceptChildren and prevent cycles.

public bool EnableDragUnfolding { get; set; }

Allows a branch to unfold after a dragged item hovers over it. Does not create drag data or transfer the model. Disabling stops a pending unfolding timer.

public bool EnableRecursiveFolding { get; set; }

Allows recursive folding/unfolding through the user Shift gesture. Does not block SetCollapsedRecursive from code.

public bool HideFolding { get; set; }

Hides normal folding controls throughout Tree. Does not expand branches or block programmatic Collapsed/SetCollapsedRecursive. Configure branch states separately.

public bool HideRoot { get; set; }

Hides the root’s presentation while retaining the root and its children. Useful for a flat list with a shared hidden parent. Does not delete a row or change GetRoot.

public Tree.ScrollHintModeEnum ScrollHintMode { get; set; }

Configures visual hints for content hidden above/below: Disabled, Both, Top or Bottom. Does not enable scrolling or change its amount.

public bool ScrollHorizontalEnabled { get; set; }

Enables horizontal scrolling. With false, Tree’s minimum width includes content, so a container can expand the control. Does not fix column widths or control vertical scrolling.

public bool ScrollVerticalEnabled { get; set; }

Enables vertical scrolling. With false, Tree’s minimum height includes content, so a container can expand the control. Configure horizontal scrolling separately.

public Tree.SelectModeEnum SelectMode { get; set; }

Single selects one cell, Row selects the selectable cells of one row, and Multi allows accumulated selection. Changing modes neither clears nor normalizes existing flags: call DeselectAll before switching. In Multi, the GetSelected cursor is not the full selection.

public bool TileScrollHint { get; set; }

Tile the scroll-hint texture rather than stretching it. This styles the hint rather than enabling cyclic list scrolling.

public bool AreColumnTitlesVisible();

Shows column headers, default false. Prefer setting this before populating or measuring columns. Limitation: showing headers dynamically after GetColumnWidth can retain stale cached widths. To recompute, retain each column’s IsColumnClippingContent, set SetColumnClipContent to the opposite value, then restore it.

public void Clear();

Immediately deletes the root and all attached rows and resets selected and edited items. Old references become invalid. Previously detached subtrees are not deleted. Blocked during mouse selection processing.

public TreeItem CreateItem(TreeItem parent = null, int index = -1);

Without parent, the first call creates the root and later calls create its children. With parent, creates a child of that row in this Tree. index < 0 appends; an existing child index inserts before it. Cannot run during mouse selection processing.

public void DeselectAll();

Clears selection throughout the tree and resets the cursor: GetSelected is null and GetSelectedColumn is -1. Emits no CellSelected, ItemSelected or MultiSelected. Explicitly update the model if it must react to a programmatic reset.

public bool EditSelected();

Starts the editing action for the GetSelected/GetSelectedColumn cursor cell. First check that a row exists and belongs to Tree. Editable is required without forceEdit. Check immediately toggles checked and emits ItemEdited; Custom requests an application editor and also emits ItemEdited before the application changes the value. String/Range can open a built-in editor; Icon has no editor. true means a handled action/editor start rather than a guaranteed value commit. The no-argument overload uses false.

public bool EditSelected(bool forceEdit = false);

Starts the editing action for the GetSelected/GetSelectedColumn cursor cell. First check that a row exists and belongs to Tree. Editable is required without forceEdit. Check immediately toggles checked and emits ItemEdited; Custom requests an application editor and also emits ItemEdited before the application changes the value. String/Range can open a built-in editor; Icon has no editor. true means a handled action/editor start rather than a guaranteed value commit. The no-argument overload uses false.

public void EnsureCursorIsVisible();

Scrolls to the current cursor cell. Does nothing without a cursor and does not collect or reveal the entire Multi selection. Part of the update can be deferred to the next frame. Does not expand ancestors or enable Visible.

public bool GetAllowReselect();

Allows repeat notification when the selection path chooses an already selected cell/row. Does not enable Multi or make programmatic TreeItem.Select emit signals in Multi.

public bool GetAllowRmbSelect();

Allows right-mouse selection of a row. This is an input policy: it does not open a context menu, change SelectMode or restrict programmatic selection.

public bool GetAllowSearch();

Allows keyboard prefix search against original labels, ignoring case. Navigates rows rather than filtering data or creating a search box. In Multi, search moves only the cursor without adding to selection. gui/timers/incremental_search_max_interval_msec controls the typing interval.

public int GetButtonIdAtPosition(Vector2 position);

Button ID at a Tree-local position, or -1 when there is no hit. Coordinates are neither screen-space nor TreeItem-local. Returns an ID rather than an index and depends on the current row layout.

public int GetColumnAtPosition(Vector2 position);

Column index under a row at a Tree-local position; -1 when no matching row exists. Searches content rather than serving as a universal header hit-test.

public int GetColumnExpandRatio(int column);

Stored integer expansion weight rather than a width percentage or the ratio of final column sizes.

public string GetColumnTitle(int column);

Original column-title string rather than its automatically translated presentation.

public HorizontalAlignment GetColumnTitleAlignment(int column);

Stored header alignment, default Center. Data-row cell settings are independent.

public Control.TextDirection GetColumnTitleDirection(int column);

Stored header text direction. Inherited means inheritance from Tree rather than an already resolved direction.

public string GetColumnTitleLanguage(int column);

Stored header shaping-language hint rather than the current application locale.

public string GetColumnTitleTooltipText(int column);

Stored explicit header tooltip; an empty string does not imply that every Control tooltip is disabled.

public int GetColumnWidth(int column);

Current computed column width: its minimum plus a share of spare space when Expand is enabled. Depends on Tree size, theme, visible rows and title; need not equal CustomMinimumWidth. Query after configuring size and content.

public int GetColumns();

Column count, at least 1; default 1. Set before populating. Reducing it discards trailing cell data throughout the tree. Changes are blocked during mouse selection processing.

public Rid GetCustomDrawingCanvasItem();

Returns the Tree-owned RID for custom drawing inside a cell callback. Do not free it through RenderingServer or use it after Tree is freed. This is not a separate CanvasItem Entity or permission to draw outside the drawing cycle.

public Rect2 GetCustomPopupRect();

Last placement area for a Custom application editor, in Tree UI-global coordinates. Not automatically screen coordinates for an external Window; account for CanvasLayer, transforms and window embedding. Read during CustomPopupEdited after current layout, not as persistent row geometry.

public int GetDropModeFlags();

Drop-target zones: 0 disables them, OnItem (1) targets a row, Inbetween (2) targets between rows, and 3 enables both. Controls target calculation/highlighting rather than data transfer. Implement validation and model changes in drag-and-drop handlers; account for SetAcceptChildren and prevent cycles.

public int GetDropSectionAtPosition(Vector2 position);

Drop zone at a Tree-local position: -100 means no target, -1 a sibling above, 0 on the row/as last child, 1 a sibling below, and 2 the first child of an existing branch. Combined zones do use 2; do not restrict handlers to -1/0/1. Requires enabled DropModeFlags; the result does not validate model data.

public TreeItem GetEdited();

Row of the last editing context, or null after clearing/removal. Need not equal GetSelected. In Custom, context is set when the application editor is requested. Check this reference before using GetEditedColumn.

public int GetEditedColumn();

Column of the last editing context rather than the current cursor. Clear resets GetEdited but can retain the previous column number. Use it only with a non-null valid GetEdited and the current Columns.

public Rect2 GetItemAreaRect(TreeItem item, int column = -1, int buttonIndex = -1);

Computed row area in Tree-local coordinates; column -1 means the full row, otherwise one column. For buttonIndex, supply a column and a nonnegative button index rather than an ID. Requires a row in this Tree. The result does not guarantee viewport visibility; first restore the needed visibility and layout for hidden/collapsed branches.

public TreeItem GetItemAtPosition(Vector2 position);

Row at a Tree-local position, or null when no row is found. Accounts for current scrolling and layout; pass control-local rather than screen coordinates. The returned row belongs to Tree.

public TreeItem GetNextSelected(TreeItem from);

Returns the next row with a stored selected flag in at least one column. Start with null, then pass the previous result; null ends iteration. Uses structural order, including a hidden root and collapsed branches. Reads retained flags even when Selectable is false; additionally check IsSelected per column for selectable selected cells.

public int GetPressedButton();

Stored button index from the last processed press, or -1. This is a column-local index rather than a command ID or a universal held-down test. Use the ButtonClicked id for command handling.

public TreeItem GetRoot();

Returns the structural root even when HideRoot is true; null before the first CreateItem and after Clear. The result belongs to Tree.

public Vector2 GetScroll();

Current pixel scroll offset. Returns 0 on an axis whose scrollbar is not visible. Not the Tree position or the index of the first visible row.

public Tree.ScrollHintModeEnum GetScrollHintMode();

Configures visual hints for content hidden above/below: Disabled, Both, Top or Bottom. Does not enable scrolling or change its amount.

public Tree.SelectModeEnum GetSelectMode();

Single selects one cell, Row selects the selectable cells of one row, and Multi allows accumulated selection. Changing modes neither clears nor normalizes existing flags: call DeselectAll before switching. In Multi, the GetSelected cursor is not the full selection.

public TreeItem GetSelected();

Returns the current cursor row or null. In Multi, selection can exist without a cursor, and the cursor can remain on a deselected cell. Enumerate GetNextSelected for selected rows. The result belongs to Tree.

public int GetSelectedColumn();

Current cursor column; -1 after DeselectAll. In Multi it neither enumerates selected columns nor guarantees IsSelected for the cursor cell.

public bool IsAutoTooltipEnabled();

Use the cell label/value as a tooltip when no explicit tooltip is set. Does not generate an accessibility description or replace action-button tooltips. Set false to disable this fallback; clearing the row’s explicit tooltip alone is insufficient.

public bool IsColumnClippingContent(int column);

Configured policy for excluding row content from minimum-width calculation. Does not report whether a particular label is currently clipped.

public bool IsColumnExpanding(int column);

Whether the column participates in spare-space distribution. This is expansion permission rather than proof that spare space currently exists.

public bool IsDragUnfoldingEnabled();

Allows a branch to unfold after a dragged item hovers over it. Does not create drag data or transfer the model. Disabling stops a pending unfolding timer.

public bool IsFoldingHidden();

Hides normal folding controls throughout Tree. Does not expand branches or block programmatic Collapsed/SetCollapsedRecursive. Configure branch states separately.

public bool IsHScrollEnabled();

Enables horizontal scrolling. With false, Tree’s minimum width includes content, so a container can expand the control. Does not fix column widths or control vertical scrolling.

public bool IsRecursiveFoldingEnabled();

Allows recursive folding/unfolding through the user Shift gesture. Does not block SetCollapsedRecursive from code.

public bool IsRootHidden();

Hides the root’s presentation while retaining the root and its children. Useful for a flat list with a shared hidden parent. Does not delete a row or change GetRoot.

public bool IsScrollHintTiled();

Tile the scroll-hint texture rather than stretching it. This styles the hint rather than enabling cyclic list scrolling.

public bool IsVScrollEnabled();

Enables vertical scrolling. With false, Tree’s minimum height includes content, so a container can expand the control. Configure horizontal scrolling separately.

public void ScrollToItem(TreeItem item, bool centerOnItem = false);

Scrolls to a row without selecting it or expanding its parents. item must belong to this Tree. Expand the required ancestor chain and configure control size first; centerOnItem attempts vertical centering within the available scroll range.

public void SetAllowReselect(bool allow);

Allows repeat notification when the selection path chooses an already selected cell/row. Does not enable Multi or make programmatic TreeItem.Select emit signals in Multi.

public void SetAllowRmbSelect(bool allow);

Allows right-mouse selection of a row. This is an input policy: it does not open a context menu, change SelectMode or restrict programmatic selection.

public void SetAllowSearch(bool allow);

Allows keyboard prefix search against original labels, ignoring case. Navigates rows rather than filtering data or creating a search box. In Multi, search moves only the cursor without adding to selection. gui/timers/incremental_search_max_interval_msec controls the typing interval.

public void SetAutoTooltip(bool enable);

Use the cell label/value as a tooltip when no explicit tooltip is set. Does not generate an accessibility description or replace action-button tooltips. Set false to disable this fallback; clearing the row’s explicit tooltip alone is insufficient.

public void SetColumnClipContent(int column, bool enable);

Allows row content to be omitted when computing the column’s minimum width. Does not exclude a visible title’s minimum or disable Expand. With false, full text width contributes only for cells using TextOverrunBehavior = NoTrimming; trimmable text does not itself force the column to fit the entire label.

public void SetColumnCustomMinimumWidth(int column, int minWidth);

Sets a nonnegative column-width minimum in pixels rather than a fixed width. Titles, content and Expand can make it wider. Negative values are ignored; 0 removes the local minimum. For a constrained-width column, also disable Expand and configure ClipContent.

public void SetColumnExpand(int column, bool expand);

Allows the column to receive spare space beyond its minimum; default true. false retains its computed minimum rather than forcing content into an arbitrary pixel width.

public void SetColumnExpandRatio(int column, int ratio);

Sets an expanding column’s relative weight, default 1. A 1:2 ratio divides extra space rather than total widths. Use positive integers: zero and negative values are stored without validation and can produce undesirable sizing. Has no effect when Expand is false.

public void SetColumnTitle(int column, string title);

Sets the original column title and updates its text measurement. Presentation uses Tree translation; GetColumnTitle retains the source string. The setter neither shows headers nor sorts rows.

public void SetColumnTitleAlignment(int column, HorizontalAlignment titleAlignment);

Aligns header text: Left, Center or Right. Fill is unsupported and produces a warning; do not use it. Does not change text direction or alignment in data rows.

public void SetColumnTitleDirection(int column, Control.TextDirection direction);

Sets the header’s base text direction. Inherited follows the Tree layout. Does not change original GetColumnTitle, column order or text direction in data rows.

public void SetColumnTitleLanguage(int column, string language);

Header text-shaping language hint, such as ar. An empty string uses the default locale. Does not translate text or switch the application language.

public void SetColumnTitleTooltipText(int column, string tooltipText);

Sets an explicit header tooltip, separate from cell and button tooltips. An empty string falls back to the Control’s tooltip behavior.

public void SetColumnTitlesVisible(bool visible);

Shows column headers, default false. Prefer setting this before populating or measuring columns. Limitation: showing headers dynamically after GetColumnWidth can retain stale cached widths. To recompute, retain each column’s IsColumnClippingContent, set SetColumnClipContent to the opposite value, then restore it.

public void SetColumns(int amount);

Column count, at least 1; default 1. Set before populating. Reducing it discards trailing cell data throughout the tree. Changes are blocked during mouse selection processing.

public void SetDropModeFlags(int flags);

Drop-target zones: 0 disables them, OnItem (1) targets a row, Inbetween (2) targets between rows, and 3 enables both. Controls target calculation/highlighting rather than data transfer. Implement validation and model changes in drag-and-drop handlers; account for SetAcceptChildren and prevent cycles.

public void SetEnableDragUnfolding(bool enable);

Allows a branch to unfold after a dragged item hovers over it. Does not create drag data or transfer the model. Disabling stops a pending unfolding timer.

public void SetEnableRecursiveFolding(bool enable);

Allows recursive folding/unfolding through the user Shift gesture. Does not block SetCollapsedRecursive from code.

public void SetHScrollEnabled(bool hScroll);

Enables horizontal scrolling. With false, Tree’s minimum width includes content, so a container can expand the control. Does not fix column widths or control vertical scrolling.

public void SetHideFolding(bool hide);

Hides normal folding controls throughout Tree. Does not expand branches or block programmatic Collapsed/SetCollapsedRecursive. Configure branch states separately.

public void SetHideRoot(bool enable);

Hides the root’s presentation while retaining the root and its children. Useful for a flat list with a shared hidden parent. Does not delete a row or change GetRoot.

public void SetScrollHintMode(Tree.ScrollHintModeEnum scrollHintMode);

Configures visual hints for content hidden above/below: Disabled, Both, Top or Bottom. Does not enable scrolling or change its amount.

public void SetSelectMode(Tree.SelectModeEnum mode);

Single selects one cell, Row selects the selectable cells of one row, and Multi allows accumulated selection. Changing modes neither clears nor normalizes existing flags: call DeselectAll before switching. In Multi, the GetSelected cursor is not the full selection.

public void SetSelected(TreeItem item, int column);

Selects the specified cell through the single-selection walk even in Multi, clearing previous flags on traversed rows. Can emit CellSelected, ItemSelected or MultiSelected. Hidden subtrees are skipped; call DeselectAll first to clear every row. item must belong to this Tree; null does not clear selection.

public void SetTileScrollHint(bool tileScrollHint);

Tile the scroll-hint texture rather than stretching it. This styles the hint rather than enabling cyclic list scrolling.

public void SetVScrollEnabled(bool hScroll);

Enables vertical scrolling. With false, Tree’s minimum height includes content, so a container can expand the control. Configure horizontal scrolling separately.

public event Tree.ButtonClickedEventHandler ButtonClicked;

Action-button activation: item, column, command ID and mouse button. id is the stored ID rather than an index. Resolve GetButtonById before modifying the button and check for -1. Keyboard activation can also report MouseButton.Left, so do not infer the input source solely from the last argument.

public event Action CellSelected;

Cell cursor/selection changed through the selection path, including programmatic SetSelected. Not a universal notification for every flag change: Multi Select, Deselect and DeselectAll can run without it.

public event Tree.CheckPropagatedToItemEventHandler CheckPropagatedToItem;

Traversal notification from PropagateCheck(..., true): the source row, depth-first descendants, then ancestors bottom-up. Also emitted for unchanged values. Read IsChecked/IsIndeterminate for the supplied cell; collect a complete tree summary after traversal finishes. This is not ItemEdited or an automatic response to SetChecked.

public event Tree.ColumnTitleClickedEventHandler ColumnTitleClicked;

The user activated the specified column header with a mouse button. Tree does not sort rows automatically: retain sort direction in the model and reorder explicitly. Programmatic changes to header text or styling do not emit this signal.

public event Tree.CustomItemClickedEventHandler CustomItemClicked;

Notification from mouse editing of Custom after ItemEdited, carrying the mouse button. Context is GetEdited/GetEditedColumn. Programmatic EditSelected need not emit it; do not use it as a universal value-apply event.

public event Tree.CustomPopupEditedEventHandler CustomPopupEdited;

Request for an application editor for a Custom cell. Context is already available through GetEdited/GetEditedColumn and the area through GetCustomPopupRect. EditSelected passes arrowClicked false and then emits ItemEdited. The application implements the window and value apply/cancel behavior.

public event Tree.EmptyClickedEventHandler EmptyClicked;

Click on empty Tree content, reporting a local position and mouse button. Does not mean that the selection model is already cleared or that data should be deleted.

public event Action ItemActivated;

Row activation, such as a double click or ui_accept when the built-in editor/button did not handle the action. Read the current row through GetSelected. Separate from selection rather than a universal value-change notification.

public event Tree.ItemCollapsedEventHandler ItemCollapsed;

The supplied row’s Collapsed state changed, including changes from code and expansion. Read item.IsCollapsed() for the new state. Reassigning the old value emits nothing. A recursive call produces separate row events rather than one final snapshot.

public event Action ItemEdited;

Editing-path notification; read context with GetEdited/GetEditedColumn. Check has already toggled its value. For Custom, the signal can arrive when an editor is requested, before the application changes the value: it is not a universal commit. Programmatic SetText, SetChecked, SetRange and PropagateCheck do not themselves emit it.

public event Action ItemIconDoubleClicked;

Notification from the icon/unhandled row-area double-click path. Distinct from action-button ButtonClicked and ItemActivated. Recheck the current row and whether the action is valid in the handler.

public event Tree.ItemMouseSelectedEventHandler ItemMouseSelected;

The mouse-selection path reports a Tree-local position and mouse button. Not emitted for every programmatic Select/SetSelected. Handle selection signals and your own programmatic operations separately in the selection model.

public event Action ItemSelected;

Selection notification in Single/Row, including changes from code. Read the current row through GetSelected. Does not enumerate Multi changes or report deselection.

public event Tree.MultiSelectedEventHandler MultiSelected;

In Multi, reports setting or clearing the specified cell’s flag. Programmatic SetSelected can emit it; TreeItem.Select/Deselect and DeselectAll do not. Replacement notifications occur during traversal, so update an aggregate model snapshot after the operation has completed.

public event Action NothingSelected;

Notification from the left-click-on-empty-space path without Shift or the command modifier (Ctrl/Cmd). Not a universal selection-became-empty event: DeselectAll and programmatic deselection do not emit it. Check the actual selection separately.