Tabs

Inherits: Control < CanvasItem < Node < Object

Tabs control.

Description

Simple tabs control, similar to TabContainer but is only in charge of drawing tabs, not interacting with children.

Properties

Methods

Theme Properties

Signals

• reposition_active_tab_request ( int idx_to )

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

• right_button_pressed ( int tab )

Emitted when a tab is right-clicked.

• 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 ( int tab )

Emitted when a tab is closed.

• tab_hover ( int tab )

Emitted when a tab is hovered by the mouse.

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.
• ALIGN_MAX = 3 —- Represents the size of the TabAlign enum.

enum CloseButtonDisplayPolicy:

• 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

• int current_tab

Select tab at index tab_idx.

• bool drag_to_rearrange_enabled

If true, tabs can be rearranged with mouse drag.

• bool scrolling_enabled

if true, the mouse’s scroll wheel cab be used to navigate the scroll view.

• TabAlign tab_align

The alignment of all tabs. See TabAlign for details.

• CloseButtonDisplayPolicy tab_close_display_policy

Sets when the close button will appear on the tabs. See CloseButtonDisplayPolicy for details.

Method Descriptions

• void add_tab ( String title=””, Texture icon=null )

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.

• bool get_select_with_rmb ( ) const

Returns true if select with right mouse button is enabled.

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

• 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_offset ( ) const

Returns the number of hidden tabs offsetted to the left.

• Rect2 get_tab_rect ( int tab_idx ) const

Returns tab Rect2 with local position and size.

• 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 Tabs‘ rearrange group ID.

• void move_tab ( int from, int to )

Moves a tab from from to to.

• void remove_tab ( int tab_idx )

Removes the tab at index tab_idx.

• void set_select_with_rmb ( bool enabled )

If true, enables selecting a tab with the right mouse button.

• void set_tab_disabled ( int tab_idx, bool disabled )

If disabled is false, hides the tab at index tab_idx.

Note: Its title text will remain unless it is also removed with set_tab_title.

• void set_tab_icon ( int tab_idx, Texture icon )

Sets an icon 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.

• void set_tabs_rearrange_group ( int group_id )

Defines the rearrange group ID. Choose for each Tabs the same value to dragging tabs between Tabs. Enable drag with set_drag_to_rearrange_enabled(true).