asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/doc/classes/TabContainer.xml

257 lines
12 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 22:42:36 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
Bump version to 3.6-beta
2022-08-05 18:51:38 +02:00
<class name="TabContainer" inherits="Container" version="3.6" 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 22:42:36 +02:00
<brief_description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Tabbed container.
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 22:42:36 +02:00
</brief_description>
<description>
Clarify usage of TabContainer Makes it more clear that TabBar is separate from TabContainer, and that the container draws the tabs itself. (cherry picked from commit 5c645d510fe2e5d5b385b3cf8e9e12b92768d069)
2021-11-29 05:14:24 +01:00
Arranges [Control] children into a tabbed view, creating a tab for each one. The active tab's corresponding [Control] has its [code]visible[/code] property set to [code]true[/code], and all other children's to [code]false[/code].
classref: Sync with current source Also fix hyperlink references to same class as per the guidelines. [ci skip]
2017-10-22 12:56:11 +02:00
Ignores non-[Control] children.
doc: Fixup Tabs reference after cherry-pick
2021-11-30 14:46:11 +01:00
[b]Note:[/b] The drawing of the clickable tabs themselves is handled by this node. Adding [Tabs] as children 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 22:42:36 +02:00
</description>
<tutorials>
Link to Container tutorial Users happening across any of the Container pages may not already know the intent of Containers, or which others are available. This commit adds a link to the existing "GUI containers" page in their tutorials sections. (cherry picked from commit 3b941ed98cfb1f72c35684f1d4d458dacd482c63)
2022-04-21 08:16:02 +02:00
<link title="GUI 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 22:42:36 +02: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02: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 22:42:36 +02:00
<description>
classref: Sync with current source Also fix hyperlink references to same class as per the guidelines. [ci skip]
2017-10-22 12:56:11 +02: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 22:42:36 +02: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02: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 22:42:36 +02:00
<description>
classref: Sync with current source Also fix hyperlink references to same class as per the guidelines. [ci skip]
2017-10-22 12:56:11 +02: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 22:10:07 +02: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 CanvasItem.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 22:42:36 +02: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02: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 22:42:36 +02:00
<description>
classref: Sync with current source Also fix hyperlink references to same class as per the guidelines. [ci skip]
2017-10-22 12:56:11 +02: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 22:42:36 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Control" />
<argument 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 22:42:36 +02:00
<description>
Fix incorrect TabContainer documentation for 'get_tab_control()' (cherry picked from commit 8f925b197041dcca02313778ce9166eccc47918b)
2020-03-14 14:47:36 +01:00
Returns the [Control] node from the tab at index [code]tab_idx[/code].
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 22:42:36 +02: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02: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 22:42:36 +02:00
<description>
updated the TabContainer docs for depth and readability.
2017-10-21 06:31:45 +02: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 22:42:36 +02:00
</description>
</method>
<method name="get_tab_disabled" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="bool" />
<argument 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 22:42:36 +02:00
<description>
[DOCS] TabContainer class descriptions
2017-10-12 21:29:43 +02:00
Returns [code]true[/code] if the tab at index [code]tab_idx[/code] is disabled.
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 22:42:36 +02:00
</description>
</method>
Expose `TabContainer`'s tab hidding for scripts (cherry picked from commit 7ce02b642eee600b7206563030c8feaa8af3fe5b)
2021-09-24 06:26:59 +02:00
<method name="get_tab_hidden" qualifiers="const">
<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 hidden.
</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 22:42:36 +02:00
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Texture" />
<argument 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 22:42:36 +02:00
<description>
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-22 01:04:47 +02:00
Returns the [Texture] for the tab at index [code]tab_idx[/code] or [code]null[/code] if the tab has no [Texture].
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 22:42:36 +02:00
</description>
</method>
Bind TabContainer::get_tab_idx_at_point() to ClassDB
2021-08-24 17:22:38 +02:00
<method name="get_tab_idx_at_point" qualifiers="const">
<return type="int" />
<argument index="0" name="point" type="Vector2" />
<description>
Returns the index of the tab at local coordinates [code]point[/code]. Returns [code]-1[/code] if the point is outside the control boundaries or if there's no tab at the queried position.
</description>
</method>
Add Tab Metadata
2023-04-12 02:24:52 +02:00
<method name="get_tab_metadata" qualifiers="const">
<return type="Variant" />
<argument index="0" name="tab_idx" type="int" />
<description>
Returns the metadata value set to the tab at index [code]tab_idx[/code]. 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 22:42:36 +02: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="String" />
<argument 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 22:42:36 +02:00
<description>
updated the TabContainer docs for depth and readability.
2017-10-21 06:31:45 +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].
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 22:42:36 +02:00
</description>
</method>
doc: Sync classref with current source
2018-04-10 10:12:42 +02:00
<method name="get_tabs_rearrange_group" 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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="int" />
doc: Sync classref with current source
2018-04-10 10:12:42 +02:00
<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 23:37:35 +01:00
Returns the [TabContainer] rearrange group id.
doc: Sync classref with current source
2018-04-10 10:12:42 +02: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 22:42:36 +02: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument 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 22:42:36 +02:00
<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 23:37:35 +01:00
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.
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 22:42:36 +02:00
</description>
</method>
<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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="tab_idx" type="int" />
<argument 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 22:42:36 +02:00
<description>
Expose `TabContainer`'s tab hidding for scripts (cherry picked from commit 7ce02b642eee600b7206563030c8feaa8af3fe5b)
2021-09-24 06:26:59 +02:00
If [code]disabled[/code] is [code]true[/code], disables the tab at index [code]tab_idx[/code], making it non-interactable.
</description>
</method>
<method name="set_tab_hidden">
<return type="void" />
<argument index="0" name="tab_idx" type="int" />
<argument index="1" name="hidden" type="bool" />
<description>
If [code]hidden[/code] is [code]true[/code], hides the tab at index [code]tab_idx[/code], 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 22:42:36 +02: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="tab_idx" type="int" />
<argument index="1" name="icon" type="Texture" />
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 22:42:36 +02:00
<description>
updated the TabContainer docs for depth and readability.
2017-10-21 06:31:45 +02:00
Sets an icon for the tab at index [code]tab_idx[/code].
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 22:42:36 +02:00
</description>
</method>
Add Tab Metadata
2023-04-12 02:24:52 +02:00
<method name="set_tab_metadata">
<return type="void" />
<argument index="0" name="tab_idx" type="int" />
<argument index="1" name="metadata" type="Variant" />
<description>
Sets the metadata value for the tab at index [code]tab_idx[/code].
</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 22:42:36 +02: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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="tab_idx" type="int" />
<argument 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 22:42:36 +02:00
<description>
Expose `TabContainer`'s tab hidding for scripts (cherry picked from commit 7ce02b642eee600b7206563030c8feaa8af3fe5b)
2021-09-24 06:26:59 +02:00
Sets a title for the tab at index [code]tab_idx[/code]. Tab titles default to the name of the indexed child 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 22:42:36 +02:00
</description>
</method>
doc: Sync classref with current source
2018-04-10 10:12:42 +02:00
<method name="set_tabs_rearrange_group">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
<argument index="0" name="group_id" type="int" />
doc: Sync classref with current source
2018-04-10 10:12:42 +02:00
<description>
Expose `TabContainer`'s tab hidding for scripts (cherry picked from commit 7ce02b642eee600b7206563030c8feaa8af3fe5b)
2021-09-24 06:26:59 +02:00
Defines rearrange group id, choose for each [TabContainer] the same value to enable tab drag between [TabContainer]. Enable drag with [member drag_to_rearrange_enabled].
doc: Sync classref with current source
2018-04-10 10:12:42 +02: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 22:42:36 +02:00
</methods>
<members>
doc: Sync classref with current source And fix broken doctool after #43948.
2020-12-10 14:22:31 +01: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>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="current_tab" type="int" setter="set_current_tab" getter="get_current_tab" default="0">
classref: Sync with current source Also fix hyperlink references to same class as per the guidelines. [ci skip]
2017-10-22 12:56:11 +02: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].
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 22:42:36 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
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">
Doc Tabcontainer rearrange tabs
2018-10-14 15:58:06 +02:00
If [code]true[/code], tabs can be rearranged with mouse drag.
doc: Sync classref with current source
2018-04-10 10:12:42 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02:00
<member name="tab_align" type="int" setter="set_tab_align" getter="get_tab_align" enum="TabContainer.TabAlign" default="1">
doc: Markup fixes for enums and constants
2019-12-06 23:09:20 +01:00
The alignment of all tabs in the tab container. See the [enum TabAlign] constants 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 22:42:36 +02:00
</member>
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380.
2019-06-29 12:38:01 +02: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 15:24:23 +02: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 22:42:36 +02:00
</member>
doc: Sync classref with current source Fix a few missing bindings or unspecified argument names and default values.
2019-09-24 11:44:48 +02: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">
Document TabContainer's "use_hidden_tabs_for_min_size"
2020-01-03 20:48:27 +01:00
If [code]true[/code], children [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 11:44:48 +02: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 22:42:36 +02:00
</members>
<signals>
<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 23:37:35 +01: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 22:42:36 +02:00
</description>
</signal>
<signal name="tab_changed">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<argument 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 22:42:36 +02:00
<description>
updated the TabContainer docs for depth and readability.
2017-10-21 06:31:45 +02: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 22:42:36 +02:00
</description>
</signal>
<signal name="tab_selected">
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. (cherry picked from commit 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<argument 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 22:42:36 +02:00
<description>
updated the TabContainer docs for depth and readability.
2017-10-21 06:31:45 +02:00
Emitted when a tab is selected, 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 22:42:36 +02:00
</description>
</signal>
</signals>
<constants>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ALIGN_LEFT" value="0" enum="TabAlign">
Doc Tabcontainer rearrange tabs
2018-10-14 15:58:06 +02:00
Align the tabs to the left.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ALIGN_CENTER" value="1" enum="TabAlign">
Doc Tabcontainer rearrange tabs
2018-10-14 15:58:06 +02:00
Align the tabs to the center.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
<constant name="ALIGN_RIGHT" value="2" enum="TabAlign">
Doc Tabcontainer rearrange tabs
2018-10-14 15:58:06 +02:00
Align the tabs to the right.
doc: Sync classref with current source [ci skip]
2017-09-16 01:46:14 +02:00
</constant>
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 22:42:36 +02:00
</constants>
<theme_items>
Add theme item descriptions to the online documentation
2021-08-06 17:07:21 +02:00
<theme_item name="font_color_bg" data_type="color" type="Color" default="Color( 0.69, 0.69, 0.69, 1 )">
Add LOTS of missing docs (cherry picked from commit e103f21a40ef157cd263b60cf0d9c5750156ec98)
2020-03-03 19:21:21 +01:00
Font color of inactive 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 22:42:36 +02:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 17:07:21 +02:00
<theme_item name="font_color_disabled" data_type="color" type="Color" default="Color( 0.9, 0.9, 0.9, 0.2 )">
Add LOTS of missing docs (cherry picked from commit e103f21a40ef157cd263b60cf0d9c5750156ec98)
2020-03-03 19:21:21 +01: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 22:42:36 +02:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 17:07:21 +02:00
<theme_item name="font_color_fg" data_type="color" type="Color" default="Color( 0.94, 0.94, 0.94, 1 )">
Add LOTS of missing docs (cherry picked from commit e103f21a40ef157cd263b60cf0d9c5750156ec98)
2020-03-03 19:21:21 +01: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 22:42:36 +02:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 17:07:21 +02:00
<theme_item name="hseparation" data_type="constant" type="int" default="4">
Add LOTS of missing docs (cherry picked from commit e103f21a40ef157cd263b60cf0d9c5750156ec98)
2020-03-03 19:21:21 +01:00
Horizontal separation between 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 22:42:36 +02:00
</theme_item>
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 20:45:12 +01:00
<theme_item name="label_valign_bg" data_type="constant" type="int" default="2">
</theme_item>
<theme_item name="label_valign_fg" data_type="constant" type="int" default="0">
</theme_item>
<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="top_margin" data_type="constant" type="int" default="24">
</theme_item>
<theme_item name="font" data_type="font" type="Font">
The font used to draw tab names.
</theme_item>
<theme_item name="decrement" data_type="icon" type="Texture">
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="Texture">
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 theme item descriptions to the online documentation
2021-08-06 17:07:21 +02:00
<theme_item name="increment" data_type="icon" type="Texture">
Add LOTS of missing docs (cherry picked from commit e103f21a40ef157cd263b60cf0d9c5750156ec98)
2020-03-03 19:21:21 +01: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 22:42:36 +02:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 17:07:21 +02:00
<theme_item name="increment_highlight" data_type="icon" type="Texture">
Add LOTS of missing docs (cherry picked from commit e103f21a40ef157cd263b60cf0d9c5750156ec98)
2020-03-03 19:21:21 +01: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 22:42:36 +02:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 17:07:21 +02:00
<theme_item name="menu" data_type="icon" type="Texture">
Add LOTS of missing docs (cherry picked from commit e103f21a40ef157cd263b60cf0d9c5750156ec98)
2020-03-03 19:21:21 +01: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 22:42:36 +02:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 17:07:21 +02:00
<theme_item name="menu_highlight" data_type="icon" type="Texture">
Add LOTS of missing docs (cherry picked from commit e103f21a40ef157cd263b60cf0d9c5750156ec98)
2020-03-03 19:21:21 +01: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 22:42:36 +02:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 17:07:21 +02:00
<theme_item name="panel" data_type="style" type="StyleBox">
Add LOTS of missing docs (cherry picked from commit e103f21a40ef157cd263b60cf0d9c5750156ec98)
2020-03-03 19:21:21 +01: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 22:42:36 +02:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 17:07:21 +02:00
<theme_item name="tab_bg" data_type="style" type="StyleBox">
Add LOTS of missing docs (cherry picked from commit e103f21a40ef157cd263b60cf0d9c5750156ec98)
2020-03-03 19:21:21 +01:00
The style of inactive 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 22:42:36 +02:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 17:07:21 +02:00
<theme_item name="tab_disabled" data_type="style" type="StyleBox">
Add LOTS of missing docs (cherry picked from commit e103f21a40ef157cd263b60cf0d9c5750156ec98)
2020-03-03 19:21:21 +01:00
The style of disabled tabs.
Expose OS::get_current_video_driver to scripting languages
2019-02-16 14:40:52 +01:00
</theme_item>
Add theme item descriptions to the online documentation
2021-08-06 17:07:21 +02:00
<theme_item name="tab_fg" data_type="style" type="StyleBox">
Add LOTS of missing docs (cherry picked from commit e103f21a40ef157cd263b60cf0d9c5750156ec98)
2020-03-03 19:21:21 +01: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 22:42:36 +02:00
</theme_item>
</theme_items>
</class>
Reference in a new issue Copy permalink