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 TabBars as children is not needed.
Properties¶
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
Methods¶
get_current_tab_control ( ) const |
|
get_popup ( ) const |
|
get_previous_tab ( ) const |
|
get_tab_control ( int tab_idx ) const |
|
get_tab_count ( ) const |
|
get_tab_icon ( int tab_idx ) const |
|
get_tab_idx_at_point ( Vector2 point ) const |
|
get_tab_idx_from_control ( Control control ) const |
|
get_tab_title ( int tab_idx ) const |
|
is_tab_disabled ( int tab_idx ) const |
|
is_tab_hidden ( int tab_idx ) const |
|
void |
|
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, Texture2D icon ) |
void |
set_tab_title ( int tab_idx, String title ) |
Theme Properties¶
|
||
|
||
|
||
|
||
|
||
|
||
|
||
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.
Property Descriptions¶
bool all_tabs_in_front
Default |
|
Setter |
set_all_tabs_in_front(value) |
Getter |
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.
bool clip_tabs
Default |
|
Setter |
set_clip_tabs(value) |
Getter |
get_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.
int 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.
bool drag_to_rearrange_enabled
Default |
|
Setter |
set_drag_to_rearrange_enabled(value) |
Getter |
get_drag_to_rearrange_enabled() |
If true, tabs can be rearranged with mouse drag.
AlignmentMode tab_alignment
Default |
|
Setter |
set_tab_alignment(value) |
Getter |
get_tab_alignment() |
Sets the position at which tabs will be placed. See AlignmentMode for details.
int tabs_rearrange_group
Default |
|
Setter |
set_tabs_rearrange_group(value) |
Getter |
get_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.
bool tabs_visible
Default |
|
Setter |
set_tabs_visible(value) |
Getter |
are_tabs_visible() |
If true, tabs are visible. If false, tabs' content and titles are hidden.
Default |
|
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¶
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 Window.visible property.
int get_previous_tab ( ) const
Returns the previously active tab index.
Returns the Control node from the tab at index tab_idx.
int get_tab_count ( ) const
Returns the number of tabs.
Returns the Texture2D for the tab at index tab_idx or null if the tab has no Texture2D.
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.
Returns the index of the tab tied to the given control. The control must be a child of the TabContainer.
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.
Returns true if the tab at index tab_idx is disabled.
Returns true if the tab at index tab_idx is hidden.
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 (setting it to null will make it go away). Clicking it will expand the Popup node.
If disabled is true, disables the tab at index tab_idx, making it non-interactable.
If hidden is true, hides the tab at index tab_idx, making it disappear from the tab area.
Sets an icon for the tab at index tab_idx.
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.
Theme Property Descriptions¶
Color font_disabled_color
Default |
|
Font color of disabled tabs.
Color font_outline_color
Default |
|
The tint of text outline of the tab name.
Color font_selected_color
Default |
|
Font color of the currently selected tab.
Color font_unselected_color
Default |
|
Font color of the other, unselected tabs.
int icon_separation
Default |
|
Space between tab's name and its icon.
int outline_size
Default |
|
The size of the tab text outline.
int side_margin
Default |
|
The space at the left or right edges of the tab bar, accordingly with the current tab_alignment.
The margin is ignored with ALIGNMENT_RIGHT if the tabs are clipped (see clip_tabs) or a popup has been set (see set_popup). The margin is always ignored with ALIGNMENT_CENTER.
Font font
The font used to draw tab names.
int font_size
Font size of the tab names.
Texture2D 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.
Texture2D 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.
Texture2D 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.
Texture2D 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.
The icon for the menu button (see set_popup).
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_disabled
The style of disabled tabs.
StyleBox tab_selected
The style of the currently selected tab.
StyleBox tab_unselected
The style of the other, unselected tabs.