diff options
Diffstat (limited to 'doc/classes/TabContainer.xml')
| -rw-r--r-- | doc/classes/TabContainer.xml | 136 |
1 files changed, 60 insertions, 76 deletions
diff --git a/doc/classes/TabContainer.xml b/doc/classes/TabContainer.xml index d56781105b..fbda005865 100644 --- a/doc/classes/TabContainer.xml +++ b/doc/classes/TabContainer.xml @@ -13,130 +13,107 @@ </tutorials> <methods> <method name="get_current_tab_control" qualifiers="const"> - <return type="Control"> - </return> + <return type="Control" /> <description> Returns the child [Control] node located at the active tab index. </description> </method> <method name="get_popup" qualifiers="const"> - <return type="Popup"> - </return> + <return type="Popup" /> <description> Returns the [Popup] node instance if one has been set already with [method set_popup]. </description> </method> <method name="get_previous_tab" qualifiers="const"> - <return type="int"> - </return> + <return type="int" /> <description> Returns the previously active tab index. </description> </method> <method name="get_tab_control" qualifiers="const"> - <return type="Control"> - </return> - <argument index="0" name="tab_idx" type="int"> - </argument> + <return type="Control" /> + <argument index="0" name="tab_idx" type="int" /> <description> Returns the [Control] node from the tab at index [code]tab_idx[/code]. </description> </method> <method name="get_tab_count" qualifiers="const"> - <return type="int"> - </return> + <return type="int" /> <description> Returns the number of tabs. </description> </method> <method name="get_tab_disabled" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="tab_idx" type="int"> - </argument> + <return type="bool" /> + <argument index="0" name="tab_idx" type="int" /> <description> Returns [code]true[/code] if the tab at index [code]tab_idx[/code] is disabled. </description> </method> <method name="get_tab_icon" qualifiers="const"> - <return type="Texture2D"> - </return> - <argument index="0" name="tab_idx" type="int"> - </argument> + <return type="Texture2D" /> + <argument index="0" name="tab_idx" type="int" /> <description> Returns the [Texture2D] for the tab at index [code]tab_idx[/code] or [code]null[/code] if the tab has no [Texture2D]. </description> </method> <method name="get_tab_title" qualifiers="const"> - <return type="String"> - </return> - <argument index="0" name="tab_idx" type="int"> - </argument> + <return type="String" /> + <argument index="0" name="tab_idx" type="int" /> <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> </method> <method name="get_tabs_rearrange_group" qualifiers="const"> - <return type="int"> - </return> + <return type="int" /> <description> Returns the [TabContainer] rearrange group id. </description> </method> <method name="set_popup"> - <return type="void"> - </return> - <argument index="0" name="popup" type="Node"> - </argument> + <return type="void" /> + <argument index="0" name="popup" type="Node" /> <description> If set on a [Popup] node instance, a popup menu icon appears in the top-right corner of the [TabContainer]. Clicking it will expand the [Popup] node. </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> + <return type="void" /> + <argument index="0" name="tab_idx" type="int" /> + <argument index="1" name="disabled" type="bool" /> <description> 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 also removed with [method set_tab_title]. </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="Texture2D"> - </argument> + <return type="void" /> + <argument index="0" name="tab_idx" type="int" /> + <argument index="1" name="icon" type="Texture2D" /> <description> Sets an icon for the tab at index [code]tab_idx[/code]. </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> + <return type="void" /> + <argument index="0" name="tab_idx" type="int" /> + <argument index="1" name="title" type="String" /> <description> Sets a title for 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> </method> <method name="set_tabs_rearrange_group"> - <return type="void"> - </return> - <argument index="0" name="group_id" type="int"> - </argument> + <return type="void" /> + <argument index="0" name="group_id" type="int" /> <description> Defines rearrange group id, choose for each [TabContainer] the same value to enable tab drag between [TabContainer]. Enable drag with [code]set_drag_to_rearrange_enabled(true)[/code]. </description> </method> </methods> <members> + <member name="all_tabs_in_front" type="bool" setter="set_all_tabs_in_front" getter="is_all_tabs_in_front" default="false"> + If [code]true[/code], all tabs are drawn in front of the panel. If [code]false[/code], inactive tabs are drawn behind the panel. + </member> <member name="current_tab" type="int" setter="set_current_tab" getter="get_current_tab" default="0"> The current tab index. When set, this index's [Control] node's [code]visible[/code] property is set to [code]true[/code] and all others are set to [code]false[/code]. </member> @@ -160,15 +137,13 @@ </description> </signal> <signal name="tab_changed"> - <argument index="0" name="tab" type="int"> - </argument> + <argument index="0" name="tab" type="int" /> <description> Emitted when switching to another tab. </description> </signal> <signal name="tab_selected"> - <argument index="0" name="tab" type="int"> - </argument> + <argument index="0" name="tab" type="int" /> <description> Emitted when a tab is selected, even if it is the current tab. </description> @@ -186,53 +161,62 @@ </constant> </constants> <theme_items> - <theme_item name="decrement" type="Texture2D"> + <theme_item name="decrement" data_type="icon" type="Texture2D"> Icon for the left arrow button that appears when there are too many tabs to fit in the container width. When the button is disabled (i.e. the first tab is visible), it appears semi-transparent. </theme_item> - <theme_item name="decrement_highlight" type="Texture2D"> + <theme_item name="decrement_highlight" data_type="icon" type="Texture2D"> Icon for the left arrow button that appears when there are too many tabs to fit in the container width. Used when the button is being hovered with the cursor. </theme_item> - <theme_item name="font" type="Font"> + <theme_item name="font" data_type="font" type="Font"> The font used to draw tab names. </theme_item> - <theme_item name="font_color_bg" type="Color" default="Color( 0.69, 0.69, 0.69, 1 )"> - Font color of inactive tabs. - </theme_item> - <theme_item name="font_color_disabled" type="Color" default="Color( 0.9, 0.9, 0.9, 0.2 )"> + <theme_item name="font_disabled_color" data_type="color" type="Color" default="Color(0.9, 0.9, 0.9, 0.2)"> Font color of disabled tabs. </theme_item> - <theme_item name="font_color_fg" type="Color" default="Color( 0.94, 0.94, 0.94, 1 )"> + <theme_item name="font_outline_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)"> + The tint of text outline of the tab name. + </theme_item> + <theme_item name="font_selected_color" data_type="color" type="Color" default="Color(0.94, 0.94, 0.94, 1)"> Font color of the currently selected tab. </theme_item> - <theme_item name="icon_separation" type="int" default="4"> + <theme_item name="font_size" data_type="font_size" type="int"> + Font size of the tab names. + </theme_item> + <theme_item name="font_unselected_color" data_type="color" type="Color" default="Color(0.69, 0.69, 0.69, 1)"> + Font color of the other, unselected tabs. + </theme_item> + <theme_item name="icon_separation" data_type="constant" type="int" default="4"> Space between tab's name and its icon. </theme_item> - <theme_item name="increment" type="Texture2D"> + <theme_item name="increment" data_type="icon" type="Texture2D"> Icon for the right arrow button that appears when there are too many tabs to fit in the container width. When the button is disabled (i.e. the last tab is visible) it appears semi-transparent. </theme_item> - <theme_item name="increment_highlight" type="Texture2D"> + <theme_item name="increment_highlight" data_type="icon" type="Texture2D"> Icon for the right arrow button that appears when there are too many tabs to fit in the container width. Used when the button is being hovered with the cursor. </theme_item> - <theme_item name="menu" type="Texture2D"> + <theme_item name="menu" data_type="icon" type="Texture2D"> The icon for the menu button (see [method set_popup]). </theme_item> - <theme_item name="menu_highlight" type="Texture2D"> + <theme_item name="menu_highlight" data_type="icon" type="Texture2D"> The icon for the menu button (see [method set_popup]) when it's being hovered with the cursor. </theme_item> - <theme_item name="panel" type="StyleBox"> + <theme_item name="outline_size" data_type="constant" type="int" default="0"> + The size of the tab text outline. + </theme_item> + <theme_item name="panel" data_type="style" type="StyleBox"> The style for the background fill. </theme_item> - <theme_item name="side_margin" type="int" default="8"> + <theme_item name="side_margin" data_type="constant" type="int" default="8"> The space at the left and right edges of the tab bar. </theme_item> - <theme_item name="tab_bg" type="StyleBox"> - The style of inactive tabs. - </theme_item> - <theme_item name="tab_disabled" type="StyleBox"> + <theme_item name="tab_disabled" data_type="style" type="StyleBox"> The style of disabled tabs. </theme_item> - <theme_item name="tab_fg" type="StyleBox"> + <theme_item name="tab_selected" data_type="style" type="StyleBox"> The style of the currently selected tab. </theme_item> + <theme_item name="tab_unselected" data_type="style" type="StyleBox"> + The style of the other, unselected tabs. + </theme_item> </theme_items> </class> |