2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2019-07-05 09:32:53 +00:00
<class name= "Tabs" inherits= "Control" category= "Core" version= "3.1.2" >
2017-09-12 20:42:36 +00:00
<brief_description >
Tabs Control.
</brief_description>
<description >
Simple tabs control, similar to [TabContainer] but is only in charge of drawing tabs, not interact with children.
</description>
<tutorials >
</tutorials>
<methods >
<method name= "add_tab" >
<return type= "void" >
</return>
<argument index= "0" name= "title" type= "String" default= """" >
</argument>
<argument index= "1" name= "icon" type= "Texture" default= "null" >
</argument>
<description >
2018-10-15 13:01:10 +00:00
Adds a new tab.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "ensure_tab_visible" >
<return type= "void" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<description >
2018-10-15 13:01:10 +00:00
Moves the Scroll view to make the tab visible.
2017-09-12 20:42:36 +00:00
</description>
</method>
2017-11-24 08:16:27 +00:00
<method name= "get_offset_buttons_visible" qualifiers= "const" >
<return type= "bool" >
</return>
<description >
</description>
</method>
2018-08-20 22:35:30 +00:00
<method name= "get_select_with_rmb" qualifiers= "const" >
<return type= "bool" >
</return>
<description >
2018-10-15 13:01:10 +00:00
Returns [code]true[/code] if select with right mouse button is enabled.
2018-08-20 22:35:30 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "get_tab_count" qualifiers= "const" >
<return type= "int" >
</return>
<description >
2018-10-15 13:01:10 +00:00
Returns the number of tabs.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_tab_disabled" qualifiers= "const" >
<return type= "bool" >
</return>
<argument index= "0" name= "tab_idx" type= "int" >
</argument>
<description >
2018-10-15 13:01:10 +00:00
Returns [code]true[/code] if the tab at index [code]tab_idx[/code] is disabled.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name= "get_tab_icon" qualifiers= "const" >
<return type= "Texture" >
</return>
<argument index= "0" name= "tab_idx" type= "int" >
</argument>
<description >
2018-10-15 13:01:10 +00:00
Returns the [Texture] for the tab at index [code]tab_idx[/code] or null if the tab has no [Texture].
2017-09-12 20:42:36 +00:00
</description>
</method>
2017-11-24 08:16:27 +00:00
<method name= "get_tab_offset" qualifiers= "const" >
<return type= "int" >
</return>
<description >
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "get_tab_rect" qualifiers= "const" >
<return type= "Rect2" >
</return>
<argument index= "0" name= "tab_idx" type= "int" >
</argument>
<description >
Returns tab [Rect2] with local position and size.
</description>
</method>
<method name= "get_tab_title" qualifiers= "const" >
<return type= "String" >
</return>
<argument index= "0" name= "tab_idx" type= "int" >
</argument>
<description >
2018-10-15 13:01:10 +00:00
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].
2017-09-12 20:42:36 +00:00
</description>
</method>
2018-04-10 08:12:42 +00:00
<method name= "get_tabs_rearrange_group" qualifiers= "const" >
<return type= "int" >
</return>
<description >
2018-10-15 13:01:10 +00:00
Returns the [code]Tabs[/code] rearrange group id.
2018-04-10 08:12:42 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
<method name= "move_tab" >
<return type= "void" >
</return>
<argument index= "0" name= "from" type= "int" >
</argument>
<argument index= "1" name= "to" type= "int" >
</argument>
<description >
Rearrange tab.
</description>
</method>
<method name= "remove_tab" >
<return type= "void" >
</return>
<argument index= "0" name= "tab_idx" type= "int" >
</argument>
<description >
2018-10-15 13:01:10 +00:00
Removes tab at index [code]tab_idx[/code]
2017-09-12 20:42:36 +00:00
</description>
</method>
2018-08-20 22:35:30 +00:00
<method name= "set_select_with_rmb" >
<return type= "void" >
</return>
<argument index= "0" name= "enabled" type= "bool" >
</argument>
<description >
2018-12-20 12:46:54 +00:00
If [code]true[/code], enables selecting a tab with right mouse button.
2018-08-20 22:35:30 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
<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 >
2019-04-17 11:42:56 +00:00
If [code]disabled[/code] is [code]false[/code], hides the tab at index [code]tab_idx[/code]. Note that its title text will remain, unless also removed with [method set_tab_title].
2017-09-12 20:42:36 +00: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 >
2018-10-15 13:01:10 +00:00
Sets an icon for the tab at index [code]tab_idx[/code].
2017-09-12 20:42:36 +00: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 >
2018-10-15 13:01:10 +00:00
Sets a title for the tab at index [code]tab_idx[/code].
2017-09-12 20:42:36 +00:00
</description>
</method>
2018-04-10 08:12:42 +00:00
<method name= "set_tabs_rearrange_group" >
<return type= "void" >
</return>
<argument index= "0" name= "group_id" type= "int" >
</argument>
<description >
2018-10-15 13:01:10 +00:00
Defines rearrange group id, choose for each [code]Tabs[/code] the same value to enable tab drag between [code]Tabs[/code]. Enable drag with [code]set_drag_to_rearrange_enabled(true)[/code].
2018-04-10 08:12:42 +00:00
</description>
</method>
2017-09-12 20:42:36 +00:00
</methods>
<members >
2017-09-13 06:49:40 +00:00
<member name= "current_tab" type= "int" setter= "set_current_tab" getter= "get_current_tab" >
2018-10-15 13:01:10 +00:00
Select tab at index [code]tab_idx[/code].
2017-09-12 20:42:36 +00:00
</member>
2018-04-10 08:12:42 +00:00
<member name= "drag_to_rearrange_enabled" type= "bool" setter= "set_drag_to_rearrange_enabled" getter= "get_drag_to_rearrange_enabled" >
2018-10-15 13:01:10 +00:00
If [code]true[/code], tabs can be rearranged with mouse drag.
2018-04-10 08:12:42 +00:00
</member>
2017-11-24 08:16:27 +00:00
<member name= "scrolling_enabled" type= "bool" setter= "set_scrolling_enabled" getter= "get_scrolling_enabled" >
</member>
2018-01-11 22:38:35 +00:00
<member name= "tab_align" type= "int" setter= "set_tab_align" getter= "get_tab_align" enum= "Tabs.TabAlign" >
2018-10-15 13:01:10 +00:00
The alignment of all tabs. See enum [code]TabAlign[/code] constants for details.
2018-01-11 22:38:35 +00:00
</member>
2017-09-13 06:49:40 +00:00
<member name= "tab_close_display_policy" type= "int" setter= "set_tab_close_display_policy" getter= "get_tab_close_display_policy" enum= "Tabs.CloseButtonDisplayPolicy" >
2017-09-12 20:42:36 +00:00
</member>
</members>
<signals >
<signal name= "reposition_active_tab_request" >
<argument index= "0" name= "idx_to" type= "int" >
</argument>
<description >
</description>
</signal>
<signal name= "right_button_pressed" >
<argument index= "0" name= "tab" type= "int" >
</argument>
<description >
</description>
</signal>
<signal name= "tab_changed" >
<argument index= "0" name= "tab" type= "int" >
</argument>
<description >
</description>
</signal>
<signal name= "tab_clicked" >
<argument index= "0" name= "tab" type= "int" >
</argument>
<description >
</description>
</signal>
<signal name= "tab_close" >
<argument index= "0" name= "tab" type= "int" >
</argument>
<description >
</description>
</signal>
<signal name= "tab_hover" >
<argument index= "0" name= "tab" type= "int" >
</argument>
<description >
</description>
</signal>
</signals>
<constants >
2017-11-24 22:16:30 +00:00
<constant name= "ALIGN_LEFT" value= "0" enum= "TabAlign" >
2018-10-15 13:01:10 +00:00
Align the tabs to the left.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "ALIGN_CENTER" value= "1" enum= "TabAlign" >
2018-10-15 13:01:10 +00:00
Align the tabs to the center.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "ALIGN_RIGHT" value= "2" enum= "TabAlign" >
2018-10-15 13:01:10 +00:00
Align the tabs to the right.
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "ALIGN_MAX" value= "3" enum= "TabAlign" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "CLOSE_BUTTON_SHOW_NEVER" value= "0" enum= "CloseButtonDisplayPolicy" >
2017-10-22 10:56:11 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "CLOSE_BUTTON_SHOW_ACTIVE_ONLY" value= "1" enum= "CloseButtonDisplayPolicy" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "CLOSE_BUTTON_SHOW_ALWAYS" value= "2" enum= "CloseButtonDisplayPolicy" >
2017-09-12 20:42:36 +00:00
</constant>
2017-11-24 22:16:30 +00:00
<constant name= "CLOSE_BUTTON_MAX" value= "3" enum= "CloseButtonDisplayPolicy" >
2017-09-12 20:42:36 +00:00
</constant>
</constants>
<theme_items >
<theme_item name= "button" type= "StyleBox" >
</theme_item>
<theme_item name= "button_pressed" type= "StyleBox" >
</theme_item>
<theme_item name= "close" type= "Texture" >
</theme_item>
<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= "panel" type= "StyleBox" >
</theme_item>
<theme_item name= "tab_bg" type= "StyleBox" >
</theme_item>
2019-02-16 13:40:52 +00:00
<theme_item name= "tab_disabled" type= "StyleBox" >
</theme_item>
2017-09-12 20:42:36 +00:00
<theme_item name= "tab_fg" type= "StyleBox" >
</theme_item>
<theme_item name= "top_margin" type= "int" >
</theme_item>
</theme_items>
</class>