| github_url: | hide |
|---|
Inherits: :ref:`Control<class_Control>` < :ref:`CanvasItem<class_CanvasItem>` < :ref:`Node<class_Node>` < :ref:`Object<class_Object>`
Tabs control.
Simple tabs control, similar to :ref:`TabContainer<class_TabContainer>` but is only in charge of drawing tabs, not interact with children.
| :ref:`StyleBox<class_StyleBox>` | button | |
| :ref:`StyleBox<class_StyleBox>` | button_pressed | |
| :ref:`Texture2D<class_Texture2D>` | close | |
| :ref:`Texture2D<class_Texture2D>` | decrement | |
| :ref:`Texture2D<class_Texture2D>` | decrement_highlight | |
| :ref:`Font<class_Font>` | font | |
| :ref:`Color<class_Color>` | font_color_bg | Color( 0.69, 0.69, 0.69, 1 ) |
| :ref:`Color<class_Color>` | font_color_disabled | Color( 0.9, 0.9, 0.9, 0.2 ) |
| :ref:`Color<class_Color>` | font_color_fg | Color( 0.94, 0.94, 0.94, 1 ) |
| :ref:`int<class_int>` | hseparation | 4 |
| :ref:`Texture2D<class_Texture2D>` | increment | |
| :ref:`Texture2D<class_Texture2D>` | increment_highlight | |
| :ref:`StyleBox<class_StyleBox>` | panel | |
| :ref:`StyleBox<class_StyleBox>` | tab_bg | |
| :ref:`StyleBox<class_StyleBox>` | tab_disabled | |
| :ref:`StyleBox<class_StyleBox>` | tab_fg |
- reposition_active_tab_request ( :ref:`int<class_int>` idx_to )
Emitted when the active tab is rearranged via mouse drag. See :ref:`drag_to_rearrange_enabled<class_Tabs_property_drag_to_rearrange_enabled>`.
Emitted when a tab is right-clicked.
- tab_changed ( :ref:`int<class_int>` tab )
Emitted when switching to another tab.
- tab_clicked ( :ref:`int<class_int>` tab )
Emitted when a tab is clicked, even if it is the current tab.
- tab_close ( :ref:`int<class_int>` tab )
Emitted when a tab is closed.
- tab_hover ( :ref:`int<class_int>` tab )
Emitted when a tab is hovered by the mouse.
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 :ref:`TabAlign<enum_Tabs_TabAlign>` 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 :ref:`CloseButtonDisplayPolicy<enum_Tabs_CloseButtonDisplayPolicy>` enum.
- :ref:`int<class_int>` current_tab
| Default | 0 |
| Setter | set_current_tab(value) |
| Getter | get_current_tab() |
Select tab at index tab_idx.
- :ref:`bool<class_bool>` drag_to_rearrange_enabled
| Default | false |
| Setter | set_drag_to_rearrange_enabled(value) |
| Getter | get_drag_to_rearrange_enabled() |
If true, tabs can be rearranged with mouse drag.
- :ref:`bool<class_bool>` scrolling_enabled
| Default | true |
| Setter | set_scrolling_enabled(value) |
| Getter | get_scrolling_enabled() |
if true, the mouse's scroll wheel cab be used to navigate the scroll view.
- :ref:`TabAlign<enum_Tabs_TabAlign>` tab_align
| Default | 1 |
| Setter | set_tab_align(value) |
| Getter | get_tab_align() |
The alignment of all tabs. See :ref:`TabAlign<enum_Tabs_TabAlign>` for details.
- :ref:`CloseButtonDisplayPolicy<enum_Tabs_CloseButtonDisplayPolicy>` tab_close_display_policy
| Default | 0 |
| Setter | set_tab_close_display_policy(value) |
| Getter | get_tab_close_display_policy() |
Sets when the close button will appear on the tabs. See :ref:`CloseButtonDisplayPolicy<enum_Tabs_CloseButtonDisplayPolicy>` for details.
- void add_tab ( :ref:`String<class_String>` title="", :ref:`Texture2D<class_Texture2D>` icon=null )
Adds a new tab.
- void ensure_tab_visible ( :ref:`int<class_int>` idx )
Moves the scroll view to make the tab visible.
Returns true if the offset buttons (the ones that appear when there's not enough space for all tabs) are visible.
- :ref:`bool<class_bool>` get_select_with_rmb ( ) const
Returns true if select with right mouse button is enabled.
- :ref:`int<class_int>` get_tab_count ( ) const
Returns the number of tabs.
- :ref:`bool<class_bool>` get_tab_disabled ( :ref:`int<class_int>` tab_idx ) const
Returns true if the tab at index tab_idx is disabled.
- :ref:`Texture2D<class_Texture2D>` get_tab_icon ( :ref:`int<class_int>` tab_idx ) const
Returns the :ref:`Texture2D<class_Texture2D>` for the tab at index tab_idx or null if the tab has no :ref:`Texture2D<class_Texture2D>`.
- :ref:`int<class_int>` get_tab_offset ( ) const
Returns the number of hidden tabs offsetted to the left.
- :ref:`Rect2<class_Rect2>` get_tab_rect ( :ref:`int<class_int>` tab_idx ) const
Returns tab :ref:`Rect2<class_Rect2>` with local position and size.
- :ref:`String<class_String>` get_tab_title ( :ref:`int<class_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 :ref:`set_tab_title<class_Tabs_method_set_tab_title>`.
- :ref:`int<class_int>` get_tabs_rearrange_group ( ) const
Returns the Tabs' rearrange group ID.
- void move_tab ( :ref:`int<class_int>` from, :ref:`int<class_int>` to )
Moves a tab from from to to.
- void remove_tab ( :ref:`int<class_int>` tab_idx )
Removes the tab at index tab_idx.
- void set_select_with_rmb ( :ref:`bool<class_bool>` enabled )
If true, enables selecting a tab with the right mouse button.
- void set_tab_disabled ( :ref:`int<class_int>` tab_idx, :ref:`bool<class_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 :ref:`set_tab_title<class_Tabs_method_set_tab_title>`.
- void set_tab_icon ( :ref:`int<class_int>` tab_idx, :ref:`Texture2D<class_Texture2D>` icon )
Sets an icon for the tab at index tab_idx.
- void set_tab_title ( :ref:`int<class_int>` tab_idx, :ref:`String<class_String>` title )
Sets a title for the tab at index tab_idx.
- void set_tabs_rearrange_group ( :ref:`int<class_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).