diff options
Diffstat (limited to 'doc/classes/Tabs.xml')
| -rw-r--r-- | doc/classes/Tabs.xml | 113 |
1 files changed, 99 insertions, 14 deletions
diff --git a/doc/classes/Tabs.xml b/doc/classes/Tabs.xml index ef1f370185..79fa8896e3 100644 --- a/doc/classes/Tabs.xml +++ b/doc/classes/Tabs.xml @@ -4,7 +4,7 @@ Tabs control. </brief_description> <description> - Simple tabs control, similar to [TabContainer] but is only in charge of drawing tabs, not interact with children. + Simple tabs control, similar to [TabContainer] but is only in charge of drawing tabs, not interacting with children. </description> <tutorials> </tutorials> @@ -20,6 +20,15 @@ Adds a new tab. </description> </method> + <method name="clear_tab_opentype_features"> + <return type="void"> + </return> + <argument index="0" name="tab_idx" type="int"> + </argument> + <description> + Removes all OpenType features from the tab title. + </description> + </method> <method name="ensure_tab_visible"> <return type="void"> </return> @@ -75,6 +84,15 @@ 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_language" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="tab_idx" type="int"> + </argument> + <description> + Returns tab title language code. + </description> + </method> <method name="get_tab_offset" qualifiers="const"> <return type="int"> </return> @@ -82,6 +100,17 @@ Returns the number of hidden tabs offsetted to the left. </description> </method> + <method name="get_tab_opentype_feature" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="tab_idx" type="int"> + </argument> + <argument index="1" name="tag" type="String"> + </argument> + <description> + Returns OpenType feature [code]tag[/code] of the tab title. + </description> + </method> <method name="get_tab_rect" qualifiers="const"> <return type="Rect2"> </return> @@ -91,6 +120,15 @@ Returns tab [Rect2] with local position and size. </description> </method> + <method name="get_tab_text_direction" qualifiers="const"> + <return type="int" enum="Control.TextDirection"> + </return> + <argument index="0" name="tab_idx" type="int"> + </argument> + <description> + Returns tab title text base writing direction. + </description> + </method> <method name="get_tab_title" qualifiers="const"> <return type="String"> </return> @@ -159,6 +197,41 @@ Sets an [code]icon[/code] for the tab at index [code]tab_idx[/code]. </description> </method> + <method name="set_tab_language"> + <return type="void"> + </return> + <argument index="0" name="tab_idx" type="int"> + </argument> + <argument index="1" name="language" type="String"> + </argument> + <description> + Sets language code of tab title used for line-breaking and text shaping algorithms, if left empty current locale is used instead. + </description> + </method> + <method name="set_tab_opentype_feature"> + <return type="void"> + </return> + <argument index="0" name="tab_idx" type="int"> + </argument> + <argument index="1" name="tag" type="String"> + </argument> + <argument index="2" name="values" type="int"> + </argument> + <description> + Sets OpenType feature [code]tag[/code] for the tab title. More info: [url=https://docs.microsoft.com/en-us/typography/opentype/spec/featuretags]OpenType feature tags[/url]. + </description> + </method> + <method name="set_tab_text_direction"> + <return type="void"> + </return> + <argument index="0" name="tab_idx" type="int"> + </argument> + <argument index="1" name="direction" type="int" enum="Control.TextDirection"> + </argument> + <description> + Sets tab title base writing direction. + </description> + </method> <method name="set_tab_title"> <return type="void"> </return> @@ -181,6 +254,9 @@ </method> </methods> <members> + <member name="clip_tabs" type="bool" setter="set_clip_tabs" getter="get_clip_tabs" default="true"> + If [code]true[/code], tabs overflowing this node's width will be hidden, displaying two navigation buttons instead. Otherwise, this node's minimum size is updated so that all tabs are visible. + </member> <member name="current_tab" type="int" setter="set_current_tab" getter="get_current_tab" default="0"> Select tab at index [code]tab_idx[/code]. </member> @@ -188,7 +264,7 @@ If [code]true[/code], tabs can be rearranged with mouse drag. </member> <member name="scrolling_enabled" type="bool" setter="set_scrolling_enabled" getter="get_scrolling_enabled" default="true"> - if [code]true[/code], the mouse's scroll wheel cab be used to navigate the scroll view. + if [code]true[/code], the mouse's scroll wheel can be used to navigate the scroll view. </member> <member name="tab_align" type="int" setter="set_tab_align" getter="get_tab_align" enum="Tabs.TabAlign" default="1"> The alignment of all tabs. See [enum TabAlign] for details. @@ -226,14 +302,14 @@ Emitted when a tab is clicked, even if it is the current tab. </description> </signal> - <signal name="tab_close"> + <signal name="tab_closed"> <argument index="0" name="tab" type="int"> </argument> <description> Emitted when a tab is closed. </description> </signal> - <signal name="tab_hover"> + <signal name="tab_hovered"> <argument index="0" name="tab" type="int"> </argument> <description> @@ -286,15 +362,21 @@ <theme_item name="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" 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" 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" type="Color" default="Color( 0.94, 0.94, 0.94, 1 )"> Font color of the currently selected tab. </theme_item> + <theme_item name="font_size" type="int"> + Font size of the tab names. + </theme_item> + <theme_item name="font_unselected_color" type="Color" default="Color( 0.69, 0.69, 0.69, 1 )"> + Font color of the other, unselected tabs. + </theme_item> <theme_item name="hseparation" type="int" default="4"> The horizontal separation between the tabs. </theme_item> @@ -304,16 +386,19 @@ <theme_item name="increment_highlight" 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="panel" type="StyleBox"> + <theme_item name="outline_size" type="int" default="0"> + The size of the tab text outline. </theme_item> - <theme_item name="tab_bg" type="StyleBox"> - The style of an inactive tab. + <theme_item name="panel" type="StyleBox"> </theme_item> <theme_item name="tab_disabled" type="StyleBox"> - The style of a disabled tab + The style of disabled tabs. </theme_item> - <theme_item name="tab_fg" type="StyleBox"> + <theme_item name="tab_selected" type="StyleBox"> The style of the currently selected tab. </theme_item> + <theme_item name="tab_unselected" type="StyleBox"> + The style of the other, unselected tabs. + </theme_item> </theme_items> </class> |