Table of Contents

Class TabContainer

A container that creates a tab for each child control, displaying only the active tab's control.

Inheritance
TabContainer

Remarks

Arranges child controls into a tabbed view, creating a tab for each one. The active tab's corresponding control is made visible, while all other child controls are hidden. Ignores non-control children.

Note: The drawing of the clickable tabs is handled by this node; TabBar is not needed.

See Also

Using Containers

Properties

all_tabs_in_front

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

var all_tabs_in_front : bool = false

Property Value

bool

Remarks

  • void set_all_tabs_in_front(bool value)
  • bool is_all_tabs_in_front

clip_tabs

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 clip_tabs : bool = true

Property Value

bool

Remarks

  • void set_clip_tabs(bool value)
  • bool get_clip_tabs

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.

A value of -1 means that no tab is selected.

var current_tab : int = -1

Property Value

int

Remarks

  • void set_current_tab(int value)
  • int get_current_tab

deselect_enabled

If true, all tabs can be deselected so that no tab is selected. Click on the current_tab to deselect it.

Only the tab header will be shown if no tabs are selected.

var deselect_enabled : bool = false

Property Value

bool

Remarks

  • void set_deselect_enabled(bool value)
  • bool get_deselect_enabled

drag_to_rearrange_enabled

If true, tabs can be rearranged with mouse drag.

var drag_to_rearrange_enabled : bool = false

Property Value

bool

Remarks

  • void set_drag_to_rearrange_enabled(bool value)
  • bool get_drag_to_rearrange_enabled

tab_alignment

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

var tab_alignment : int = 0

Property Value

int

Remarks

  • void set_tab_alignment(int value)
  • int get_tab_alignment

tab_focus_mode

The focus access mode for the internal TabBar node.

var tab_focus_mode : int = 2

Property Value

int

Remarks

  • void set_tab_focus_mode(int value)
  • int get_tab_focus_mode

tabs_position

Sets the position of the tab bar. See TabPosition for details.

var tabs_position : int = 0

Property Value

int

Remarks

  • void set_tabs_position(int value)
  • int get_tabs_position

tabs_rearrange_group

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

Setting this to -1 will disable rearranging between TabContainers.

var tabs_rearrange_group : int = -1

Property Value

int

Remarks

  • void set_tabs_rearrange_group(int value)
  • int get_tabs_rearrange_group

tabs_visible

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

var tabs_visible : bool = true

Property Value

bool

Remarks

  • void set_tabs_visible(bool value)
  • bool are_tabs_visible

use_hidden_tabs_for_min_size

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

var use_hidden_tabs_for_min_size : bool = false

Property Value

bool

Remarks

  • void set_use_hidden_tabs_for_min_size(bool value)
  • bool get_use_hidden_tabs_for_min_size

drop_mark_color

Theme Property

Modulation color for the drop_mark icon.

 = ``Color(1, 1, 1, 1)``

Property Value

Color

font_disabled_color

Theme Property

Font color of disabled tabs.

 = ``Color(0.875, 0.875, 0.875, 0.5)``

Property Value

Color

font_hovered_color

Theme Property

Font color of the currently hovered tab.

 = ``Color(0.95, 0.95, 0.95, 1)``

Property Value

Color

font_outline_color

Theme Property

The tint of text outline of the tab name.

 = ``Color(0, 0, 0, 1)``

Property Value

Color

font_selected_color

Theme Property

Font color of the currently selected tab.

 = ``Color(0.95, 0.95, 0.95, 1)``

Property Value

Color

font_unselected_color

Theme Property

Font color of the other, unselected tabs.

 = ``Color(0.7, 0.7, 0.7, 1)``

Property Value

Color

icon_max_width

Theme Property

The maximum allowed width of the tab's icon. This limit is applied on top of the default size of the icon, but before the value set with TabBar.set_tab_icon_max_width. The height is adjusted according to the icon's ratio.

 = ``0``

Property Value

int

icon_separation

Theme Property

Space between tab's name and its icon.

 = ``4``

Property Value

int

outline_size

Theme Property

The size of the tab text outline.

Note: If using a font with multichannel_signed_distance_field enabled, its msdf_pixel_range must be set to at least twice the value of outline_size for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended.

 = ``0``

Property Value

int

side_margin

Theme Property

The space at the left or right edges of the tab bar, accordingly with the current tab_alignment.

The margin is ignored with TabBar.ALIGNMENT_RIGHT if the tabs are clipped (see clip_tabs) or a popup has been set (see TabContainer.set_popup). The margin is always ignored with TabBar.ALIGNMENT_CENTER.

 = ``8``

Property Value

int

font

Theme Property

The font used to draw tab names.

Font font

Property Value

Font

font_size

Theme Property

Font size of the tab names.

int font_size

Property Value

int

decrement

Theme Property

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.

Texture2D decrement

Property Value

Texture2D

decrement_highlight

Theme Property

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.

Texture2D decrement_highlight

Property Value

Texture2D

drop_mark

Theme Property

Icon shown to indicate where a dragged tab is gonna be dropped (see drag_to_rearrange_enabled).

Texture2D drop_mark

Property Value

Texture2D

increment

Theme Property

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.

Texture2D increment

Property Value

Texture2D

increment_highlight

Theme Property

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.

Texture2D increment_highlight

Property Value

Texture2D

menu

Theme Property

The icon for the menu button (see TabContainer.set_popup).

Texture2D menu

Property Value

Texture2D

menu_highlight

Theme Property

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

Texture2D menu_highlight

Property Value

Texture2D

panel

Theme Property

The style for the background fill.

StyleBox panel

Property Value

StyleBox

tab_disabled

Theme Property

The style of disabled tabs.

StyleBox tab_disabled

Property Value

StyleBox

tab_focus

Theme Property

StyleBox used when the TabBar is focused. The tab_focus StyleBox is displayed over the base StyleBox of the selected tab, so a partially transparent StyleBox should be used to ensure the base StyleBox remains visible. A StyleBox that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a StyleBoxEmpty resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons.

StyleBox tab_focus

Property Value

StyleBox

tab_hovered

Theme Property

The style of the currently hovered tab.

Note: This style will be drawn with the same width as tab_unselected at minimum.

StyleBox tab_hovered

Property Value

StyleBox

tab_selected

Theme Property

The style of the currently selected tab.

StyleBox tab_selected

Property Value

StyleBox

tab_unselected

Theme Property

The style of the other, unselected tabs.

StyleBox tab_unselected

Property Value

StyleBox

tabbar_background

Theme Property

The style for the background fill of the TabBar area.

StyleBox tabbar_background

Property Value

StyleBox

Methods

get_current_tab_control

Qualifiers: const

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

Control get_current_tab_control

get_popup

Qualifiers: const

Returns the Popup node instance if one has been set already with TabContainer.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 visible property.

Popup get_popup

get_previous_tab

Qualifiers: const

Returns the previously active tab index.

int get_previous_tab

get_tab_bar

Qualifiers: const

Returns the TabBar contained in this container.

Warning: This is a required internal node, removing and freeing it or editing its tabs may cause a crash. If you wish to edit the tabs, use the methods provided in TabContainer.

TabBar get_tab_bar

get_tab_button_icon(int)

Qualifiers: const

Returns the button icon from the tab at index tab_idx.

Texture2D get_tab_button_icon(int tab_idx)

Parameters

tab_idx int

get_tab_control(int)

Qualifiers: const

Returns the Control node from the tab at index tab_idx.

Control get_tab_control(int tab_idx)

Parameters

tab_idx int

get_tab_count

Qualifiers: const

Returns the number of tabs.

int get_tab_count

get_tab_icon(int)

Qualifiers: const

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

Texture2D get_tab_icon(int tab_idx)

Parameters

tab_idx int

get_tab_icon_max_width(int)

Qualifiers: const

Returns the maximum allowed width of the icon for the tab at index tab_idx.

int get_tab_icon_max_width(int tab_idx)

Parameters

tab_idx int

get_tab_idx_at_point(Vector2)

Qualifiers: 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.

int get_tab_idx_at_point(Vector2 point)

Parameters

point Vector2

get_tab_idx_from_control(Control)

Qualifiers: const

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

int get_tab_idx_from_control(Control control)

Parameters

control Control

get_tab_metadata(int)

Qualifiers: const

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

Variant get_tab_metadata(int tab_idx)

Parameters

tab_idx int

get_tab_title(int)

Qualifiers: 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 TabContainer.set_tab_title.

String get_tab_title(int tab_idx)

Parameters

tab_idx int

get_tab_tooltip(int)

Qualifiers: const

Returns the tooltip text of the tab at index tab_idx.

String get_tab_tooltip(int tab_idx)

Parameters

tab_idx int

is_tab_disabled(int)

Qualifiers: const

Returns true if the tab at index tab_idx is disabled.

bool is_tab_disabled(int tab_idx)

Parameters

tab_idx int

is_tab_hidden(int)

Qualifiers: const

Returns true if the tab at index tab_idx is hidden.

bool is_tab_hidden(int tab_idx)

Parameters

tab_idx int

select_next_available

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

bool select_next_available

select_previous_available

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

bool select_previous_available

set_popup(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.

void set_popup(Node popup)

Parameters

popup Node

set_tab_button_icon(int, Texture2D)

Sets the button icon from the tab at index tab_idx.

void set_tab_button_icon(int tab_idx, Texture2D icon)

Parameters

tab_idx int
icon Texture2D

set_tab_disabled(int, bool)

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

void set_tab_disabled(int tab_idx, bool disabled)

Parameters

tab_idx int
disabled bool

set_tab_hidden(int, bool)

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

void set_tab_hidden(int tab_idx, bool hidden)

Parameters

tab_idx int
hidden bool

set_tab_icon(int, Texture2D)

Sets an icon for the tab at index tab_idx.

void set_tab_icon(int tab_idx, Texture2D icon)

Parameters

tab_idx int
icon Texture2D

set_tab_icon_max_width(int, int)

Sets the maximum allowed width of the icon for the tab at index tab_idx. This limit is applied on top of the default size of the icon and on top of icon_max_width. The height is adjusted according to the icon's ratio.

void set_tab_icon_max_width(int tab_idx, int width)

Parameters

tab_idx int
width int

set_tab_metadata(int, Variant)

Sets the metadata value for the tab at index tab_idx, which can be retrieved later using TabContainer.get_tab_metadata.

void set_tab_metadata(int tab_idx, Variant metadata)

Parameters

tab_idx int
metadata Variant

set_tab_title(int, String)

Sets a custom title for the tab at index tab_idx (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.

void set_tab_title(int tab_idx, String title)

Parameters

tab_idx int
title String

set_tab_tooltip(int, String)

Sets a custom tooltip text for tab at index tab_idx.

Note: By default, if the tooltip is empty and the tab text is truncated (not all characters fit into the tab), the title will be displayed as a tooltip. To hide the tooltip, assign " " as the tooltip text.

void set_tab_tooltip(int tab_idx, String tooltip)

Parameters

tab_idx int
tooltip String

Events

active_tab_rearranged(int)

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

signal active_tab_rearranged(int idx_to)

Parameters

idx_to int

pre_popup_pressed

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

signal pre_popup_pressed

tab_button_pressed(int)

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

signal tab_button_pressed(int tab)

Parameters

tab int

tab_changed(int)

Emitted when switching to another tab.

signal tab_changed(int tab)

Parameters

tab int

tab_clicked(int)

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

signal tab_clicked(int tab)

Parameters

tab int

tab_hovered(int)

Emitted when a tab is hovered by the mouse.

signal tab_hovered(int tab)

Parameters

tab int

tab_selected(int)

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

signal tab_selected(int tab)

Parameters

tab int