TabContainer

public TabContainer();

Creates an empty container: CurrentTab = -1, TabsVisible = true, DeselectEnabled = false, UseHiddenTabsForMinSize = false. Add pages as Control children.

public bool AllTabsInFront { get; set; }

Legacy setting with no effect in the current implementation. Getter returns false; setter does not change order, and true can warn. Do not use it to control layers or page order.

public bool ClipTabs { get; set; }

Constrain the strip to available width, default true. Insufficient space makes some headers scrollable; false includes their widths in minimum size and can expand the container. Not page ClipContents.

public int CurrentTab { get; set; }

Selected page index, -1 in an empty container. Valid indices are 0…GetTabCount()-1; -1 requires enabled deselection or no available tabs. Setter can select disabled tabs. Requests before tree entry are deferred. Repeating the index emits TabSelected without TabChanged.

public bool DeselectEnabled { get; set; }

Allows no selected page, default false. Enable and assign CurrentTab = -1 to explicitly deselect. Disabling while at -1 attempts to select the first available tab.

public bool DragToRearrangeEnabled { get; set; }

Allows user drag-to-reorder, default false. Does not prevent code-driven MoveChild. For transfers between containers also configure matching TabsRearrangeGroup values.

public bool SwitchOnDragHover { get; set; }

Switch tabs on hover while dragging content, default true. Does not determine drop acceptance or enable tab reordering. Dragging tabs themselves uses a separate path.

public TabBar.AlignmentMode TabAlignment { get; set; }

Header alignment Left/Center/Right, default Left. Affects the internal TabBar and theme margins rather than page content. Layout direction is handled separately.

public Control.FocusModeEnum TabFocusMode { get; set; }

FocusMode of the internal strip, default All. None disables header focus without changing FocusMode of buttons/fields within pages.

public TabBar.SizingMode TabSizing { get; set; }

Header-width mode, default FitContent. FitContent uses individual content width; Uniform uses the widest width for all. Justify proportionally expands widths when space is available; Expand divides space equally if the widest header fits, otherwise falls back to FitContent. Does not set page size.

public TabContainer.TabPosition TabsPosition { get; set; }

Tab strip at the top or bottom: default Top. Bottom moves headers and vertically flips their style box rather than page content. Relayout is deferred.

public int TabsRearrangeGroup { get; set; }

Cross-container tab-transfer group; default -1 disables transfers between containers. Set a matching nonnegative ID and enable DragToRearrangeEnabled on participants. Not an Entity group or a stable tab ID.

public bool TabsVisible { get; set; }

Show the header strip, default true. false removes the strip and its layout space while retaining the selected page and index.

public bool UseHiddenTabsForMinSize { get; set; }

Include invisible pages, including inactive ones, in minimum-size calculation; default false. true takes the componentwise maximum across pages and helps prevent minimum-size changes on switching.

public bool AreTabsVisible();

Show the header strip, default true. false removes the strip and its layout space while retaining the selected page and index.

public bool GetClipTabs();

Constrain the strip to available width, default true. Insufficient space makes some headers scrollable; false includes their widths in minimum size and can expand the container. Not page ClipContents.

public int GetCurrentTab();

Selected page index, -1 in an empty container. Valid indices are 0…GetTabCount()-1; -1 requires enabled deselection or no available tabs. Setter can select disabled tabs. Requests before tree entry are deferred. Repeating the index emits TabSelected without TabChanged.

public Control GetCurrentTabControl();

Returns the current child page, or null without selection. This is an existing Control rather than a new instance.

public bool GetDeselectEnabled();

Allows no selected page, default false. Enable and assign CurrentTab = -1 to explicitly deselect. Disabling while at -1 attempts to select the first available tab.

public bool GetDragToRearrangeEnabled();

Allows user drag-to-reorder, default false. Does not prevent code-driven MoveChild. For transfers between containers also configure matching TabsRearrangeGroup values.

public Popup GetPopup();

Returns the assigned shared Popup, or null. The container stores an object ID rather than owning its lifetime; detach through SetPopup(null) before freeing the menu.

public int GetPreviousTab();

Index before the last selection assignment. Assigning the same CurrentTab updates previous to that index; not necessarily the last different page or a stable ID.

public bool GetSwitchOnDragHover();

Switch tabs on hover while dragging content, default true. Does not determine drop acceptance or enable tab reordering. Dragging tabs themselves uses a separate path.

public TabBar.AlignmentMode GetTabAlignment();

Header alignment Left/Center/Right, default Left. Affects the internal TabBar and theme margins rather than page content. Layout direction is handled separately.

public TabBar GetTabBar();

Shared internal TabBar. Do not free it or directly change its tab count: headers must correspond to TabContainer child pages. Use container methods for selection and tab properties.

public Texture2D GetTabButtonIcon(int tabIdx);

Returns the shared auxiliary-button icon, or null. Does not return the tab’s main icon.

public Control GetTabControl(int tabIdx);

Returns the child page at a tab index. Returns null for negative/nonexistent indices. Shared reference: do not free it while the container owns the page.

public int GetTabCount();

Number of tab pages, including hidden/disabled ones. Not the total Entity child count or visible-header count.

public Control.FocusModeEnum GetTabFocusMode();

FocusMode of the internal strip, default All. None disables header focus without changing FocusMode of buttons/fields within pages.

public Texture2D GetTabIcon(int tabIdx);

Returns the shared main header icon, or null. Separate from the auxiliary SetTabButtonIcon slot.

public int GetTabIconMaxWidth(int tabIdx);

Returns the stored per-tab width limit, default 0. Not the actual drawn width or combined theme limit.

public int GetTabIdxAtPoint(Vector2 point);

Returns the header index under a point, or -1. The current implementation forwards the point directly to the internal TabBar: use its local coordinates, such as GetTabBar().GetLocalMousePosition(), rather than page/screen/container coordinates. This matters with Bottom and strip offsets. A disabled header can still be under the point.

public int GetTabIdxFromControl(Control control);

Finds the current index of a direct child page. Requires a non-null Control with this parent; a wrong parent reports an error and returns -1. Across reorders retain the page reference/ID rather than its old index.

public Variant GetTabMetadata(int tabIdx);

Returns Variant tab data. Returns Nil when no metadata was assigned. Use an expected type for your ID and validate before conversion.

public TabBar.SizingMode GetTabSizing();

Header-width mode, default FitContent. FitContent uses individual content width; Uniform uses the widest width for all. Justify proportionally expands widths when space is available; Expand divides space equally if the widest header fits, otherwise falls back to FitContent. Does not set page size.

public string GetTabTitle(int tabIdx);

Returns the stored tab title, separate from the page name and stable ID.

public string GetTabTooltip(int tabIdx);

Returns the stored header tooltip.

public TabContainer.TabPosition GetTabsPosition();

Tab strip at the top or bottom: default Top. Bottom moves headers and vertically flips their style box rather than page content. Relayout is deferred.

public int GetTabsRearrangeGroup();

Cross-container tab-transfer group; default -1 disables transfers between containers. Set a matching nonnegative ID and enable DragToRearrangeEnabled on participants. Not an Entity group or a stable tab ID.

public bool GetUseHiddenTabsForMinSize();

Include invisible pages, including inactive ones, in minimum-size calculation; default false. true takes the componentwise maximum across pages and helps prevent minimum-size changes on switching.

public bool IsAllTabsInFront();

Legacy setting with no effect in the current implementation. Getter returns false; setter does not change order, and true can warn. Do not use it to control layers or page order.

public bool IsTabDisabled(int tabIdx);

Returns the header disabled flag; not page Visible state or a guarantee that the page is unselected.

public bool IsTabHidden(int tabIdx);

Header hidden flag. Not equivalent to !Visible: an inactive page is normally invisible while its header remains visible.

public bool SelectNextAvailable();

Selects the next higher-index tab that is neither hidden nor disabled; returns true on success. Does not wrap from the end to the start. With CurrentTab = -1 searches from the first tab.

public bool SelectPreviousAvailable();

Selects the previous lower-index available tab, skipping hidden/disabled. Returns false without changing selection when none exists to the left; does not wrap.

public void SetAllTabsInFront(bool isFront);

Legacy setting with no effect in the current implementation. Getter returns false; setter does not change order, and true can warn. Do not use it to control layers or page order.

public void SetClipTabs(bool clipTabs);

Constrain the strip to available width, default true. Insufficient space makes some headers scrollable; false includes their widths in minimum size and can expand the container. Not page ClipContents.

public void SetCurrentTab(int tabIdx);

Selected page index, -1 in an empty container. Valid indices are 0…GetTabCount()-1; -1 requires enabled deselection or no available tabs. Setter can select disabled tabs. Requests before tree entry are deferred. Repeating the index emits TabSelected without TabChanged.

public void SetDeselectEnabled(bool enabled);

Allows no selected page, default false. Enable and assign CurrentTab = -1 to explicitly deselect. Disabling while at -1 attempts to select the first available tab.

public void SetDragToRearrangeEnabled(bool enabled);

Allows user drag-to-reorder, default false. Does not prevent code-driven MoveChild. For transfers between containers also configure matching TabsRearrangeGroup values.

public void SetPopup(Entity popup);

Assigns a reference to an existing Popup, such as PopupMenu; null detaches. The parameter is Entity, but another type clears the assignment. Does not add it to the tree, reparent, open or free it. Add the Popup to the tree yourself and detach before freeing it.

public void SetSwitchOnDragHover(bool enabled);

Switch tabs on hover while dragging content, default true. Does not determine drop acceptance or enable tab reordering. Dragging tabs themselves uses a separate path.

public void SetTabAlignment(TabBar.AlignmentMode alignment);

Header alignment Left/Center/Right, default Left. Affects the internal TabBar and theme margins rather than page content. Layout direction is handled separately.

public void SetTabButtonIcon(int tabIdx, Texture2D icon);

Sets an icon for a separate header button; null removes the button. Does not change the main icon. Activation emits TabButtonPressed; implement page removal/closing yourself.

public void SetTabDisabled(int tabIdx, bool disabled);

Prevents choosing the header through user input and available-tab navigation. Does not hide the page or switch away from a current tab; programmatic CurrentTab can still select it.

public void SetTabFocusMode(Control.FocusModeEnum focusMode);

FocusMode of the internal strip, default All. None disables header focus without changing FocusMode of buttons/fields within pages.

public void SetTabHidden(int tabIdx, bool hidden);

Hides/restores the header without removing its page or changing tab count. Changing it also hides the page and reconciles selection; hiding the current tab can select another. Configure after adding the page.

public void SetTabIcon(int tabIdx, Texture2D icon);

Assigns a shared Texture2D as the main header icon; null removes it. Requires an existing page. Does not copy the resource; assignment refreshes margins/drawing. Size is constrained by the theme and SetTabIconMaxWidth.

public void SetTabIconMaxWidth(int tabIdx, int width);

Maximum main-icon width in local pixels. 0 means no per-tab limit; positive values preserve aspect ratio and combine with the stricter theme icon_max_width. Does not enlarge a small icon or modify Texture2D.

public void SetTabMetadata(int tabIdx, Variant metadata);

Stores Variant tab data, such as your stable ID. Data belongs to the tab record and moves with it; its index does not become a stable key. Reference containers inside a Variant can remain shared.

public void SetTabSizing(TabBar.SizingMode tabSizing);

Header-width mode, default FitContent. FitContent uses individual content width; Uniform uses the widest width for all. Justify proportionally expands widths when space is available; Expand divides space equally if the widest header fits, otherwise falls back to FitContent. Does not set page size.

public void SetTabTitle(int tabIdx, string title);

Sets the header text without renaming the page Control. A custom title survives page renames; assigning the current Name restores name tracking.

public void SetTabTooltip(int tabIdx, string tooltip);

Sets the header tooltip without changing title, name or index. Requires an existing tab.

public void SetTabsPosition(TabContainer.TabPosition tabsPosition);

Tab strip at the top or bottom: default Top. Bottom moves headers and vertically flips their style box rather than page content. Relayout is deferred.

public void SetTabsRearrangeGroup(int groupId);

Cross-container tab-transfer group; default -1 disables transfers between containers. Set a matching nonnegative ID and enable DragToRearrangeEnabled on participants. Not an Entity group or a stable tab ID.

public void SetTabsVisible(bool visible);

Show the header strip, default true. false removes the strip and its layout space while retaining the selected page and index.

public void SetUseHiddenTabsForMinSize(bool enabled);

Include invisible pages, including inactive ones, in minimum-size calculation; default false. true takes the componentwise maximum across pages and helps prevent minimum-size changes on switching.

public event TabContainer.ActiveTabRearrangedEventHandler ActiveTabRearranged;

Drag-path notification giving the new index of the tab being activated. Not a universal reorder signal: code-driven MoveChild does not itself emit it. Resolve indices again by page reference/metadata after reordering.

public event Action PrePopupPressed;

Emitted by the extra-menu button before positioning and opening the assigned Popup. Use to refresh items. Do not free/replace the Popup in this handler: the current path already captured the object it will open. SetPopup itself does not emit it.

public event TabContainer.TabButtonPressedEventHandler TabButtonPressed;

Auxiliary button created through SetTabButtonIcon was activated. Supplies a tab index; the container does not remove the page itself. Capture its reference/metadata before reordering or removing.

public event TabContainer.TabChangedEventHandler TabChanged;

Selected tab index changed, including programmatic selection. The container updates page visibility before this notification; -1 means no selected page. Not emitted when assigning the same index.

public event TabContainer.TabClickedEventHandler TabClicked;

User clicked a tab header. Programmatic CurrentTab does not emit this signal; clicking the selected tab need not switch pages.

public event TabContainer.TabHoveredEventHandler TabHovered;

Pointer hovered over the specified tab header. Not page selection or a CurrentTab change notification.

public event TabContainer.TabSelectedEventHandler TabSelected;

Tab selection, including reselection and programmatic CurrentTab. On change arrives before TabChanged and page visibility updates; use TabChanged for completed page switching.