mirror of
https://github.com/godotengine/godot-docs.git
synced 2026-01-05 22:09:56 +03:00
1204e3ea17
To tell potential contributors that they should NOT edit those files but instead should work on the class.xml source of the main Godot repo
150 lines
8.4 KiB
ReStructuredText
150 lines
8.4 KiB
ReStructuredText
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
|
|
|
|
.. _class_TabContainer:
|
|
|
|
TabContainer
|
|
============
|
|
|
|
**Inherits:** :ref:`Control<class_control>` **<** :ref:`CanvasItem<class_canvasitem>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
Tabbed Container.
|
|
|
|
Member Functions
|
|
----------------
|
|
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_tab_count<class_TabContainer_get_tab_count>` **(** **)** const |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_current_tab<class_TabContainer_set_current_tab>` **(** :ref:`int<class_int>` tab_idx **)** |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_current_tab<class_TabContainer_get_current_tab>` **(** **)** const |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Control<class_control>` | :ref:`get_current_tab_control<class_TabContainer_get_current_tab_control>` **(** **)** const |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Control<class_control>` | :ref:`get_tab_control<class_TabContainer_get_tab_control>` **(** :ref:`int<class_int>` idx **)** const |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_tab_align<class_TabContainer_set_tab_align>` **(** :ref:`int<class_int>` align **)** |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`int<class_int>` | :ref:`get_tab_align<class_TabContainer_get_tab_align>` **(** **)** const |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_tabs_visible<class_TabContainer_set_tabs_visible>` **(** :ref:`bool<class_bool>` visible **)** |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`are_tabs_visible<class_TabContainer_are_tabs_visible>` **(** **)** const |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_tab_title<class_TabContainer_set_tab_title>` **(** :ref:`int<class_int>` tab_idx, :ref:`String<class_string>` title **)** |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`String<class_string>` | :ref:`get_tab_title<class_TabContainer_get_tab_title>` **(** :ref:`int<class_int>` tab_idx **)** const |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_tab_icon<class_TabContainer_set_tab_icon>` **(** :ref:`int<class_int>` tab_idx, :ref:`Texture<class_texture>` icon **)** |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Texture<class_texture>` | :ref:`get_tab_icon<class_TabContainer_get_tab_icon>` **(** :ref:`int<class_int>` tab_idx **)** const |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_popup<class_TabContainer_set_popup>` **(** :ref:`Popup<class_popup>` popup **)** |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Popup<class_popup>` | :ref:`get_popup<class_TabContainer_get_popup>` **(** **)** const |
|
|
+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Signals
|
|
-------
|
|
|
|
- **pre_popup_pressed** **(** **)**
|
|
- **tab_changed** **(** :ref:`int<class_int>` tab **)**
|
|
|
|
Description
|
|
-----------
|
|
|
|
Tabbed Container. Contains several children controls, but shows only one at the same time. Clicking on the top tabs allows to change the currently visible one.
|
|
|
|
Children controls of this one automatically.
|
|
|
|
Member Function Description
|
|
---------------------------
|
|
|
|
.. _class_TabContainer_get_tab_count:
|
|
|
|
- :ref:`int<class_int>` **get_tab_count** **(** **)** const
|
|
|
|
Return the amount of tabs.
|
|
|
|
.. _class_TabContainer_set_current_tab:
|
|
|
|
- void **set_current_tab** **(** :ref:`int<class_int>` tab_idx **)**
|
|
|
|
Bring a tab (and the Control it represents) to the front, and hide the rest.
|
|
|
|
.. _class_TabContainer_get_current_tab:
|
|
|
|
- :ref:`int<class_int>` **get_current_tab** **(** **)** const
|
|
|
|
Return the current tab that is being showed.
|
|
|
|
.. _class_TabContainer_get_current_tab_control:
|
|
|
|
- :ref:`Control<class_control>` **get_current_tab_control** **(** **)** const
|
|
|
|
.. _class_TabContainer_get_tab_control:
|
|
|
|
- :ref:`Control<class_control>` **get_tab_control** **(** :ref:`int<class_int>` idx **)** const
|
|
|
|
.. _class_TabContainer_set_tab_align:
|
|
|
|
- void **set_tab_align** **(** :ref:`int<class_int>` align **)**
|
|
|
|
Set tab alignment, from the ALIGN\_\* enum. Moves tabs to the left, right or center.
|
|
|
|
.. _class_TabContainer_get_tab_align:
|
|
|
|
- :ref:`int<class_int>` **get_tab_align** **(** **)** const
|
|
|
|
Return tab alignment, from the ALIGN\_\* enum.
|
|
|
|
.. _class_TabContainer_set_tabs_visible:
|
|
|
|
- void **set_tabs_visible** **(** :ref:`bool<class_bool>` visible **)**
|
|
|
|
Set whether the tabs should be visible or hidden.
|
|
|
|
.. _class_TabContainer_are_tabs_visible:
|
|
|
|
- :ref:`bool<class_bool>` **are_tabs_visible** **(** **)** const
|
|
|
|
Return whether the tabs should be visible or hidden.
|
|
|
|
.. _class_TabContainer_set_tab_title:
|
|
|
|
- void **set_tab_title** **(** :ref:`int<class_int>` tab_idx, :ref:`String<class_string>` title **)**
|
|
|
|
Set a title for the tab. Tab titles are by default the children node name, but this can be overridden.
|
|
|
|
.. _class_TabContainer_get_tab_title:
|
|
|
|
- :ref:`String<class_string>` **get_tab_title** **(** :ref:`int<class_int>` tab_idx **)** const
|
|
|
|
Return the title for the tab. Tab titles are by default the children node name, but this can be overridden.
|
|
|
|
.. _class_TabContainer_set_tab_icon:
|
|
|
|
- void **set_tab_icon** **(** :ref:`int<class_int>` tab_idx, :ref:`Texture<class_texture>` icon **)**
|
|
|
|
Set an icon for a tab.
|
|
|
|
.. _class_TabContainer_get_tab_icon:
|
|
|
|
- :ref:`Texture<class_texture>` **get_tab_icon** **(** :ref:`int<class_int>` tab_idx **)** const
|
|
|
|
.. _class_TabContainer_set_popup:
|
|
|
|
- void **set_popup** **(** :ref:`Popup<class_popup>` popup **)**
|
|
|
|
.. _class_TabContainer_get_popup:
|
|
|
|
- :ref:`Popup<class_popup>` **get_popup** **(** **)** const
|
|
|
|
|