TabBar

public TabBar();

Creates an empty strip: TabCount = 0, CurrentTab = PreviousTab = -1, DeselectEnabled = false. Child Controls do not automatically become pages.

public bool ClipTabs { get; set; }

Constrain the strip to available width, default true. Overflow uses navigation buttons and an index offset. false includes header widths in minimum size and resets the offset; not child ClipContents.

public bool CloseWithMiddleMouse { get; set; }

Allows a middle-button close request, default true. Does not automatically remove records or control close-button visibility.

public int CurrentTab { get; set; }

Selected index, -1 for none. Direct setter accepts hidden/disabled; -1 requires DeselectEnabled or no available records. Emits TabSelected even for the same index, TabChanged only on change. An initial request before initialization can be queued.

public bool DeselectEnabled { get; set; }

Allows selection -1 with available tabs, default false. Disabling without selection attempts to choose the next available tab from the start.

public bool DragToRearrangeEnabled { get; set; }

Allows user drag-to-reorder, default false. Does not prevent code-driven MoveTab; cross-strip transfers additionally require matching TabsRearrangeGroup.

public int MaxTabWidth { get; set; }

Pixel width limit used to shorten header text, default 0 disables the per-header limit. Requires ≥ 0. Icons, buttons and margins retain their minimum, so the complete header can exceed this value. Available layout maximum also contributes.

public bool ScrollToSelected { get; set; }

Automatically reveal the selected header, default true. Enabling immediately calls EnsureTabVisible for the current index. false retains selection without guaranteeing visibility; explicit EnsureTabVisible remains available.

public bool ScrollingEnabled { get; set; }

Allows strip scrolling through wheel/touch input, default true. Does not block EnsureTabVisible or automatic CurrentTab reveal, or hide overflow buttons.

public bool SelectWithRmb { get; set; }

Allows right-button selection, default false. TabRmbClicked and displaying your menu are separate actions; programmatic CurrentTab is not restricted by this flag.

public bool SwitchOnDragHover { get; set; }

Switches tabs after a hover delay while dragging content, default true. Does not make a drop acceptable. Dragging tabs themselves does not use this hover path.

public TabBar.AlignmentMode TabAlignment { get; set; }

Horizontal header alignment Left/Center/Right, default Left. Layout direction is handled separately; not alignment of your pages.

public TabBar.CloseButtonDisplayPolicy TabCloseDisplayPolicy { get; set; }

Built-in close-button display: default ShowNever, ShowActiveOnly or ShowAlways. Activation emits TabClosePressed; the application handles removal.

public int TabCount { get; set; }

Record count including hidden/disabled, default 0. Setter requires a value ≥ 0: grows empty tabs or removes the tail and clamps CurrentTab. Normally changes selection without signals; first application can execute queued CurrentTab.

public TabBar.SizingMode TabSizing { get; set; }

Header sizing, default FitContent. Uniform uses the widest width; Justify proportionally expands widths when space is available; Expand uses equal widths if the widest fits, otherwise falls back to FitContent. MaxTabWidth and available layout can further constrain text.

public int TabsRearrangeGroup { get; set; }

Tab-transfer group between TabBars; default -1 disables cross-strip transfers. Use matching nonnegative IDs and DragToRearrangeEnabled on participants. Not an Entity group or stable tab ID.

public void AddTab(string title = "", Texture2D icon = null);

Appends a record with a title and optional shared icon. Selects it when first and DeselectEnabled is off; selection signals emit in the tree. Does not create a page.

public void ClearTabs();

Removes all records and resets current/previous to -1 and offset to 0. Does not emit TabChanged/TabSelected or remove child Controls. Explicitly refresh your own page.

public void EnsureTabVisible(int idx);

Adjusts the scroll index for a header without changing CurrentTab. Works in the tree with overflow buttons visible, independently of ScrollingEnabled. Does nothing for -1, hidden or already-in-window indices. Does not promise full display of a header wider than the strip.

public bool GetClipTabs();

Constrain the strip to available width, default true. Overflow uses navigation buttons and an index offset. false includes header widths in minimum size and resets the offset; not child ClipContents.

public bool GetCloseWithMiddleMouse();

Allows a middle-button close request, default true. Does not automatically remove records or control close-button visibility.

public int GetCurrentTab();

Selected index, -1 for none. Direct setter accepts hidden/disabled; -1 requires DeselectEnabled or no available records. Emits TabSelected even for the same index, TabChanged only on change. An initial request before initialization can be queued.

public bool GetDeselectEnabled();

Allows selection -1 with available tabs, default false. Disabling without selection attempts to choose the next available tab from the start.

public bool GetDragToRearrangeEnabled();

Allows user drag-to-reorder, default false. Does not prevent code-driven MoveTab; cross-strip transfers additionally require matching TabsRearrangeGroup.

public int GetMaxTabWidth();

Pixel width limit used to shorten header text, default 0 disables the per-header limit. Requires ≥ 0. Icons, buttons and margins retain their minimum, so the complete header can exceed this value. Available layout maximum also contributes.

public bool GetOffsetButtonsVisible();

Whether overflow buttons are displayed after geometry calculation. Not the ScrollingEnabled setting or proof that the selected tab is visible.

public int GetPreviousTab();

Index before the last selection assignment, adjusted by reorder/removal. Reselection makes previous equal current; not necessarily the last different tab.

public bool GetScrollToSelected();

Automatically reveal the selected header, default true. Enabling immediately calls EnsureTabVisible for the current index. false retains selection without guaranteeing visibility; explicit EnsureTabVisible remains available.

public bool GetScrollingEnabled();

Allows strip scrolling through wheel/touch input, default true. Does not block EnsureTabVisible or automatic CurrentTab reveal, or hide overflow buttons.

public bool GetSelectWithRmb();

Allows right-button selection, default false. TabRmbClicked and displaying your menu are separate actions; programmatic CurrentTab is not restricted by this flag.

public bool GetSwitchOnDragHover();

Switches tabs after a hover delay while dragging content, default true. Does not make a drop acceptable. Dragging tabs themselves does not use this hover path.

public TabBar.AlignmentMode GetTabAlignment();

Horizontal header alignment Left/Center/Right, default Left. Layout direction is handled separately; not alignment of your pages.

public Texture2D GetTabButtonIcon(int tabIdx);

Shared auxiliary-button Texture2D, or null, rather than the main icon.

public TabBar.CloseButtonDisplayPolicy GetTabCloseDisplayPolicy();

Built-in close-button display: default ShowNever, ShowActiveOnly or ShowAlways. Activation emits TabClosePressed; the application handles removal.

public int GetTabCount();

Record count including hidden/disabled, default 0. Setter requires a value ≥ 0: grows empty tabs or removes the tail and clamps CurrentTab. Normally changes selection without signals; first application can execute queued CurrentTab.

public Texture2D GetTabIcon(int tabIdx);

Returns the shared main icon, or null, separately from the auxiliary button.

public int GetTabIconMaxWidth(int tabIdx);

Stored per-tab width limit rather than actual width after theme constraints.

public int GetTabIdxAtPoint(Vector2 point);

Index of the header under a local point in the current window, or -1. Excludes hidden records but can return disabled ones. Geometry query rather than selection or selection-permission validation.

public string GetTabLanguage(int tabIdx);

Returns the tab shaping language, or empty for the control locale.

public Variant GetTabMetadata(int tabIdx);

Returns metadata Variant, Nil when unassigned. Reference containers inside the Variant can share contents with the original value.

public int GetTabOffset();

Returns the current starting index of the scrolling tab window rather than a pixel offset. Indexing uses the full list, including hidden records.

public Rect2 GetTabRect(int tabIdx);

Returns the header rectangle in TabBar local coordinates from the current layout cache. Negative indices count from the end (-1 is last). A rectangle for an off-window/hidden tab does not prove visibility or a hit; use GetTabIdxAtPoint to query a point.

public TabBar.SizingMode GetTabSizing();

Header sizing, default FitContent. Uniform uses the widest width; Justify proportionally expands widths when space is available; Expand uses equal widths if the widest fits, otherwise falls back to FitContent. MaxTabWidth and available layout can further constrain text.

public Control.TextDirection GetTabTextDirection(int tabIdx);

Returns the stored header text direction, default Inherited.

public string GetTabTitle(int tabIdx);

Returns the original title rather than its translation or a stable ID.

public string GetTabTooltip(int tabIdx);

Returns the stored tooltip string.

public int GetTabsRearrangeGroup();

Tab-transfer group between TabBars; default -1 disables cross-strip transfers. Use matching nonnegative IDs and DragToRearrangeEnabled on participants. Not an Entity group or stable tab ID.

public bool IsTabDisabled(int tabIdx);

Returns the record disabled flag, separate from hidden and current selection.

public bool IsTabHidden(int tabIdx);

Returns the header hidden flag rather than visibility of your application page.

public void MoveTab(int from, int to);

Moves the complete record, including metadata/flags, to final index to; both indices are 0…TabCount-1. Preserves selected record while adjusting current/previous; does not itself emit TabChanged/TabSelected/ActiveTabRearranged.

public void RemoveTab(int tabIdx);

Removes an existing record. Later indices shift; current/previous are adjusted. Removing the current record emits TabChanged without TabSelected in the tree and seeks an available replacement. Removing before it can change the index without a signal.

public bool SelectNextAvailable();

Selects the next higher-index record that is neither hidden nor disabled. Does not wrap; starts at the first from -1. Returns true on successful selection.

public bool SelectPreviousAvailable();

Selects the previous lower-index record that is neither hidden nor disabled. Does not wrap; returns false when CurrentTab = -1.

public void SetClipTabs(bool clipTabs);

Constrain the strip to available width, default true. Overflow uses navigation buttons and an index offset. false includes header widths in minimum size and resets the offset; not child ClipContents.

public void SetCloseWithMiddleMouse(bool enabled);

Allows a middle-button close request, default true. Does not automatically remove records or control close-button visibility.

public void SetCurrentTab(int tabIdx);

Selected index, -1 for none. Direct setter accepts hidden/disabled; -1 requires DeselectEnabled or no available records. Emits TabSelected even for the same index, TabChanged only on change. An initial request before initialization can be queued.

public void SetDeselectEnabled(bool enabled);

Allows selection -1 with available tabs, default false. Disabling without selection attempts to choose the next available tab from the start.

public void SetDragToRearrangeEnabled(bool enabled);

Allows user drag-to-reorder, default false. Does not prevent code-driven MoveTab; cross-strip transfers additionally require matching TabsRearrangeGroup.

public void SetMaxTabWidth(int width);

Pixel width limit used to shorten header text, default 0 disables the per-header limit. Requires ≥ 0. Icons, buttons and margins retain their minimum, so the complete header can exceed this value. Available layout maximum also contributes.

public void SetScrollToSelected(bool enabled);

Automatically reveal the selected header, default true. Enabling immediately calls EnsureTabVisible for the current index. false retains selection without guaranteeing visibility; explicit EnsureTabVisible remains available.

public void SetScrollingEnabled(bool enabled);

Allows strip scrolling through wheel/touch input, default true. Does not block EnsureTabVisible or automatic CurrentTab reveal, or hide overflow buttons.

public void SetSelectWithRmb(bool enabled);

Allows right-button selection, default false. TabRmbClicked and displaying your menu are separate actions; programmatic CurrentTab is not restricted by this flag.

public void SetSwitchOnDragHover(bool enabled);

Switches tabs after a hover delay while dragging content, default true. Does not make a drop acceptable. Dragging tabs themselves does not use this hover path.

public void SetTabAlignment(TabBar.AlignmentMode alignment);

Horizontal header alignment Left/Center/Right, default Left. Layout direction is handled separately; not alignment of your pages.

public void SetTabButtonIcon(int tabIdx, Texture2D icon);

Sets a shared auxiliary-header-button icon; null removes the button. Separate from the main icon and built-in close button. Activation emits TabButtonPressed without deleting the tab.

public void SetTabCloseDisplayPolicy(TabBar.CloseButtonDisplayPolicy policy);

Built-in close-button display: default ShowNever, ShowActiveOnly or ShowAlways. Activation emits TabClosePressed; the application handles removal.

public void SetTabCount(int count);

Record count including hidden/disabled, default 0. Setter requires a value ≥ 0: grows empty tabs or removes the tail and clamps CurrentTab. Normally changes selection without signals; first application can execute queued CurrentTab.

public void SetTabDisabled(int tabIdx, bool disabled);

Changes the disabled flag for user selection/available navigation. Does not deselect a current record or block direct CurrentTab.

public void SetTabHidden(int tabIdx, bool hidden);

Hides the header without removing its record. Does not change TabCount or automatically switch current selection in standalone TabBar.

public void SetTabIcon(int tabIdx, Texture2D icon);

Assigns a shared main Texture2D; null removes it. Does not copy the resource; setter refreshes geometry and minimum size. Use SetTabIconMaxWidth to limit drawing rather than modifying the source texture.

public void SetTabIconMaxWidth(int tabIdx, int width);

Main-icon pixel width limit, 0 for no per-tab limit. Positive values downscale preserving aspect; a stricter theme icon_max_width takes priority. Does not enlarge small icons or modify the source resource.

public void SetTabLanguage(int tabIdx, string language);

Sets shaping language for one title; empty uses the control locale. Does not translate the original string or switch application locale.

public void SetTabMetadata(int tabIdx, Variant metadata);

Sets record Variant data, such as your stable ID. MoveTab moves it with the record. Array/Dictionary remain shared containers; copy separately when independent data is needed.

public void SetTabSizing(TabBar.SizingMode tabSizing);

Header sizing, default FitContent. Uniform uses the widest width; Justify proportionally expands widths when space is available; Expand uses equal widths if the widest fits, otherwise falls back to FitContent. MaxTabWidth and available layout can further constrain text.

public void SetTabTextDirection(int tabIdx, Control.TextDirection direction);

Sets one title’s shaping direction. Inherited uses layout direction; Ltr/Rtl do not reverse the stored string.

public void SetTabTitle(int tabIdx, string title);

Sets the original title and refreshes shaping/geometry. Display can use translation; index and metadata are unchanged.

public void SetTabTooltip(int tabIdx, string tooltip);

Sets a separate header tooltip. Does not change title, index or metadata.

public void SetTabsRearrangeGroup(int groupId);

Tab-transfer group between TabBars; default -1 disables cross-strip transfers. Use matching nonnegative IDs and DragToRearrangeEnabled on participants. Not an Entity group or stable tab ID.

public event TabBar.ActiveTabRearrangedEventHandler ActiveTabRearranged;

Drag-path notification of the new index for the tab being activated. Code-driven MoveTab does not itself emit it. Resolve your own metadata ID again after reordering.

public event TabBar.TabButtonPressedEventHandler TabButtonPressed;

Auxiliary SetTabButtonIcon button was activated. Separate from TabClosePressed; no automatic deletion.

public event TabBar.TabChangedEventHandler TabChanged;

Notification from CurrentTab on selection change, or RemoveTab when deleting the current record. Not universal index observation: MoveTab, ClearTabs and ordinary SetTabCount can change state without it. -1 means no selection.

public event TabBar.TabClickedEventHandler TabClicked;

User clicked a tab. Programmatic CurrentTab does not emit it; clicking again may leave selection unchanged.

public event TabBar.TabClosePressedEventHandler TabClosePressed;

Close request from the close button/allowed middle click. Does not itself remove the record. Check whether closing is allowed, then explicitly remove the model/page and call RemoveTab.

public event TabBar.TabHoveredEventHandler TabHovered;

Pointer entered a different header. Not selection; leaving the strip does not guarantee a separate event with -1. Disabled headers can also participate in hover geometry.

public event TabBar.TabRmbClickedEventHandler TabRmbClicked;

Right click on a tab. SelectWithRmb separately controls right-button selection; use the signal for your own context menu.

public event TabBar.TabSelectedEventHandler TabSelected;

CurrentTab selection request, including reselection and programmatic assignment. Precedes TabChanged on change. Structural MoveTab/RemoveTab/ClearTabs/ordinary SetTabCount need not emit it.