TabContainer

Inherits: Control < CanvasItem < Node < Object

Category: Core

Brief Description

Tabbed Container.

Member Functions

Control	get_current_tab_control ( ) const
Popup	get_popup ( ) const
int	get_previous_tab ( ) const
Control	get_tab_control ( int idx ) const
int	get_tab_count ( ) const
bool	get_tab_disabled ( int tab_idx ) const
Texture	get_tab_icon ( int tab_idx ) const
String	get_tab_title ( int tab_idx ) const
void	set_popup ( Node popup )
void	set_tab_disabled ( int tab_idx, bool disabled )
void	set_tab_icon ( int tab_idx, Texture icon )
void	set_tab_title ( int tab_idx, String title )

Signals

• pre_popup_pressed ( )

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

• tab_changed ( int tab )

Emitted when switching to another tab.

• tab_selected ( int tab )

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

Member Variables

• int 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.
• TabAlign tab_align - The alignment of all tabs in the tab container. See the ALIGN_* constants for details.
• bool tabs_visible - If true tabs are visible. If false tabs’ content and titles are hidden. Default value: true.

Enums

enum TabAlign

• ALIGN_LEFT = 0
• ALIGN_CENTER = 1
• ALIGN_RIGHT = 2

Description

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

Ignores non-Control children.

Individual tabs are always visible unless you use set_tab_disabled and set_tab_title to hide it.

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

Member Function Description

• Control get_current_tab_control ( ) const

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

• Popup get_popup ( ) const

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

• int get_previous_tab ( ) const

Returns the previously active tab index.

• Control get_tab_control ( int idx ) const

Returns the currently visible tab’s Control node.

• int get_tab_count ( ) const

Returns the number of tabs.

• bool get_tab_disabled ( int tab_idx ) const

Returns true if the tab at index tab_idx is disabled.

• Texture get_tab_icon ( int tab_idx ) const

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

• String get_tab_title ( int 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.

• void set_popup ( Node popup )

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

• void set_tab_disabled ( int 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 set_tab_title.

• void set_tab_icon ( int tab_idx, Texture icon )

Sets an icon for the tab at index tab_idx.

• void set_tab_title ( int tab_idx, String title )

Sets a title for 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.