mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-12-15 10:12:40 +08:00
Code Issues Packages Projects Releases Wiki Activity
8bc96cc146
godot/doc/classes/TabContainer.xml

245 lines
7.2 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name="TabContainer" inherits="Control" category="Core" version="3.0.alpha.custom_build">
<brief_description>
Tabbed Container.
</brief_description>
<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.
</description>
<tutorials>
</tutorials>
<demos>
</demos>
<methods>
<method name="are_tabs_visible" qualifiers="const">
<return type="bool">
</return>
<description>
[DOCS] TabContainer class descriptions
2017-10-13 03:29:43 +08:00
Returns [code]true[/code] if the tabs are visible.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="get_current_tab" qualifiers="const">
<return type="int">
</return>
<description>
[DOCS] TabContainer class descriptions
2017-10-13 03:29:43 +08:00
Returns the current tab index that is being shown.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="get_current_tab_control" qualifiers="const">
<return type="Control">
</return>
<description>
</description>
</method>
<method name="get_popup" qualifiers="const">
<return type="Popup">
</return>
<description>
</description>
</method>
<method name="get_previous_tab" qualifiers="const">
<return type="int">
</return>
<description>
[DOCS] TabContainer class descriptions
2017-10-13 03:29:43 +08:00
Returns the previous tab index that was being shown.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="get_tab_align" qualifiers="const">
<return type="int" enum="TabContainer.TabAlign">
</return>
<description>
[DOCS] TabContainer class descriptions
2017-10-13 03:29:43 +08:00
Returns the tab alignment.See the ALIGN_* constants.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="get_tab_control" qualifiers="const">
<return type="Control">
</return>
<argument index="0" name="idx" type="int">
</argument>
<description>
[DOCS] TabContainer class descriptions
2017-10-13 03:29:43 +08:00
Returns the current tab control that is being shown.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="get_tab_count" qualifiers="const">
<return type="int">
</return>
<description>
[DOCS] TabContainer class descriptions
2017-10-13 03:29:43 +08:00
Returns the amount of tabs.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="get_tab_disabled" qualifiers="const">
<return type="bool">
</return>
<argument index="0" name="tab_idx" type="int">
</argument>
<description>
[DOCS] TabContainer class descriptions
2017-10-13 03:29:43 +08:00
Returns [code]true[/code] if the tab at index [code]tab_idx[/code] is disabled.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="get_tab_icon" qualifiers="const">
<return type="Texture">
</return>
<argument index="0" name="tab_idx" type="int">
</argument>
<description>
[DOCS] TabContainer class descriptions
2017-10-13 03:29:43 +08:00
Returns the [Texture] for the tab at index [code]tab_idx[/code] or null if the tab has no [Texture].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="get_tab_title" qualifiers="const">
<return type="String">
</return>
<argument index="0" name="tab_idx" type="int">
</argument>
<description>
[DOCS] TabContainer class descriptions
2017-10-13 03:29:43 +08:00
Returns the title for the tab at index [code]tab_idx[/code]. Tab titles are by default the children node name, but this can be overridden.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="set_current_tab">
<return type="void">
</return>
<argument index="0" name="tab_idx" type="int">
</argument>
<description>
Bring a tab (and the Control it represents) to the front, and hide the rest.
</description>
</method>
<method name="set_popup">
<return type="void">
</return>
<argument index="0" name="popup" type="Node">
</argument>
<description>
</description>
</method>
<method name="set_tab_align">
<return type="void">
</return>
<argument index="0" name="align" type="int" enum="TabContainer.TabAlign">
</argument>
<description>
Set tab alignment, from the ALIGN_* enum. Moves tabs to the left, right or center.
</description>
</method>
<method name="set_tab_disabled">
<return type="void">
</return>
<argument index="0" name="tab_idx" type="int">
</argument>
<argument index="1" name="disabled" type="bool">
</argument>
<description>
[DOCS] TabContainer class descriptions
2017-10-13 03:29:43 +08:00
Set tab at index [code]tab_idx[/code] disabled.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="set_tab_icon">
<return type="void">
</return>
<argument index="0" name="tab_idx" type="int">
</argument>
<argument index="1" name="icon" type="Texture">
</argument>
<description>
[DOCS] TabContainer class descriptions
2017-10-13 03:29:43 +08:00
Set an icon for a tab at index [code]tab_idx[/code].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="set_tab_title">
<return type="void">
</return>
<argument index="0" name="tab_idx" type="int">
</argument>
<argument index="1" name="title" type="String">
</argument>
<description>
[DOCS] TabContainer class descriptions
2017-10-13 03:29:43 +08:00
Set a title for the tab at index [code]tab_idx[/code]. Tab titles are by default the children node name, but this can be overridden.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
<method name="set_tabs_visible">
<return type="void">
</return>
<argument index="0" name="visible" type="bool">
</argument>
<description>
[DOCS] TabContainer class descriptions
2017-10-13 03:29:43 +08:00
If [code]true[/code] all the tabs will be visible.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</description>
</method>
</methods>
<members>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="current_tab" type="int" setter="set_current_tab" getter="get_current_tab">
[DOCS] TabContainer class descriptions
2017-10-13 03:29:43 +08:00
The current tab.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="tab_align" type="int" setter="set_tab_align" getter="get_tab_align" enum="TabContainer.TabAlign">
[DOCS] TabContainer class descriptions
2017-10-13 03:29:43 +08:00
The alignment of all the tabs of the tab container. See the [code]ALIGN_*[/code] constants.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
doc: Sync classref with current source [ci skip]
2017-09-13 14:49:40 +08:00
<member name="tabs_visible" type="bool" setter="set_tabs_visible" getter="are_tabs_visible">
[DOCS] TabContainer class descriptions
2017-10-13 03:29:43 +08:00
If [code]true[/code] all tabs that are children of the TabContainer will be visible.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</member>
</members>
<signals>
<signal name="pre_popup_pressed">
<description>
</description>
</signal>
<signal name="tab_changed">
<argument index="0" name="tab" type="int">
</argument>
<description>
Emitted only when the current tab changes.
</description>
</signal>
<signal name="tab_selected">
<argument index="0" name="tab" type="int">
</argument>
<description>
Emitted when a tab is being selected, even if it is the same tab.
</description>
</signal>
</signals>
<constants>
doc: Sync classref with current source [ci skip]
2017-09-16 07:46:14 +08:00
<constant name="ALIGN_LEFT" value="0">
</constant>
<constant name="ALIGN_CENTER" value="1">
</constant>
<constant name="ALIGN_RIGHT" value="2">
</constant>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-13 04:42:36 +08:00
</constants>
<theme_items>
<theme_item name="decrement" type="Texture">
</theme_item>
<theme_item name="decrement_highlight" type="Texture">
</theme_item>
<theme_item name="font" type="Font">
</theme_item>
<theme_item name="font_color_bg" type="Color">
</theme_item>
<theme_item name="font_color_disabled" type="Color">
</theme_item>
<theme_item name="font_color_fg" type="Color">
</theme_item>
<theme_item name="hseparation" type="int">
</theme_item>
<theme_item name="increment" type="Texture">
</theme_item>
<theme_item name="increment_highlight" type="Texture">
</theme_item>
<theme_item name="label_valign_bg" type="int">
</theme_item>
<theme_item name="label_valign_fg" type="int">
</theme_item>
<theme_item name="menu" type="Texture">
</theme_item>
<theme_item name="menu_highlight" type="Texture">
</theme_item>
<theme_item name="panel" type="StyleBox">
</theme_item>
<theme_item name="side_margin" type="int">
</theme_item>
<theme_item name="tab_bg" type="StyleBox">
</theme_item>
<theme_item name="tab_fg" type="StyleBox">
</theme_item>
<theme_item name="top_margin" type="int">
</theme_item>
</theme_items>
</class>
Reference in New Issue Copy Permalink