setTabMetadata(tabIdx:metadata:)

Other members in extension

Types

• class Signal1

  Signal support.

• class Signal2

  Signal support.

• class Signal3

  Signal support.

• class Signal4

  Signal support.

• class Signal5

  Signal support.

• class Signal6

  Signal support.

Type members

• class var godotClassName: StringName

Instance members

• var activeTabRearranged: Signal1

  Emitted when the active tab is rearranged via mouse drag. See dragToRearrangeEnabled.

• var allTabsInFront: Bool

  If true, all tabs are drawn in front of the panel. If false, inactive tabs are drawn behind the panel.

• var clipTabs: Bool

  If true, tabs overflowing this node’s width will be hidden, displaying two navigation buttons instead. Otherwise, this node’s minimum size is updated so that all tabs are visible.

• var currentTab: Int32

  The current tab index. When set, this index’s Control node’s visible property is set to true and all others are set to false.

• var dragToRearrangeEnabled: Bool

  If true, tabs can be rearranged with mouse drag.

• var prePopupPressed: SimpleSignal

  Emitted when the TabContainer’s Popup button is clicked. See setPopup(_:) for details.

• var tabAlignment: TabBar.AlignmentMode

  Sets the position at which tabs will be placed. See TabBar.AlignmentMode for details.

• var tabButtonPressed: Signal6

  Emitted when the user clicks on the button icon on this tab.

• var tabChanged: Signal2

  Emitted when switching to another tab.

• var tabClicked: Signal3

  Emitted when a tab is clicked, even if it is the current tab.

• var tabFocusMode: Control.FocusMode

  The focus access mode for the internal TabBar node.

• var tabHovered: Signal4

  Emitted when a tab is hovered by the mouse.

• var tabSelected: Signal5

  Emitted when a tab is selected via click, directional input, or script, even if it is the current tab.

• var tabsRearrangeGroup: Int32

  TabContainers with the same rearrange group ID will allow dragging the tabs between them. Enable drag with dragToRearrangeEnabled.

• var tabsVisible: Bool

  If true, tabs are visible. If false, tabs’ content and titles are hidden.

• var useHiddenTabsForMinSize: Bool

  If true, children Control nodes that are hidden have their minimum size take into account in the total, instead of only the currently visible one.

• func getCurrentTabControl() -> Control?

  Returns the child Control node located at the active tab index.

• func getPopup() -> Popup?

  Returns the Popup node instance if one has been set already with setPopup(_:).

• func getPreviousTab() -> Int32

  Returns the previously active tab index.

• func getTabBar() -> TabBar?

  Returns the TabBar contained in this container.

• func getTabButtonIcon(tabIdx: Int32) -> Texture2D?

  Returns the button icon from the tab at index tabIdx.

• func getTabControl(tabIdx: Int32) -> Control?

  Returns the Control node from the tab at index tabIdx.

• func getTabCount() -> Int32

  Returns the number of tabs.

• func getTabIcon(tabIdx: Int32) -> Texture2D?

  Returns the Texture2D for the tab at index tabIdx or null if the tab has no Texture2D.

• func getTabIdxAtPoint(Vector2) -> Int32

  Returns the index of the tab at local coordinates point. Returns -1 if the point is outside the control boundaries or if there’s no tab at the queried position.

• func getTabIdxFromControl(Control?) -> Int32

  Returns the index of the tab tied to the given control. The control must be a child of the TabContainer.

• func getTabMetadata(tabIdx: Int32) -> Variant

  Returns the metadata value set to the tab at index tabIdx using setTabMetadata(tabIdx:metadata:). If no metadata was previously set, returns null by default.

• func getTabTitle(tabIdx: Int32) -> String

  Returns the title of the tab at index tabIdx. Tab titles default to the name of the indexed child node, but this can be overridden with setTabTitle(tabIdx:title:).

• func isTabDisabled(tabIdx: Int32) -> Bool

  Returns true if the tab at index tabIdx is disabled.

• func isTabHidden(tabIdx: Int32) -> Bool

  Returns true if the tab at index tabIdx is hidden.

• func selectNextAvailable() -> Bool

  Selects the first available tab with greater index than the currently selected. Returns true if tab selection changed.

• func selectPreviousAvailable() -> Bool

  Selects the first available tab with lower index than the currently selected. Returns true if tab selection changed.

• func setPopup(Node?)

  If set on a Popup node instance, a popup menu icon appears in the top-right corner of the TabContainer (setting it to null will make it go away). Clicking it will expand the Popup node.

• func setTabButtonIcon(tabIdx: Int32, icon: Texture2D?)

  Sets the button icon from the tab at index tabIdx.

• func setTabDisabled(tabIdx: Int32, disabled: Bool)

  If disabled is true, disables the tab at index tabIdx, making it non-interactable.

• func setTabHidden(tabIdx: Int32, hidden: Bool)

  If hidden is true, hides the tab at index tabIdx, making it disappear from the tab area.

• func setTabIcon(tabIdx: Int32, icon: Texture2D?)

  Sets an icon for the tab at index tabIdx.

• func setTabTitle(tabIdx: Int32, title: String)

  Sets a custom title for the tab at index tabIdx (tab titles default to the name of the indexed child node). Set it back to the child’s name to make the tab default to it again.