godot-docs/classes/class_tabs.rst

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the Tabs.xml source instead.
.. The source is found in doc/classes or modules/<name>/doc_classes.

.. _class_Tabs:

Tabs
====

**Inherits:** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`

**Category:** Core

Brief Description
-----------------

Tabs Control.

Member Functions
----------------

+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`add_tab<class_Tabs_add_tab>` **(** :ref:`String<class_string>` title="", :ref:`Texture<class_texture>` icon=null **)**     |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`ensure_tab_visible<class_Tabs_ensure_tab_visible>` **(** :ref:`int<class_int>` idx **)**                                   |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`        | :ref:`get_offset_buttons_visible<class_Tabs_get_offset_buttons_visible>` **(** **)** const                                       |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`          | :ref:`get_tab_count<class_Tabs_get_tab_count>` **(** **)** const                                                                 |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>`        | :ref:`get_tab_disabled<class_Tabs_get_tab_disabled>` **(** :ref:`int<class_int>` tab_idx **)** const                             |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>`  | :ref:`get_tab_icon<class_Tabs_get_tab_icon>` **(** :ref:`int<class_int>` tab_idx **)** const                                     |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`          | :ref:`get_tab_offset<class_Tabs_get_tab_offset>` **(** **)** const                                                               |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Rect2<class_rect2>`      | :ref:`get_tab_rect<class_Tabs_get_tab_rect>` **(** :ref:`int<class_int>` tab_idx **)** const                                     |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>`    | :ref:`get_tab_title<class_Tabs_get_tab_title>` **(** :ref:`int<class_int>` tab_idx **)** const                                   |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>`          | :ref:`get_tabs_rearrange_group<class_Tabs_get_tabs_rearrange_group>` **(** **)** const                                           |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`move_tab<class_Tabs_move_tab>` **(** :ref:`int<class_int>` from, :ref:`int<class_int>` to **)**                            |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`remove_tab<class_Tabs_remove_tab>` **(** :ref:`int<class_int>` tab_idx **)**                                               |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_tab_disabled<class_Tabs_set_tab_disabled>` **(** :ref:`int<class_int>` tab_idx, :ref:`bool<class_bool>` disabled **)** |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_tab_icon<class_Tabs_set_tab_icon>` **(** :ref:`int<class_int>` tab_idx, :ref:`Texture<class_texture>` icon **)**       |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_tab_title<class_Tabs_set_tab_title>` **(** :ref:`int<class_int>` tab_idx, :ref:`String<class_string>` title **)**      |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+
| void                           | :ref:`set_tabs_rearrange_group<class_Tabs_set_tabs_rearrange_group>` **(** :ref:`int<class_int>` group_id **)**                  |
+--------------------------------+----------------------------------------------------------------------------------------------------------------------------------+

Signals
-------

.. _class_Tabs_reposition_active_tab_request:

- **reposition_active_tab_request** **(** :ref:`int<class_int>` idx_to **)**

.. _class_Tabs_right_button_pressed:

- **right_button_pressed** **(** :ref:`int<class_int>` tab **)**

.. _class_Tabs_tab_changed:

- **tab_changed** **(** :ref:`int<class_int>` tab **)**

.. _class_Tabs_tab_clicked:

- **tab_clicked** **(** :ref:`int<class_int>` tab **)**

.. _class_Tabs_tab_close:

- **tab_close** **(** :ref:`int<class_int>` tab **)**

.. _class_Tabs_tab_hover:

- **tab_hover** **(** :ref:`int<class_int>` tab **)**


Member Variables
----------------

  .. _class_Tabs_current_tab:

- :ref:`int<class_int>` **current_tab**

  .. _class_Tabs_drag_to_rearrange_enabled:

- :ref:`bool<class_bool>` **drag_to_rearrange_enabled**

  .. _class_Tabs_scrolling_enabled:

- :ref:`bool<class_bool>` **scrolling_enabled**

  .. _class_Tabs_tab_align:

- :ref:`TabAlign<enum_tabs_tabalign>` **tab_align**

  .. _class_Tabs_tab_close_display_policy:

- :ref:`CloseButtonDisplayPolicy<enum_tabs_closebuttondisplaypolicy>` **tab_close_display_policy**


Enums
-----

  .. _enum_Tabs_CloseButtonDisplayPolicy:

enum **CloseButtonDisplayPolicy**

- **CLOSE_BUTTON_SHOW_NEVER** = **0**
- **CLOSE_BUTTON_SHOW_ACTIVE_ONLY** = **1**
- **CLOSE_BUTTON_SHOW_ALWAYS** = **2**
- **CLOSE_BUTTON_MAX** = **3**

  .. _enum_Tabs_TabAlign:

enum **TabAlign**

- **ALIGN_LEFT** = **0**
- **ALIGN_CENTER** = **1**
- **ALIGN_RIGHT** = **2**
- **ALIGN_MAX** = **3**


Description
-----------

Simple tabs control, similar to :ref:`TabContainer<class_tabcontainer>` but is only in charge of drawing tabs, not interact with children.

Member Function Description
---------------------------

.. _class_Tabs_add_tab:

- void **add_tab** **(** :ref:`String<class_string>` title="", :ref:`Texture<class_texture>` icon=null **)**

.. _class_Tabs_ensure_tab_visible:

- void **ensure_tab_visible** **(** :ref:`int<class_int>` idx **)**

.. _class_Tabs_get_offset_buttons_visible:

- :ref:`bool<class_bool>` **get_offset_buttons_visible** **(** **)** const

.. _class_Tabs_get_tab_count:

- :ref:`int<class_int>` **get_tab_count** **(** **)** const

.. _class_Tabs_get_tab_disabled:

- :ref:`bool<class_bool>` **get_tab_disabled** **(** :ref:`int<class_int>` tab_idx **)** const

.. _class_Tabs_get_tab_icon:

- :ref:`Texture<class_texture>` **get_tab_icon** **(** :ref:`int<class_int>` tab_idx **)** const

.. _class_Tabs_get_tab_offset:

- :ref:`int<class_int>` **get_tab_offset** **(** **)** const

.. _class_Tabs_get_tab_rect:

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

.. _class_Tabs_get_tab_title:

- :ref:`String<class_string>` **get_tab_title** **(** :ref:`int<class_int>` tab_idx **)** const

.. _class_Tabs_get_tabs_rearrange_group:

- :ref:`int<class_int>` **get_tabs_rearrange_group** **(** **)** const

.. _class_Tabs_move_tab:

- void **move_tab** **(** :ref:`int<class_int>` from, :ref:`int<class_int>` to **)**

Rearrange tab.

.. _class_Tabs_remove_tab:

- void **remove_tab** **(** :ref:`int<class_int>` tab_idx **)**

.. _class_Tabs_set_tab_disabled:

- void **set_tab_disabled** **(** :ref:`int<class_int>` tab_idx, :ref:`bool<class_bool>` disabled **)**

.. _class_Tabs_set_tab_icon:

- void **set_tab_icon** **(** :ref:`int<class_int>` tab_idx, :ref:`Texture<class_texture>` icon **)**

.. _class_Tabs_set_tab_title:

- void **set_tab_title** **(** :ref:`int<class_int>` tab_idx, :ref:`String<class_string>` title **)**

.. _class_Tabs_set_tabs_rearrange_group:

- void **set_tabs_rearrange_group** **(** :ref:`int<class_int>` group_id **)**