TabContainer

Category: Core

Tabbed Container.

Properties

Methods

Signals

• pre_popup_pressed ( )

Emitted when the ’s Popup button is clicked. See for details.

Emitted when switching to another tab.

• tab_selected ( int tab )

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

Enumerations

enum TabAlign:

• ALIGN_LEFT = 0 — Align the tabs to the left.
• ALIGN_CENTER = 1 — Align the tabs to the center.
• ALIGN_RIGHT = 2 — Align the tabs to the right.

Sets the active tab’s visible property to the value true. Sets all other children’s to false.

Ignores non- children.

To hide only a tab’s content, nest the content inside a child Control, so it receives the TabContainer’s visibility setting instead.

Property Descriptions

• current_tab

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.

• drag_to_rearrange_enabled

If true, tabs can be rearranged with mouse drag.

• TabAlign tab_align

The alignment of all tabs in the tab container. See the constants for details.

• tabs_visible

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

Method Descriptions

• Control get_current_tab_control ( ) const

Returns the child node located at the active tab index.

• Popup get_popup ( ) const

Returns the node instance if one has been set already with set_popup.

Returns the previously active tab index.

• get_tab_control ( int idx ) const

• get_tab_count ( ) const

Returns the number of tabs.

• bool get_tab_disabled ( tab_idx ) const

Returns true if the tab at index tab_idx is disabled.

• Texture get_tab_icon ( tab_idx ) const

Returns the Texture for the tab at index tab_idx or null if the tab has no .

• String get_tab_title ( tab_idx ) const

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 set_tab_title.

• get_tabs_rearrange_group ( ) const

Returns the TabContainer rearrange group id.

• void set_popup ( Node popup )

If set on a node instance, a popup menu icon appears in the top-right corner of the . Clicking it will expand the Popup node.

• void set_tab_disabled ( tab_idx, bool disabled )

If disabled is false, hides the tab at index tab_idx. Note that its title text will remain, unless also removed with .

• void set_tab_icon ( int tab_idx, icon )

Sets an icon for the tab at index tab_idx.

• void set_tab_title ( int tab_idx, title )

Defines rearrange group id, choose for each TabContainer the same value to enable tab drag between TabContainer. Enable drag with set_drag_to_rearrange_enabled(true).