godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doc Tabs 

(cherry picked from commit 3a875d3200)
This commit is contained in:
Alexander Holland 2018-10-15 15:01:10 +02:00 committed by Rémi Verschelde
parent f442bc4b18
commit 8b895dda3e
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/classes/Tabs.xml
View File

@ -19,6 +19,7 @@
<argument index="1" name="icon" type="Texture" default="null"> <argument index="1" name="icon" type="Texture" default="null">
</argument> </argument>
<description> <description>
Adds a new tab.
</description> </description>
</method> </method>
<method name="ensure_tab_visible"> <method name="ensure_tab_visible">
@ -27,6 +28,7 @@
<argument index="0" name="idx" type="int"> <argument index="0" name="idx" type="int">
</argument> </argument>
<description> <description>
Moves the Scroll view to make the tab visible.
</description> </description>
</method> </method>
<method name="get_offset_buttons_visible" qualifiers="const"> <method name="get_offset_buttons_visible" qualifiers="const">
@ -39,6 +41,7 @@
<return type="int"> <return type="int">
</return> </return>
<description> <description>
Returns the number of tabs.
</description> </description>
</method> </method>
<method name="get_tab_disabled" qualifiers="const"> <method name="get_tab_disabled" qualifiers="const">
@ -47,6 +50,7 @@
<argument index="0" name="tab_idx" type="int"> <argument index="0" name="tab_idx" type="int">
</argument> </argument>
<description> <description>
Returns [code]true[/code] if the tab at index [code]tab_idx[/code] is disabled.
</description> </description>
</method> </method>
<method name="get_tab_icon" qualifiers="const"> <method name="get_tab_icon" qualifiers="const">
@ -55,6 +59,7 @@
<argument index="0" name="tab_idx" type="int"> <argument index="0" name="tab_idx" type="int">
</argument> </argument>
<description> <description>
Returns the [Texture] for the tab at index [code]tab_idx[/code] or null if the tab has no [Texture].
</description> </description>
</method> </method>
<method name="get_tab_offset" qualifiers="const"> <method name="get_tab_offset" qualifiers="const">
@ -78,6 +83,7 @@
<argument index="0" name="tab_idx" type="int"> <argument index="0" name="tab_idx" type="int">
</argument> </argument>
<description> <description>
Returns the title of the tab at index [code]tab_idx[/code]. Tab titles default to the name of the indexed child node, but this can be overridden with [method set_tab_title].
</description> </description>
</method> </method>
<method name="move_tab"> <method name="move_tab">
@ -97,6 +103,7 @@
<argument index="0" name="tab_idx" type="int"> <argument index="0" name="tab_idx" type="int">
</argument> </argument>
<description> <description>
Removes tab at index [code]tab_idx[/code]
</description> </description>
</method> </method>
<method name="set_tab_disabled"> <method name="set_tab_disabled">
@ -107,6 +114,7 @@
<argument index="1" name="disabled" type="bool"> <argument index="1" name="disabled" type="bool">
</argument> </argument>
<description> <description>
If [code]disabled[/code] is false, hides the tab at index [code]tab_idx[/code]. Note that its title text will remain, unless also removed with [method set_tab_title].
</description> </description>
</method> </method>
<method name="set_tab_icon"> <method name="set_tab_icon">
@ -117,6 +125,7 @@
<argument index="1" name="icon" type="Texture"> <argument index="1" name="icon" type="Texture">
</argument> </argument>
<description> <description>
Sets an icon for the tab at index [code]tab_idx[/code].
</description> </description>
</method> </method>
<method name="set_tab_title"> <method name="set_tab_title">
@ -127,15 +136,18 @@
<argument index="1" name="title" type="String"> <argument index="1" name="title" type="String">
</argument> </argument>
<description> <description>
Sets a title for the tab at index [code]tab_idx[/code].
</description> </description>
</method> </method>
</methods> </methods>
<members> <members>
<member name="current_tab" type="int" setter="set_current_tab" getter="get_current_tab"> <member name="current_tab" type="int" setter="set_current_tab" getter="get_current_tab">
Select tab at index [code]tab_idx[/code].
</member> </member>
<member name="scrolling_enabled" type="bool" setter="set_scrolling_enabled" getter="get_scrolling_enabled"> <member name="scrolling_enabled" type="bool" setter="set_scrolling_enabled" getter="get_scrolling_enabled">
</member> </member>
<member name="tab_align" type="int" setter="set_tab_align" getter="get_tab_align" enum="Tabs.TabAlign"> <member name="tab_align" type="int" setter="set_tab_align" getter="get_tab_align" enum="Tabs.TabAlign">
The alignment of all tabs. See enum [code]TabAlign[/code] constants for details.
</member> </member>
<member name="tab_close_display_policy" type="int" setter="set_tab_close_display_policy" getter="get_tab_close_display_policy" enum="Tabs.CloseButtonDisplayPolicy"> <member name="tab_close_display_policy" type="int" setter="set_tab_close_display_policy" getter="get_tab_close_display_policy" enum="Tabs.CloseButtonDisplayPolicy">
</member> </member>
@ -180,10 +192,13 @@
</signals> </signals>
<constants> <constants>
<constant name="ALIGN_LEFT" value="0" enum="TabAlign"> <constant name="ALIGN_LEFT" value="0" enum="TabAlign">
Align the tabs to the left.
</constant> </constant>
<constant name="ALIGN_CENTER" value="1" enum="TabAlign"> <constant name="ALIGN_CENTER" value="1" enum="TabAlign">
Align the tabs to the center.
</constant> </constant>
<constant name="ALIGN_RIGHT" value="2" enum="TabAlign"> <constant name="ALIGN_RIGHT" value="2" enum="TabAlign">
Align the tabs to the right.
</constant> </constant>
<constant name="ALIGN_MAX" value="3" enum="TabAlign"> <constant name="ALIGN_MAX" value="3" enum="TabAlign">
</constant> </constant>