TabContainer

Tabbed container.

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

Ignores non- children.

Individual tabs are always visible unless you use set_tab_disabled and 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.

Properties

	get_current_tab_control ( ) const
	get_popup ( ) const
	get_previous_tab ( ) const
	get_tab_control ( tab_idx ) const
int	( ) const
bool	( int tab_idx ) const
	get_tab_icon ( tab_idx ) const
String	( int tab_idx ) const
	get_tabs_rearrange_group ( ) const
void	( Node popup )
void	( int tab_idx, disabled )
void	set_tab_icon ( tab_idx, Texture icon )
void	( int tab_idx, title )
void	set_tabs_rearrange_group ( group_id )

Theme Properties

Texture	decrement
	decrement_highlight
Font	font
	font_color_bg	Color( 0.69, 0.69, 0.69, 1 )
Color	font_color_disabled	Color( 0.9, 0.9, 0.9, 0.2 )
	font_color_fg	Color( 0.94, 0.94, 0.94, 1 )
int	hseparation	4
	increment
Texture	increment_highlight
	label_valign_bg	2
int	label_valign_fg	0
	menu
Texture	menu_highlight
	panel
int	side_margin	8
	tab_bg
StyleBox	tab_disabled
	tab_fg
int	top_margin	24

pre_popup_pressed ( )

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

tab_changed ( tab )

Emitted when switching to another 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.

bool all_tabs_in_front

current_tab

Default
Setter	set_current_tab(value)
Getter	get_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

Default	`false`
Setter	set_drag_to_rearrange_enabled(value)
Getter	get_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.

bool tabs_visible

Default	`true`
Setter	set_tabs_visible(value)
Getter	are_tabs_visible()

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

use_hidden_tabs_for_min_size

Default	`false`
Setter	set_use_hidden_tabs_for_min_size(value)
Getter	get_use_hidden_tabs_for_min_size()

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.

Method Descriptions

get_current_tab_control ( ) const

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

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

get_previous_tab ( ) const

Returns the previously active tab index.

Control get_tab_control ( tab_idx ) const

Returns the Control node from the tab at index tab_idx.

get_tab_count ( ) const

bool get_tab_disabled ( tab_idx ) const

Returns true if the tab at index 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 TabContainer. 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: 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.

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.

void set_tabs_rearrange_group ( group_id )