TabContainer

Inherits: Container < Control < CanvasItem < Node < Object

Tabbed container.

Description

Arranges Control children into a tabbed view, creating a tab for each one. The active tab's corresponding Control has its visible property set to true, and all other children's to false.

Ignores non-Control children.

Note: The drawing of the clickable tabs themselves is handled by this node. Adding Tabs as children is not needed.

Tutorials

Properties

bool

all_tabs_in_front

false

int

current_tab

0

bool

drag_to_rearrange_enabled

false

TabAlign

tab_align

1

bool

tabs_visible

true

bool

use_hidden_tabs_for_min_size

false

Methods

Control

get_current_tab_control ( ) const

Popup

get_popup ( ) const

int

get_previous_tab ( ) const

Control

get_tab_control ( int tab_idx ) const

int

get_tab_count ( ) const

bool

get_tab_disabled ( int tab_idx ) const

bool

get_tab_hidden ( int tab_idx ) const

Texture

get_tab_icon ( int tab_idx ) const

int

get_tab_idx_at_point ( Vector2 point ) const

Variant

get_tab_metadata ( int tab_idx ) const

String

get_tab_title ( int tab_idx ) const

int

get_tabs_rearrange_group ( ) const

void

set_popup ( Node popup )

void

set_tab_disabled ( int tab_idx, bool disabled )

void

set_tab_hidden ( int tab_idx, bool hidden )

void

set_tab_icon ( int tab_idx, Texture icon )

void

set_tab_metadata ( int tab_idx, Variant metadata )

void

set_tab_title ( int tab_idx, String title )

void

set_tabs_rearrange_group ( int group_id )

Theme Properties

Color

font_color_bg

Color( 0.69, 0.69, 0.69, 1 )

Color

font_color_disabled

Color( 0.9, 0.9, 0.9, 0.2 )

Color

font_color_fg

Color( 0.94, 0.94, 0.94, 1 )

int

hseparation

4

int

label_valign_bg

2

int

label_valign_fg

0

int

side_margin

8

int

top_margin

24

Font

font

Texture

decrement

Texture

decrement_highlight

Texture

increment

Texture

increment_highlight

Texture

menu

Texture

menu_highlight

StyleBox

panel

StyleBox

tab_bg

StyleBox

tab_disabled

StyleBox

tab_fg

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.

Enumerations

enum TabAlign:

TabAlign ALIGN_LEFT = 0

Align the tabs to the left.

TabAlign ALIGN_CENTER = 1

Align the tabs to the center.

TabAlign ALIGN_RIGHT = 2

Align the tabs to the right.

Property Descriptions

bool all_tabs_in_front = false

  • void set_all_tabs_in_front ( bool value )

  • bool is_all_tabs_in_front ( )

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

int current_tab = 0

  • void set_current_tab ( int value )

  • int 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.

bool drag_to_rearrange_enabled = false

  • void set_drag_to_rearrange_enabled ( bool value )

  • bool get_drag_to_rearrange_enabled ( )

If true, tabs can be rearranged with mouse drag.

TabAlign tab_align = 1

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

bool tabs_visible = true

  • void set_tabs_visible ( bool value )

  • bool are_tabs_visible ( )

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

bool use_hidden_tabs_for_min_size = false

  • void set_use_hidden_tabs_for_min_size ( bool value )

  • bool 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

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.

Warning: This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their CanvasItem.visible property.

int get_previous_tab ( ) const

Returns the previously active tab index.

Control get_tab_control ( int tab_idx ) const

Returns the Control node from the tab at index tab_idx.

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.

bool get_tab_hidden ( int tab_idx ) const

Returns true if the tab at index tab_idx is hidden.

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.

int get_tab_idx_at_point ( Vector2 point ) const

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.

Variant get_tab_metadata ( int tab_idx ) const

Returns the metadata value set to the tab at index tab_idx. If no metadata was previously set, returns null by default.

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.

int get_tabs_rearrange_group ( ) const

Returns the TabContainer rearrange group id.

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 true, disables the tab at index tab_idx, making it non-interactable.

void set_tab_hidden ( int tab_idx, bool hidden )

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

void set_tab_icon ( int tab_idx, Texture icon )

Sets an icon for the tab at index tab_idx.

void set_tab_metadata ( int tab_idx, Variant metadata )

Sets the metadata value 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.

void set_tabs_rearrange_group ( int group_id )

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

Theme Property Descriptions

Color font_color_bg = Color( 0.69, 0.69, 0.69, 1 )

Font color of inactive tabs.

Color font_color_disabled = Color( 0.9, 0.9, 0.9, 0.2 )

Font color of disabled tabs.

Color font_color_fg = Color( 0.94, 0.94, 0.94, 1 )

Font color of the currently selected tab.

int hseparation = 4

Horizontal separation between tabs.

int label_valign_bg = 2

There is currently no description for this theme property. Please help us by contributing one!

int label_valign_fg = 0

There is currently no description for this theme property. Please help us by contributing one!

int side_margin = 8

The space at the left and right edges of the tab bar.

int top_margin = 24

There is currently no description for this theme property. Please help us by contributing one!

Font font

The font used to draw tab names.

Texture decrement

Icon for the left arrow button that appears when there are too many tabs to fit in the container width. When the button is disabled (i.e. the first tab is visible), it appears semi-transparent.

Texture decrement_highlight

Icon for the left arrow button that appears when there are too many tabs to fit in the container width. Used when the button is being hovered with the cursor.

Texture increment

Icon for the right arrow button that appears when there are too many tabs to fit in the container width. When the button is disabled (i.e. the last tab is visible) it appears semi-transparent.

Texture increment_highlight

Icon for the right arrow button that appears when there are too many tabs to fit in the container width. Used when the button is being hovered with the cursor.

Texture menu

The icon for the menu button (see set_popup).

Texture menu_highlight

The icon for the menu button (see set_popup) when it's being hovered with the cursor.

StyleBox panel

The style for the background fill.

StyleBox tab_bg

The style of inactive tabs.

StyleBox tab_disabled

The style of disabled tabs.

StyleBox tab_fg

The style of the currently selected tab.