Struct Tabs

Tabs control.

struct Tabs ;

Simple tabs control, similar to TabContainer but is only in charge of drawing tabs, not interact with children.

Properties

NameTypeDescription
currentTab[get, set] longSelect tab at index tab_idx.
dragToRearrangeEnabled[get, set] boolIf true, tabs can be rearranged with mouse drag.
scrollingEnabled[get, set] boolif true, the mouse's scroll wheel cab be used to navigate the scroll view.
tabAlign[get, set] Tabs.TabAlignThe alignment of all tabs. See tabalign for details.
tabCloseDisplayPolicy[get, set] Tabs.CloseButtonDisplayPolicySets when the close button will appear on the tabs. See closebuttondisplaypolicy for details.

Methods

NameDescription
_guiInput
_onMouseExited
_updateHover
addTab Adds a new tab.
ensureTabVisible Moves the scroll view to make the tab visible.
getCurrentTab
getDragToRearrangeEnabled
getOffsetButtonsVisible Returns true if the offset buttons (the ones that appear when there's not enough space for all tabs) are visible.
getScrollingEnabled
getSelectWithRmb Returns true if select with right mouse button is enabled.
getTabAlign
getTabCloseDisplayPolicy
getTabCount Returns the number of tabs.
getTabDisabled Returns true if the tab at index tab_idx is disabled.
getTabIcon Returns the Texture for the tab at index tab_idx or null if the tab has no Texture.
getTabOffset Returns the number of hidden tabs offsetted to the left.
getTabRect Returns tab Rect2 with local position and size.
getTabsRearrangeGroup Returns the Tabs' rearrange group ID.
getTabTitle Returns the title of the tab at index tab_idx. Tab titles default to the name of the indexed child node, but this can be overridden with setTabTitle.
moveTab Moves a tab from from to to.
removeTab Removes the tab at index tab_idx.
setCurrentTab
setDragToRearrangeEnabled
setScrollingEnabled
setSelectWithRmb If true, enables selecting a tab with the right mouse button.
setTabAlign
setTabCloseDisplayPolicy
setTabDisabled If disabled is false, hides the tab at index tab_idx. Note: Its title text will remain unless it is also removed with setTabTitle.
setTabIcon Sets an icon for the tab at index tab_idx.
setTabsRearrangeGroup Defines the rearrange group ID. Choose for each Tabs the same value to dragging tabs between Tabs. Enable drag with set_drag_to_rearrange_enabled(true).
setTabTitle Sets a title for the tab at index tab_idx.

Enums

NameDescription
CloseButtonDisplayPolicy
Constants
TabAlign