TabBar¶
Inherits: Control < CanvasItem < Node < Object
Tab bar control.
Description¶
Simple tabs control, similar to TabContainer but is only in charge of drawing tabs, not interacting with children.
Properties¶
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
Methods¶
void |
|
void |
ensure_tab_visible ( int idx ) |
get_offset_buttons_visible ( ) const |
|
get_previous_tab ( ) const |
|
get_tab_button_icon ( int tab_idx ) const |
|
get_tab_icon ( int tab_idx ) const |
|
get_tab_idx_at_point ( Vector2 point ) const |
|
get_tab_language ( int tab_idx ) const |
|
get_tab_offset ( ) const |
|
get_tab_rect ( int tab_idx ) const |
|
get_tab_text_direction ( int tab_idx ) const |
|
get_tab_title ( int tab_idx ) const |
|
is_tab_disabled ( int tab_idx ) const |
|
is_tab_hidden ( int tab_idx ) const |
|
void |
|
void |
remove_tab ( int tab_idx ) |
void |
set_tab_button_icon ( int tab_idx, Texture2D icon ) |
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_language ( int tab_idx, String language ) |
void |
set_tab_text_direction ( int tab_idx, TextDirection direction ) |
void |
set_tab_title ( int tab_idx, String title ) |
Theme Properties¶
|
||
|
||
|
||
|
||
|
||
|
||
|
||
Signals¶
active_tab_rearranged ( int idx_to )
Emitted when the active tab is rearranged via mouse drag. See drag_to_rearrange_enabled.
tab_button_pressed ( int tab )
Emitted when a tab's right button is pressed. See set_tab_button_icon.
tab_changed ( int tab )
Emitted when switching to another tab.
tab_clicked ( int tab )
Emitted when a tab is clicked, even if it is the current tab.
tab_close_pressed ( int tab )
Emitted when a tab's close button is pressed.
Note: Tabs are not removed automatically once the close button is pressed, this behavior needs to be programmed manually. For example:
$TabBar.tab_close_pressed.connect($TabBar.remove_tab)
GetNode<TabBar>("TabBar").TabClosePressed += GetNode<TabBar>("TabBar").RemoveTab;
tab_hovered ( int tab )
Emitted when a tab is hovered by the mouse.
tab_rmb_clicked ( int tab )
Emitted when a tab is right-clicked. select_with_rmb must be enabled.
tab_selected ( int tab )
Emitted when a tab is selected via click or script, even if it is the current tab.
Enumerations¶
enum AlignmentMode:
ALIGNMENT_LEFT = 0 --- Places tabs to the left.
ALIGNMENT_CENTER = 1 --- Places tabs in the middle.
ALIGNMENT_RIGHT = 2 --- Places tabs to the right.
ALIGNMENT_MAX = 3 --- Represents the size of the AlignmentMode enum.
CLOSE_BUTTON_SHOW_NEVER = 0 --- Never show the close buttons.
CLOSE_BUTTON_SHOW_ACTIVE_ONLY = 1 --- Only show the close button on the currently active tab.
CLOSE_BUTTON_SHOW_ALWAYS = 2 --- Show the close button on all tabs.
CLOSE_BUTTON_MAX = 3 --- Represents the size of the CloseButtonDisplayPolicy enum.
Property Descriptions¶
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() |
Select tab at index tab_idx.
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.
int max_tab_width
Default |
|
Setter |
set_max_tab_width(value) |
Getter |
get_max_tab_width() |
Sets the maximum width which all tabs should be limited to. Unlimited if set to 0.
bool scroll_to_selected
Default |
|
Setter |
set_scroll_to_selected(value) |
Getter |
get_scroll_to_selected() |
If true, the tab offset will be changed to keep the the currently selected tab visible.
bool scrolling_enabled
Default |
|
Setter |
set_scrolling_enabled(value) |
Getter |
get_scrolling_enabled() |
if true, the mouse's scroll wheel can be used to navigate the scroll view.
bool select_with_rmb
Default |
|
Setter |
set_select_with_rmb(value) |
Getter |
get_select_with_rmb() |
If true, enables selecting a tab with the right mouse button.
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.
CloseButtonDisplayPolicy tab_close_display_policy
Default |
|
Setter |
set_tab_close_display_policy(value) |
Getter |
get_tab_close_display_policy() |
Sets when the close button will appear on the tabs. See CloseButtonDisplayPolicy for details.
int tab_count
Default |
|
Setter |
set_tab_count(value) |
Getter |
get_tab_count() |
The number of tabs currently in the bar.
int tabs_rearrange_group
Default |
|
Setter |
set_tabs_rearrange_group(value) |
Getter |
get_tabs_rearrange_group() |
TabBars 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 TabBars.
Method Descriptions¶
Adds a new tab.
void ensure_tab_visible ( int idx )
Moves the scroll view to make the tab visible.
bool get_offset_buttons_visible ( ) const
Returns true if the offset buttons (the ones that appear when there's not enough space for all tabs) are visible.
int get_previous_tab ( ) const
Returns the previously active tab index.
Returns the Texture2D for the right button of the tab at index tab_idx or null if the button has no Texture2D.
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 tab title language code.
int get_tab_offset ( ) const
Returns the number of hidden tabs offsetted to the left.
Returns tab Rect2 with local position and size.
TextDirection get_tab_text_direction ( int tab_idx ) const
Returns tab title text base writing direction.
Returns the title of the tab at index tab_idx.
Returns true if the tab at index tab_idx is disabled.
Returns true if the tab at index tab_idx is hidden.
Moves a tab from from to to.
void remove_tab ( int tab_idx )
Removes the tab at index tab_idx.
Sets an icon for the button of the tab at index tab_idx (located to the right, before the close button), making it visible and clickable (See tab_button_pressed). Giving it a null value will hide the button.
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 language code of tab title used for line-breaking and text shaping algorithms, if left empty current locale is used instead.
void set_tab_text_direction ( int tab_idx, TextDirection direction )
Sets tab title base writing direction.
Sets a title for the tab at index tab_idx.
Theme Property Descriptions¶
Color drop_mark_color
Default |
|
Modulation color for the drop_mark icon.
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 h_separation
Default |
|
The horizontal separation between the elements inside tabs.
int outline_size
Default |
|
The size of the tab text outline.
Font font
The font used to draw tab names.
int font_size
Font size of the tab names.
Texture2D close
The icon for the close button (see tab_close_display_policy).
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 drop_mark
Icon shown to indicate where a dragged tab is gonna be dropped (see drag_to_rearrange_enabled).
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.
StyleBox button_highlight
Background of the tab and close buttons when they're being hovered with the cursor.
StyleBox button_pressed
Background of the tab and close buttons when it's being pressed.
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.