2017-09-12 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
2020-02-01 02:03:48 +01:00
<class name= "Tabs" inherits= "Control" version= "4.0" >
2017-09-12 22:42:36 +02:00
<brief_description >
2019-06-22 01:04:47 +02:00
Tabs control.
2017-09-12 22:42:36 +02:00
</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>
2020-02-12 09:59:06 +01:00
<argument index= "1" name= "icon" type= "Texture2D" default= "null" >
2017-09-12 22:42:36 +02:00
</argument>
<description >
2018-10-15 15:01:10 +02:00
Adds a new tab.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "ensure_tab_visible" >
<return type= "void" >
</return>
<argument index= "0" name= "idx" type= "int" >
</argument>
<description >
2019-06-22 01:04:47 +02:00
Moves the scroll view to make the tab visible.
2017-09-12 22:42:36 +02:00
</description>
</method>
2017-11-24 09:16:27 +01:00
<method name= "get_offset_buttons_visible" qualifiers= "const" >
<return type= "bool" >
</return>
<description >
2020-01-05 22:19:08 +01:00
Returns [code]true[/code] if the offset buttons (the ones that appear when there's not enough space for all tabs) are visible.
2017-11-24 09:16:27 +01:00
</description>
</method>
2018-08-21 00:35:30 +02:00
<method name= "get_select_with_rmb" qualifiers= "const" >
<return type= "bool" >
</return>
<description >
2018-10-15 15:01:10 +02:00
Returns [code]true[/code] if select with right mouse button is enabled.
2018-08-21 00:35:30 +02:00
</description>
</method>
2017-09-12 22:42:36 +02:00
<method name= "get_tab_count" qualifiers= "const" >
<return type= "int" >
</return>
<description >
2018-10-15 15:01:10 +02:00
Returns the number of tabs.
2017-09-12 22:42:36 +02: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 15:01:10 +02:00
Returns [code]true[/code] if the tab at index [code]tab_idx[/code] is disabled.
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "get_tab_icon" qualifiers= "const" >
2020-02-12 09:59:06 +01:00
<return type= "Texture2D" >
2017-09-12 22:42:36 +02:00
</return>
<argument index= "0" name= "tab_idx" type= "int" >
</argument>
<description >
2020-02-12 09:59:06 +01:00
Returns the [Texture2D] for the tab at index [code]tab_idx[/code] or [code]null[/code] if the tab has no [Texture2D].
2017-09-12 22:42:36 +02:00
</description>
</method>
2017-11-24 09:16:27 +01:00
<method name= "get_tab_offset" qualifiers= "const" >
<return type= "int" >
</return>
<description >
2020-01-05 22:19:08 +01:00
Returns the number of hidden tabs offsetted to the left.
2017-11-24 09:16:27 +01:00
</description>
</method>
2017-09-12 22:42:36 +02: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 15:01:10 +02: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 22:42:36 +02:00
</description>
</method>
2018-04-10 10:12:42 +02:00
<method name= "get_tabs_rearrange_group" qualifiers= "const" >
<return type= "int" >
</return>
<description >
2019-06-22 01:04:47 +02:00
Returns the [Tabs]' rearrange group ID.
2018-04-10 10:12:42 +02:00
</description>
</method>
2017-09-12 22:42:36 +02: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 >
2019-06-22 01:04:47 +02:00
Moves a tab from [code]from[/code] to [code]to[/code].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "remove_tab" >
<return type= "void" >
</return>
<argument index= "0" name= "tab_idx" type= "int" >
</argument>
<description >
2019-06-22 01:04:47 +02:00
Removes the tab at index [code]tab_idx[/code].
2017-09-12 22:42:36 +02:00
</description>
</method>
2018-08-21 00:35:30 +02:00
<method name= "set_select_with_rmb" >
<return type= "void" >
</return>
<argument index= "0" name= "enabled" type= "bool" >
</argument>
<description >
2019-06-22 01:04:47 +02:00
If [code]true[/code], enables selecting a tab with the right mouse button.
2018-08-21 00:35:30 +02:00
</description>
</method>
2017-09-12 22:42:36 +02: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-06-22 01:04:47 +02:00
If [code]disabled[/code] is [code]false[/code], hides the tab at index [code]tab_idx[/code].
[b]Note:[/b] Its title text will remain unless it is also removed with [method set_tab_title].
2017-09-12 22:42:36 +02:00
</description>
</method>
<method name= "set_tab_icon" >
<return type= "void" >
</return>
<argument index= "0" name= "tab_idx" type= "int" >
</argument>
2020-02-12 09:59:06 +01:00
<argument index= "1" name= "icon" type= "Texture2D" >
2017-09-12 22:42:36 +02:00
</argument>
<description >
2019-06-22 01:04:47 +02:00
Sets an [code]icon[/code] for the tab at index [code]tab_idx[/code].
2017-09-12 22:42:36 +02: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 >
2019-06-22 01:04:47 +02:00
Sets a [code]title[/code] for the tab at index [code]tab_idx[/code].
2017-09-12 22:42:36 +02:00
</description>
</method>
2018-04-10 10:12:42 +02:00
<method name= "set_tabs_rearrange_group" >
<return type= "void" >
</return>
<argument index= "0" name= "group_id" type= "int" >
</argument>
<description >
2019-06-22 01:04:47 +02:00
Defines the rearrange group ID. Choose for each [Tabs] the same value to dragging tabs between [Tabs]. Enable drag with [code]set_drag_to_rearrange_enabled(true)[/code].
2018-04-10 10:12:42 +02:00
</description>
</method>
2017-09-12 22:42:36 +02:00
</methods>
<members >
2019-06-29 12:38:01 +02:00
<member name= "current_tab" type= "int" setter= "set_current_tab" getter= "get_current_tab" default= "0" >
2018-10-15 15:01:10 +02:00
Select tab at index [code]tab_idx[/code].
2017-09-12 22:42:36 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "drag_to_rearrange_enabled" type= "bool" setter= "set_drag_to_rearrange_enabled" getter= "get_drag_to_rearrange_enabled" default= "false" >
2018-10-15 15:01:10 +02:00
If [code]true[/code], tabs can be rearranged with mouse drag.
2018-04-10 10:12:42 +02:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "scrolling_enabled" type= "bool" setter= "set_scrolling_enabled" getter= "get_scrolling_enabled" default= "true" >
2020-01-05 22:19:08 +01:00
if [code]true[/code], the mouse's scroll wheel cab be used to navigate the scroll view.
2017-11-24 09:16:27 +01:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "tab_align" type= "int" setter= "set_tab_align" getter= "get_tab_align" enum= "Tabs.TabAlign" default= "1" >
2020-01-05 22:19:08 +01:00
The alignment of all tabs. See [enum TabAlign] for details.
2018-01-11 23:38:35 +01:00
</member>
2019-06-29 12:38:01 +02:00
<member name= "tab_close_display_policy" type= "int" setter= "set_tab_close_display_policy" getter= "get_tab_close_display_policy" enum= "Tabs.CloseButtonDisplayPolicy" default= "0" >
2020-01-05 22:19:08 +01:00
Sets when the close button will appear on the tabs. See [enum CloseButtonDisplayPolicy] for details.
2017-09-12 22:42:36 +02:00
</member>
</members>
<signals >
<signal name= "reposition_active_tab_request" >
<argument index= "0" name= "idx_to" type= "int" >
</argument>
<description >
2020-01-05 22:19:08 +01:00
Emitted when the active tab is rearranged via mouse drag. See [member drag_to_rearrange_enabled].
2017-09-12 22:42:36 +02:00
</description>
</signal>
<signal name= "right_button_pressed" >
<argument index= "0" name= "tab" type= "int" >
</argument>
<description >
2020-01-05 22:19:08 +01:00
Emitted when a tab is right-clicked.
2017-09-12 22:42:36 +02:00
</description>
</signal>
<signal name= "tab_changed" >
<argument index= "0" name= "tab" type= "int" >
</argument>
<description >
2020-01-05 22:19:08 +01:00
Emitted when switching to another tab.
2017-09-12 22:42:36 +02:00
</description>
</signal>
<signal name= "tab_clicked" >
<argument index= "0" name= "tab" type= "int" >
</argument>
<description >
2020-01-05 22:19:08 +01:00
Emitted when a tab is clicked, even if it is the current tab.
2017-09-12 22:42:36 +02:00
</description>
</signal>
<signal name= "tab_close" >
<argument index= "0" name= "tab" type= "int" >
</argument>
<description >
2020-01-05 22:19:08 +01:00
Emitted when a tab is closed.
2017-09-12 22:42:36 +02:00
</description>
</signal>
<signal name= "tab_hover" >
<argument index= "0" name= "tab" type= "int" >
</argument>
<description >
2020-01-05 22:19:08 +01:00
Emitted when a tab is hovered by the mouse.
2017-09-12 22:42:36 +02:00
</description>
</signal>
</signals>
<constants >
2017-11-24 23:16:30 +01:00
<constant name= "ALIGN_LEFT" value= "0" enum= "TabAlign" >
2018-10-15 15:01:10 +02:00
Align the tabs to the left.
2017-09-12 22:42:36 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "ALIGN_CENTER" value= "1" enum= "TabAlign" >
2018-10-15 15:01:10 +02:00
Align the tabs to the center.
2017-09-12 22:42:36 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "ALIGN_RIGHT" value= "2" enum= "TabAlign" >
2018-10-15 15:01:10 +02:00
Align the tabs to the right.
2017-09-12 22:42:36 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "ALIGN_MAX" value= "3" enum= "TabAlign" >
2019-06-27 11:10:53 +02:00
Represents the size of the [enum TabAlign] enum.
2017-09-12 22:42:36 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "CLOSE_BUTTON_SHOW_NEVER" value= "0" enum= "CloseButtonDisplayPolicy" >
2020-01-05 22:19:08 +01:00
Never show the close buttons.
2017-10-22 12:56:11 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "CLOSE_BUTTON_SHOW_ACTIVE_ONLY" value= "1" enum= "CloseButtonDisplayPolicy" >
2020-01-05 22:19:08 +01:00
Only show the close button on the currently active tab.
2017-09-12 22:42:36 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "CLOSE_BUTTON_SHOW_ALWAYS" value= "2" enum= "CloseButtonDisplayPolicy" >
2020-01-05 22:19:08 +01:00
Show the close button on all tabs.
2017-09-12 22:42:36 +02:00
</constant>
2017-11-24 23:16:30 +01:00
<constant name= "CLOSE_BUTTON_MAX" value= "3" enum= "CloseButtonDisplayPolicy" >
2019-06-27 11:10:53 +02:00
Represents the size of the [enum CloseButtonDisplayPolicy] enum.
2017-09-12 22:42:36 +02:00
</constant>
</constants>
<theme_items >
<theme_item name= "button" type= "StyleBox" >
</theme_item>
<theme_item name= "button_pressed" type= "StyleBox" >
</theme_item>
2020-02-12 09:59:06 +01:00
<theme_item name= "close" type= "Texture2D" >
2017-09-12 22:42:36 +02:00
</theme_item>
2020-02-12 09:59:06 +01:00
<theme_item name= "decrement" type= "Texture2D" >
2017-09-12 22:42:36 +02:00
</theme_item>
2020-02-12 09:59:06 +01:00
<theme_item name= "decrement_highlight" type= "Texture2D" >
2017-09-12 22:42:36 +02:00
</theme_item>
<theme_item name= "font" type= "Font" >
</theme_item>
2019-07-09 09:13:00 +02:00
<theme_item name= "font_color_bg" type= "Color" default= "Color( 0.69, 0.69, 0.69, 1 )" >
2017-09-12 22:42:36 +02:00
</theme_item>
2019-06-29 12:38:01 +02:00
<theme_item name= "font_color_disabled" type= "Color" default= "Color( 0.9, 0.9, 0.9, 0.2 )" >
2017-09-12 22:42:36 +02:00
</theme_item>
2019-07-09 09:13:00 +02:00
<theme_item name= "font_color_fg" type= "Color" default= "Color( 0.94, 0.94, 0.94, 1 )" >
2017-09-12 22:42:36 +02:00
</theme_item>
2019-06-29 12:38:01 +02:00
<theme_item name= "hseparation" type= "int" default= "4" >
2017-09-12 22:42:36 +02:00
</theme_item>
2020-02-12 09:59:06 +01:00
<theme_item name= "increment" type= "Texture2D" >
2017-09-12 22:42:36 +02:00
</theme_item>
2020-02-12 09:59:06 +01:00
<theme_item name= "increment_highlight" type= "Texture2D" >
2017-09-12 22:42:36 +02:00
</theme_item>
2019-06-29 12:38:01 +02:00
<theme_item name= "label_valign_bg" type= "int" default= "2" >
2017-09-12 22:42:36 +02:00
</theme_item>
2019-06-29 12:38:01 +02:00
<theme_item name= "label_valign_fg" type= "int" default= "0" >
2017-09-12 22:42:36 +02:00
</theme_item>
<theme_item name= "panel" type= "StyleBox" >
</theme_item>
<theme_item name= "tab_bg" type= "StyleBox" >
</theme_item>
2019-02-16 14:40:52 +01:00
<theme_item name= "tab_disabled" type= "StyleBox" >
</theme_item>
2017-09-12 22:42:36 +02:00
<theme_item name= "tab_fg" type= "StyleBox" >
</theme_item>
2019-06-29 12:38:01 +02:00
<theme_item name= "top_margin" type= "int" default= "24" >
2017-09-12 22:42:36 +02:00
</theme_item>
</theme_items>
</class>