godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/doc/classes/TabContainer.xml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

353 lines
18 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb).
2023-07-06 08:08:05 +00:00
<class name="TabContainer" inherits="Container" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<brief_description>
Overhaul the top sections of the class reference (GUI classes)
2023-04-30 14:26:09 +00:00
A container that creates a tab for each child control, displaying only the active tab's control.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</brief_description>
<description>
Overhaul the top sections of the class reference (GUI classes)
2023-04-30 14:26:09 +00:00
Arranges child controls into a tabbed view, creating a tab for each one. The active tab's corresponding control is made visible, while all other child controls are hidden. Ignores non-control children.
[b]Note:[/b] The drawing of the clickable tabs is handled by this node; [TabBar] is not needed.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
<tutorials>
Overhaul the top sections of the class reference (GUI classes)
2023-04-30 14:26:09 +00:00
<link title="Using Containers">$DOCS_URL/tutorials/ui/gui_containers.html</link>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</tutorials>
<methods>
<method name="get_current_tab_control" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Control" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
classref: Sync with current source Also fix hyperlink references to same class as per the guidelines. [ci skip]
2017-10-22 10:56:11 +00:00
Returns the child [Control] node located at the active tab index.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_popup" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Popup" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
classref: Sync with current source Also fix hyperlink references to same class as per the guidelines. [ci skip]
2017-10-22 10:56:11 +00:00
Returns the [Popup] node instance if one has been set already with [method set_popup].
Add warnings to methods that give access to internal nodes
2021-10-10 19:28:56 +00:00
[b]Warning:[/b] This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member Window.visible] property.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_previous_tab" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
classref: Sync with current source Also fix hyperlink references to same class as per the guidelines. [ci skip]
2017-10-22 10:56:11 +00:00
Returns the previously active tab index.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Expose the `TabBar` of a `TabContainer` Add `TabContainer::get_tab_bar` method to retrieve the `TabBar` of a `TabContainer`.
2023-08-03 18:53:49 +00:00
<method name="get_tab_bar" qualifiers="const">
<return type="TabBar" />
<description>
Returns the [TabBar] contained in this container.
[b]Warning:[/b] This is a required internal node, removing and freeing it or editing its tabs may cause a crash. If you wish to edit the tabs, use the methods provided in [TabContainer].
</description>
</method>
Add action map editor for OpenXR
2022-03-16 23:24:47 +00:00
<method name="get_tab_button_icon" qualifiers="const">
<return type="Texture2D" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="tab_idx" type="int" />
Add action map editor for OpenXR
2022-03-16 23:24:47 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns the button icon from the tab at index [param tab_idx].
Add action map editor for OpenXR
2022-03-16 23:24:47 +00:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="get_tab_control" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Control" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="tab_idx" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns the [Control] node from the tab at index [param tab_idx].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_tab_count" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
updated the TabContainer docs for depth and readability.
2017-10-21 04:31:45 +00:00
Returns the number of tabs.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="get_tab_icon" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Texture2D" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="tab_idx" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns the [Texture2D] for the tab at index [param tab_idx] or [code]null[/code] if the tab has no [Texture2D].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Bind TabContainer::get_tab_idx_at_point() to ClassDB
2021-08-24 04:14:07 +00:00
<method name="get_tab_idx_at_point" qualifiers="const">
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="point" type="Vector2" />
Bind TabContainer::get_tab_idx_at_point() to ClassDB
2021-08-24 04:14:07 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns the index of the tab at local coordinates [param point]. Returns [code]-1[/code] if the point is outside the control boundaries or if there's no tab at the queried position.
Bind TabContainer::get_tab_idx_at_point() to ClassDB
2021-08-24 04:14:07 +00:00
</description>
</method>
Make `TabContainer` use `TabBar` internally
2022-03-02 14:37:10 +00:00
<method name="get_tab_idx_from_control" qualifiers="const">
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="control" type="Control" />
Make `TabContainer` use `TabBar` internally
2022-03-02 14:37:10 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns the index of the tab tied to the given [param control]. The control must be a child of the [TabContainer].
Make `TabContainer` use `TabBar` internally
2022-03-02 14:37:10 +00:00
</description>
</method>
Add Tab Metadata
2023-04-11 16:48:47 +00:00
<method name="get_tab_metadata" qualifiers="const">
<return type="Variant" />
<param index="0" name="tab_idx" type="int" />
<description>
Returns the metadata value set to the tab at index [param tab_idx] using [method set_tab_metadata]. If no metadata was previously set, returns [code]null[/code] by default.
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="get_tab_title" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="String" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="tab_idx" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns the title of the tab at index [param tab_idx]. Tab titles default to the name of the indexed child node, but this can be overridden with [method set_tab_title].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Make `TabContainer` use `TabBar` internally
2022-03-02 14:37:10 +00:00
<method name="is_tab_disabled" qualifiers="const">
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="tab_idx" type="int" />
Make `TabContainer` use `TabBar` internally
2022-03-02 14:37:10 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns [code]true[/code] if the tab at index [param tab_idx] is disabled.
Make `TabContainer` use `TabBar` internally
2022-03-02 14:37:10 +00:00
</description>
</method>
<method name="is_tab_hidden" qualifiers="const">
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="tab_idx" type="int" />
Make `TabContainer` use `TabBar` internally
2022-03-02 14:37:10 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns [code]true[/code] if the tab at index [param tab_idx] is hidden.
Make `TabContainer` use `TabBar` internally
2022-03-02 14:37:10 +00:00
</description>
</method>
Allow to focus individual tabs in TabBar/TabContainer
2023-06-25 15:56:52 +00:00
<method name="select_next_available">
<return type="bool" />
<description>
Selects the first available tab with greater index than the currently selected. Returns [code]true[/code] if tab selection changed.
</description>
</method>
<method name="select_previous_available">
<return type="bool" />
<description>
Selects the first available tab with lower index than the currently selected. Returns [code]true[/code] if tab selection changed.
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="set_popup">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="popup" type="Node" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Make `TabContainer` use `TabBar` internally
2022-03-02 14:37:10 +00:00
If set on a [Popup] node instance, a popup menu icon appears in the top-right corner of the [TabContainer] (setting it to [code]null[/code] will make it go away). Clicking it will expand the [Popup] node.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Add action map editor for OpenXR
2022-03-16 23:24:47 +00:00
<method name="set_tab_button_icon">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="tab_idx" type="int" />
<param index="1" name="icon" type="Texture2D" />
Add action map editor for OpenXR
2022-03-16 23:24:47 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Sets the button icon from the tab at index [param tab_idx].
Add action map editor for OpenXR
2022-03-16 23:24:47 +00:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="set_tab_disabled">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="tab_idx" type="int" />
<param index="1" name="disabled" type="bool" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
If [param disabled] is [code]true[/code], disables the tab at index [param tab_idx], making it non-interactable.
Expose `TabContainer`'s tab hidding for scripts
2021-09-24 04:26:59 +00:00
</description>
</method>
<method name="set_tab_hidden">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="tab_idx" type="int" />
<param index="1" name="hidden" type="bool" />
Expose `TabContainer`'s tab hidding for scripts
2021-09-24 04:26:59 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
If [param hidden] is [code]true[/code], hides the tab at index [param tab_idx], making it disappear from the tab area.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="set_tab_icon">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="tab_idx" type="int" />
<param index="1" name="icon" type="Texture2D" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Sets an icon for the tab at index [param tab_idx].
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
Add Tab Metadata
2023-04-11 16:48:47 +00:00
<method name="set_tab_metadata">
<return type="void" />
<param index="0" name="tab_idx" type="int" />
<param index="1" name="metadata" type="Variant" />
<description>
Sets the metadata value for the tab at index [param tab_idx], which can be retrieved later using [method get_tab_metadata].
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="set_tab_title">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="tab_idx" type="int" />
<param index="1" name="title" type="String" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Sets a custom title for the tab at index [param tab_idx] (tab titles default to the name of the indexed child node). Set it back to the child's name to make the tab default to it again.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
</methods>
<members>
doc: Sync classref with current source
2021-01-04 13:33:44 +00:00
<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>
Make `TabContainer` use `TabBar` internally
2022-03-02 14:37:10 +00:00
<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>
Allow tab deselection
2024-01-14 23:39:47 +00:00
<member name="current_tab" type="int" setter="set_current_tab" getter="get_current_tab" default="-1">
classref: Sync with current source Also fix hyperlink references to same class as per the guidelines. [ci skip]
2017-10-22 10:56:11 +00:00
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].
Allow tab deselection
2024-01-14 23:39:47 +00:00
A value of [code]-1[/code] means that no tab is selected.
</member>
<member name="deselect_enabled" type="bool" setter="set_deselect_enabled" getter="get_deselect_enabled" default="false">
If [code]true[/code], all tabs can be deselected so that no tab is selected. Click on the [member current_tab] to deselect it.
Only the tab header will be shown if no tabs are selected.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="drag_to_rearrange_enabled" type="bool" setter="set_drag_to_rearrange_enabled" getter="get_drag_to_rearrange_enabled" default="false">
Doc Tabcontainer rearrange tabs
2018-10-14 13:58:06 +00:00
If [code]true[/code], tabs can be rearranged with mouse drag.
doc: Sync classref with current source
2018-04-10 08:12:42 +00:00
</member>
Make `TabBar/Container` default their alignments to the left instead of center
2022-03-07 14:32:49 +00:00
<member name="tab_alignment" type="int" setter="set_tab_alignment" getter="get_tab_alignment" enum="TabBar.AlignmentMode" default="0">
Make `TabContainer` use `TabBar` internally
2022-03-02 14:37:10 +00:00
Sets the position at which tabs will be placed. See [enum TabBar.AlignmentMode] for details.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
Allow to focus individual tabs in TabBar/TabContainer
2023-06-25 15:56:52 +00:00
<member name="tab_focus_mode" type="int" setter="set_tab_focus_mode" getter="get_tab_focus_mode" enum="Control.FocusMode" default="2">
The focus access mode for the internal [TabBar] node.
</member>
TabContainer bottom position
2023-09-27 21:23:22 +00:00
<member name="tabs_position" type="int" setter="set_tabs_position" getter="get_tabs_position" enum="TabContainer.TabPosition" default="0">
Sets the position of the tab bar. See [enum TabPosition] for details.
</member>
Change tabs_rearrange_group to property
2022-03-05 20:03:01 +00:00
<member name="tabs_rearrange_group" type="int" setter="set_tabs_rearrange_group" getter="get_tabs_rearrange_group" default="-1">
[TabContainer]s with the same rearrange group ID will allow dragging the tabs between them. Enable drag with [member drag_to_rearrange_enabled].
Setting this to [code]-1[/code] will disable rearranging between [TabContainer]s.
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 10:38:01 +00:00
<member name="tabs_visible" type="bool" setter="set_tabs_visible" getter="are_tabs_visible" default="true">
doc: Remove hardcoded default values from descriptions They are now generated automatically by doctool.
2019-06-29 13:24:23 +00:00
If [code]true[/code], tabs are visible. If [code]false[/code], tabs' content and titles are hidden.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</member>
doc: Sync classref with current source Fix a few missing bindings or unspecified argument names and default values.
2019-09-24 09:44:48 +00:00
<member name="use_hidden_tabs_for_min_size" type="bool" setter="set_use_hidden_tabs_for_min_size" getter="get_use_hidden_tabs_for_min_size" default="false">
[Doc] Fix some incorrect uses of "children"
2024-02-27 16:20:24 +00:00
If [code]true[/code], child [Control] nodes that are hidden have their minimum size take into account in the total, instead of only the currently visible one.
doc: Sync classref with current source Fix a few missing bindings or unspecified argument names and default values.
2019-09-24 09:44:48 +00:00
</member>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</members>
<signals>
Add more signals to `TabContainer` that `TabBar` already has
2023-04-23 15:50:35 +00:00
<signal name="active_tab_rearranged">
<param index="0" name="idx_to" type="int" />
<description>
Emitted when the active tab is rearranged via mouse drag. See [member drag_to_rearrange_enabled].
</description>
</signal>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<signal name="pre_popup_pressed">
<description>
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass] Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-29 22:37:35 +00:00
Emitted when the [TabContainer]'s [Popup] button is clicked. See [method set_popup] for details.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</signal>
Add action map editor for OpenXR
2022-03-16 23:24:47 +00:00
<signal name="tab_button_pressed">
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="tab" type="int" />
Add action map editor for OpenXR
2022-03-16 23:24:47 +00:00
<description>
Emitted when the user clicks on the button icon on this tab.
</description>
</signal>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<signal name="tab_changed">
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="tab" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
updated the TabContainer docs for depth and readability.
2017-10-21 04:31:45 +00:00
Emitted when switching to another tab.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</signal>
Add more signals to `TabContainer` that `TabBar` already has
2023-04-23 15:50:35 +00:00
<signal name="tab_clicked">
<param index="0" name="tab" type="int" />
<description>
Emitted when a tab is clicked, even if it is the current tab.
</description>
</signal>
<signal name="tab_hovered">
<param index="0" name="tab" type="int" />
<description>
Emitted when a tab is hovered by the mouse.
</description>
</signal>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<signal name="tab_selected">
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="tab" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
Fix disabled tabs being selected when removing the current one
2023-10-25 19:26:03 +00:00
Emitted when a tab is selected via click, directional input, or script, even if it is the current tab.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</signal>
</signals>
TabContainer bottom position
2023-09-27 21:23:22 +00:00
<constants>
<constant name="POSITION_TOP" value="0" enum="TabPosition">
Places the tab bar at the top.
</constant>
<constant name="POSITION_BOTTOM" value="1" enum="TabPosition">
Places the tab bar at the bottom. The tab bar's [StyleBox] will be flipped vertically.
</constant>
<constant name="POSITION_MAX" value="2" enum="TabPosition">
Represents the size of the [enum TabPosition] enum.
</constant>
</constants>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<theme_items>
Add visual marker when dragging and dropping tabs
2022-03-20 01:24:36 +00:00
<theme_item name="drop_mark_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)">
Modulation color for the [theme_item drop_mark] icon.
</theme_item>
Improve the default project theme The new default project theme uses StyleBoxFlat extensively for a more modern design and better scalability to multiple resolutions. SVG icons are now used in place of PNG icons. While this does not allow for true vector-based icon drawing (icons are still rasterized at load-time), this makes the design work easier for contributors and opens the door to vector drawing in the future (e.g. with polygons or SDFs). Like for editor icons, the SVG header file is now built automatically when a SVG file is changed. This removing the need for running `make_header.py` manually (TODO). The "Use Hidpi" project setting has been removed in favor of a "Default Theme Scale" project setting, which allows creating the default theme at a higher/lower scale than the default. This can be used when designing GUIs with a high base resolution to ensure crisp visuals. Co-authored-by: Yuri Sizov <yuris@humnom.net>
2021-12-30 16:22:06 +00:00
<theme_item name="font_disabled_color" data_type="color" type="Color" default="Color(0.875, 0.875, 0.875, 0.5)">
Add LOTS of missing docs
2020-03-03 18:21:21 +00:00
Font color of disabled tabs.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theming support for hovered tabs Tabs can now be styled differently when hovered by the mouse pointer.
2023-03-09 02:52:57 +00:00
<theme_item name="font_hovered_color" data_type="color" type="Color" default="Color(0.95, 0.95, 0.95, 1)">
Font color of the currently hovered tab.
</theme_item>
Use black for font outlines by default instead of white This makes font outlines more usable out of the box, as black is one of the most commonly used colors for font outlines.
2021-11-05 19:50:01 +00:00
<theme_item name="font_outline_color" data_type="color" type="Color" default="Color(0, 0, 0, 1)">
[CTL] Add missing font outline drawing routines and theme constants.
2020-12-25 21:45:28 +00:00
The tint of text outline of the tab name.
</theme_item>
Improve the default project theme The new default project theme uses StyleBoxFlat extensively for a more modern design and better scalability to multiple resolutions. SVG icons are now used in place of PNG icons. While this does not allow for true vector-based icon drawing (icons are still rasterized at load-time), this makes the design work easier for contributors and opens the door to vector drawing in the future (e.g. with polygons or SDFs). Like for editor icons, the SVG header file is now built automatically when a SVG file is changed. This removing the need for running `make_header.py` manually (TODO). The "Use Hidpi" project setting has been removed in favor of a "Default Theme Scale" project setting, which allows creating the default theme at a higher/lower scale than the default. This can be used when designing GUIs with a high base resolution to ensure crisp visuals. Co-authored-by: Yuri Sizov <yuris@humnom.net>
2021-12-30 16:22:06 +00:00
<theme_item name="font_selected_color" data_type="color" type="Color" default="Color(0.95, 0.95, 0.95, 1)">
Add LOTS of missing docs
2020-03-03 18:21:21 +00:00
Font color of the currently selected tab.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Improve the default project theme The new default project theme uses StyleBoxFlat extensively for a more modern design and better scalability to multiple resolutions. SVG icons are now used in place of PNG icons. While this does not allow for true vector-based icon drawing (icons are still rasterized at load-time), this makes the design work easier for contributors and opens the door to vector drawing in the future (e.g. with polygons or SDFs). Like for editor icons, the SVG header file is now built automatically when a SVG file is changed. This removing the need for running `make_header.py` manually (TODO). The "Use Hidpi" project setting has been removed in favor of a "Default Theme Scale" project setting, which allows creating the default theme at a higher/lower scale than the default. This can be used when designing GUIs with a high base resolution to ensure crisp visuals. Co-authored-by: Yuri Sizov <yuris@humnom.net>
2021-12-30 16:22:06 +00:00
<theme_item name="font_unselected_color" data_type="color" type="Color" default="Color(0.7, 0.7, 0.7, 1)">
doc: Sync classref with current source
2021-01-28 10:26:37 +00:00
Font color of the other, unselected tabs.
</theme_item>
Make icons of scripted and custom classes fit the editor UI Also: - Add an option to limit the icon size in PopupMenu. This is similar to how this works in Tree and TreeItem. - Add the same option to TabBar. - Add a theme constant for Tree, PopupMenu, Button, and TabBar to apply this limit on the control level. Co-authored-by: Daylily-Zeleen <daylily-zeleen@foxmail.com>
2023-03-31 19:17:59 +00:00
<theme_item name="icon_max_width" data_type="constant" type="int" default="0">
The maximum allowed width of the tab's icon. This limit is applied on top of the default size of the icon, but before the value set with [method TabBar.set_tab_icon_max_width]. The height is adjusted according to the icon's ratio.
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="icon_separation" data_type="constant" type="int" default="4">
Clarifies 'icon_separation' in TabContainer (instead of 'hseparation') Fixes: #38911
2020-05-21 19:53:17 +00:00
Space between tab's name and its icon.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 18:02:20 +00:00
<theme_item name="outline_size" data_type="constant" type="int" default="0">
The size of the tab text outline.
Document MDSF font outlines may require `msdf_pixel_range` adjustments
2022-12-19 16:15:44 +00:00
[b]Note:[/b] If using a font with [member FontFile.multichannel_signed_distance_field] enabled, its [member FontFile.msdf_pixel_range] must be set to at least [i]twice[/i] the value of [theme_item outline_size] for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended.
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 18:02:20 +00:00
</theme_item>
<theme_item name="side_margin" data_type="constant" type="int" default="8">
Make `TabContainer` use `TabBar` internally
2022-03-02 14:37:10 +00:00
The space at the left or right edges of the tab bar, accordingly with the current [member tab_alignment].
Style: Misc docs and comment style and language fixes - Removed empty paragraphs in XML. - Consistently use bold style for "Example:", on a new line. - Fix usage of `[code]` when hyperlinks could be used (`[member]`, `[constant]`). - Fix invalid usage of backticks for inline code in BBCode. - Fix some American/British English spelling inconsistencies. - Other minor fixes spotted along the way, including typo fixes with codespell. - Don't specify `@GlobalScope` for `enum` and `constant`.
2022-11-01 14:29:38 +00:00
The margin is ignored with [constant TabBar.ALIGNMENT_RIGHT] if the tabs are clipped (see [member clip_tabs]) or a popup has been set (see [method set_popup]). The margin is always ignored with [constant TabBar.ALIGNMENT_CENTER].
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 18:02:20 +00:00
</theme_item>
<theme_item name="font" data_type="font" type="Font">
The font used to draw tab names.
</theme_item>
<theme_item name="font_size" data_type="font_size" type="int">
Font size of the tab names.
</theme_item>
<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" 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>
Add visual marker when dragging and dropping tabs
2022-03-20 01:24:36 +00:00
<theme_item name="drop_mark" data_type="icon" type="Texture2D">
Icon shown to indicate where a dragged tab is gonna be dropped (see [member drag_to_rearrange_enabled]).
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="increment" data_type="icon" type="Texture2D">
Add LOTS of missing docs
2020-03-03 18:21:21 +00:00
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.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="increment_highlight" data_type="icon" type="Texture2D">
Add LOTS of missing docs
2020-03-03 18:21:21 +00:00
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.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="menu" data_type="icon" type="Texture2D">
Add LOTS of missing docs
2020-03-03 18:21:21 +00:00
The icon for the menu button (see [method set_popup]).
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="menu_highlight" data_type="icon" type="Texture2D">
Add LOTS of missing docs
2020-03-03 18:21:21 +00:00
The icon for the menu button (see [method set_popup]) when it's being hovered with the cursor.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="panel" data_type="style" type="StyleBox">
Add LOTS of missing docs
2020-03-03 18:21:21 +00:00
The style for the background fill.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="tab_disabled" data_type="style" type="StyleBox">
Add LOTS of missing docs
2020-03-03 18:21:21 +00:00
The style of disabled tabs.
Expose OS::get_current_video_driver to scripting languages
2019-02-16 13:40:52 +00:00
</theme_item>
Allow to focus individual tabs in TabBar/TabContainer
2023-06-25 15:56:52 +00:00
<theme_item name="tab_focus" data_type="style" type="StyleBox">
[StyleBox] used when the [TabBar] is focused. The [theme_item tab_focus] [StyleBox] is displayed [i]over[/i] the base [StyleBox] of the selected tab, so a partially transparent [StyleBox] should be used to ensure the base [StyleBox] remains visible. A [StyleBox] that represents an outline or an underline works well for this purpose. To disable the focus visual effect, assign a [StyleBoxEmpty] resource. Note that disabling the focus visual effect will harm keyboard/controller navigation usability, so this is not recommended for accessibility reasons.
</theme_item>
Add theming support for hovered tabs Tabs can now be styled differently when hovered by the mouse pointer.
2023-03-09 02:52:57 +00:00
<theme_item name="tab_hovered" data_type="style" type="StyleBox">
The style of the currently hovered tab.
Make hovered tabs be drawn with the unselected's width at minimum
2023-09-26 17:12:08 +00:00
[b]Note:[/b] This style will be drawn with the same width as [theme_item tab_unselected] at minimum.
Add theming support for hovered tabs Tabs can now be styled differently when hovered by the mouse pointer.
2023-03-09 02:52:57 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="tab_selected" data_type="style" type="StyleBox">
Add LOTS of missing docs
2020-03-03 18:21:21 +00:00
The style of the currently selected tab.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-04 16:54:41 +00:00
<theme_item name="tab_unselected" data_type="style" type="StyleBox">
Change themes *_color_* to *_*_color Changed: font_color_accel -> font_accelerator_color font_color_bg -> font_unselected_color font_color_disabled -> font_disabled_color font_color_fg -> font_selected_color font_color_hover -> font_hover_color font_color_hover_pressed -> font_hover_pressed_color font_color_pressed -> font_pressed_color font_color_readonly -> font_readonly_color font_color_selected -> font_selected_color font_color_shadow -> font_shadow_color font_color_uneditable -> font_uneditable_color icon_color_disabled -> icon_disabled_color icon_color_hover -> icon_hover_color icon_color_hover_pressed -> icon_hover_pressed_color icon_color_normal -> icon_normal_color icon_color_pressed -> icon_pressed_color Also includes: font_outline_modulate -> font_outline_color tab_fg -> tab_selected tab_bg -> tab_unselected
2020-12-08 13:11:45 +00:00
The style of the other, unselected tabs.
</theme_item>
Add background to TabContainer's tabbar and editor docks
2022-08-29 14:40:17 +00:00
<theme_item name="tabbar_background" data_type="style" type="StyleBox">
The style for the background fill of the [TabBar] area.
</theme_item>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</theme_items>
</class>