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

492 lines
23 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" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-03-16 22:01:02 +00:00
<class name="Theme" inherits="Resource" version="3.5" 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>
Theme for controls.
</brief_description>
<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-21 23:04:47 +00:00
A theme for skinning controls. Controls can be skinned individually, but for complex applications, it's more practical to just create a global theme that defines everything. This theme can be applied to any [Control]; the Control and its children will automatically use it.
Theme resources can alternatively be loaded by writing them in a [code].theme[/code] file, see the documentation for more information.
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>
Fix broken links in Class Reference
2021-12-10 10:29:38 +00:00
<link>$DOCS_URL/tutorials/ui/gui_skinning.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>
Add an explicit way to remove a theme type Co-Authored-by: Yuri Sizov <yuris@humnom.net>
2022-04-05 03:46:47 +00:00
<method name="add_type">
<return type="void" />
<argument index="0" name="theme_type" type="String" />
<description>
Adds an empty theme type for every valid data type.
[b]Note:[/b] Empty types are not saved with the theme. This method only exists to perform in-memory changes to the resource. Use available [code]set_*[/code] methods to add theme items.
</description>
</method>
doc: Sync classref with current source
2018-12-04 20:57:07 +00:00
<method name="clear">
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 13:28:05 +00:00
<return type="void" />
doc: Sync classref with current source
2018-12-04 20:57:07 +00:00
<description>
Add descriptions to clear and copy_theme.
2019-10-31 06:04:58 +00:00
Clears all values on the theme.
doc: Sync classref with current source
2018-12-04 20:57:07 +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="clear_color">
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 13:28:05 +00:00
<return type="void" />
<argument index="0" name="name" type="String" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="1" name="theme_type" 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>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order. See https://github.com/godotengine/godot-proposals/issues/1495#issuecomment-691507839
2020-09-12 16:30:40 +00:00
Clears the [Color] at [code]name[/code] if the theme has [code]node_type[/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 20:42:36 +00:00
</description>
</method>
<method name="clear_constant">
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 13:28:05 +00:00
<return type="void" />
<argument index="0" name="name" type="String" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="1" name="theme_type" 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>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order. See https://github.com/godotengine/godot-proposals/issues/1495#issuecomment-691507839
2020-09-12 16:30:40 +00:00
Clears the constant at [code]name[/code] if the theme has [code]node_type[/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 20:42:36 +00:00
</description>
</method>
<method name="clear_font">
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 13:28:05 +00:00
<return type="void" />
<argument index="0" name="name" type="String" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="1" name="theme_type" 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>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order. See https://github.com/godotengine/godot-proposals/issues/1495#issuecomment-691507839
2020-09-12 16:30:40 +00:00
Clears the [Font] at [code]name[/code] if the theme has [code]node_type[/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 20:42:36 +00:00
</description>
</method>
<method name="clear_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 13:28:05 +00:00
<return type="void" />
<argument index="0" name="name" type="String" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="1" name="theme_type" 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>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order. See https://github.com/godotengine/godot-proposals/issues/1495#issuecomment-691507839
2020-09-12 16:30:40 +00:00
Clears the icon at [code]name[/code] if the theme has [code]node_type[/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 20:42:36 +00:00
</description>
</method>
<method name="clear_stylebox">
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 13:28:05 +00:00
<return type="void" />
<argument index="0" name="name" type="String" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="1" name="theme_type" 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>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order. See https://github.com/godotengine/godot-proposals/issues/1495#issuecomment-691507839
2020-09-12 16:30:40 +00:00
Clears [StyleBox] at [code]name[/code] if the theme has [code]node_type[/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 20:42:36 +00:00
</description>
</method>
Add utility methods to Theme, improve error messages and documentation Backport of relevant parts of #47251, #49308
2021-06-10 13:23:00 +00:00
<method name="clear_theme_item">
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 13:28:05 +00:00
<return type="void" />
<argument index="0" name="data_type" type="int" enum="Theme.DataType" />
<argument index="1" name="name" type="String" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="2" name="theme_type" type="String" />
Add utility methods to Theme, improve error messages and documentation Backport of relevant parts of #47251, #49308
2021-06-10 13:23:00 +00:00
<description>
Clears the theme item of [code]data_type[/code] at [code]name[/code] if the theme has [code]node_type[/code].
</description>
</method>
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<method name="clear_type_variation">
<return type="void" />
<argument index="0" name="theme_type" type="String" />
<description>
Unmarks [code]theme_type[/code] as being a variation of another theme type. See [method set_type_variation].
</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="copy_default_theme">
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 13:28:05 +00:00
<return type="void" />
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: Markup fixes for enums and constants
2019-12-06 22:09:20 +00:00
Sets the theme's values to a copy of the default theme values.
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>
doc: Sync classref with current source
2019-01-26 21:21:53 +00:00
<method name="copy_theme">
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 13:28:05 +00:00
<return type="void" />
<argument index="0" name="other" type="Theme" />
doc: Sync classref with current source
2019-01-26 21:21:53 +00:00
<description>
doc: Markup fixes for enums and constants
2019-12-06 22:09:20 +00:00
Sets the theme's values to a copy of a given theme.
doc: Sync classref with current source
2019-01-26 21:21:53 +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_color" 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 13:28:05 +00:00
<return type="Color" />
<argument index="0" name="name" type="String" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="1" name="theme_type" 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>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order. See https://github.com/godotengine/godot-proposals/issues/1495#issuecomment-691507839
2020-09-12 16:30:40 +00:00
Returns the [Color] at [code]name[/code] if the theme has [code]node_type[/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 20:42:36 +00:00
</description>
</method>
<method name="get_color_list" 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 13:28:05 +00:00
<return type="PoolStringArray" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="0" name="theme_type" 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>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order. See https://github.com/godotengine/godot-proposals/issues/1495#issuecomment-691507839
2020-09-12 16:30:40 +00:00
Returns all the [Color]s as a [PoolStringArray] filled with each [Color]'s name, for use in [method get_color], if the theme has [code]node_type[/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 20:42:36 +00:00
</description>
</method>
Expose missing Theme methods Backport of relevant, non-breaking parts of #37759
2021-06-10 12:28:47 +00:00
<method name="get_color_types" 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 13:28:05 +00:00
<return type="PoolStringArray" />
Expose missing Theme methods Backport of relevant, non-breaking parts of #37759
2021-06-10 12:28:47 +00:00
<description>
Returns all the [Color] types as a [PoolStringArray] filled with unique type names, for use in [method get_color] and/or [method get_color_list].
</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_constant" 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 13:28:05 +00:00
<return type="int" />
<argument index="0" name="name" type="String" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="1" name="theme_type" 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>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order. See https://github.com/godotengine/godot-proposals/issues/1495#issuecomment-691507839
2020-09-12 16:30:40 +00:00
Returns the constant at [code]name[/code] if the theme has [code]node_type[/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 20:42:36 +00:00
</description>
</method>
<method name="get_constant_list" 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 13:28:05 +00:00
<return type="PoolStringArray" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="0" name="theme_type" 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>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order. See https://github.com/godotengine/godot-proposals/issues/1495#issuecomment-691507839
2020-09-12 16:30:40 +00:00
Returns all the constants as a [PoolStringArray] filled with each constant's name, for use in [method get_constant], if the theme has [code]node_type[/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 20:42:36 +00:00
</description>
</method>
Expose missing Theme methods Backport of relevant, non-breaking parts of #37759
2021-06-10 12:28:47 +00:00
<method name="get_constant_types" 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 13:28:05 +00:00
<return type="PoolStringArray" />
Expose missing Theme methods Backport of relevant, non-breaking parts of #37759
2021-06-10 12:28:47 +00:00
<description>
Returns all the constant types as a [PoolStringArray] filled with unique type names, for use in [method get_constant] and/or [method get_constant_list].
</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_font" 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 13:28:05 +00:00
<return type="Font" />
<argument index="0" name="name" type="String" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="1" name="theme_type" 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>
Unify theme item lookup in Controls and respect default font
2021-11-30 20:29:18 +00:00
Returns the [Font] at [code]name[/code] if the theme has [code]node_type[/code]. If such item does not exist and [member default_font] is set on the theme, the default font will be returned.
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_font_list" 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 13:28:05 +00:00
<return type="PoolStringArray" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="0" name="theme_type" 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>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order. See https://github.com/godotengine/godot-proposals/issues/1495#issuecomment-691507839
2020-09-12 16:30:40 +00:00
Returns all the [Font]s as a [PoolStringArray] filled with each [Font]'s name, for use in [method get_font], if the theme has [code]node_type[/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 20:42:36 +00:00
</description>
</method>
Expose missing Theme methods Backport of relevant, non-breaking parts of #37759
2021-06-10 12:28:47 +00:00
<method name="get_font_types" 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 13:28:05 +00:00
<return type="PoolStringArray" />
Expose missing Theme methods Backport of relevant, non-breaking parts of #37759
2021-06-10 12:28:47 +00:00
<description>
Returns all the [Font] types as a [PoolStringArray] filled with unique type names, for use in [method get_font] and/or [method get_font_list].
</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_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 13:28:05 +00:00
<return type="Texture" />
<argument index="0" name="name" type="String" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="1" name="theme_type" 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>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order. See https://github.com/godotengine/godot-proposals/issues/1495#issuecomment-691507839
2020-09-12 16:30:40 +00:00
Returns the icon [Texture] at [code]name[/code] if the theme has [code]node_type[/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 20:42:36 +00:00
</description>
</method>
<method name="get_icon_list" 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 13:28:05 +00:00
<return type="PoolStringArray" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="0" name="theme_type" 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>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order. See https://github.com/godotengine/godot-proposals/issues/1495#issuecomment-691507839
2020-09-12 16:30:40 +00:00
Returns all the icons as a [PoolStringArray] filled with each [Texture]'s name, for use in [method get_icon], if the theme has [code]node_type[/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 20:42:36 +00:00
</description>
</method>
Expose missing Theme methods Backport of relevant, non-breaking parts of #37759
2021-06-10 12:28:47 +00:00
<method name="get_icon_types" 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 13:28:05 +00:00
<return type="PoolStringArray" />
Expose missing Theme methods Backport of relevant, non-breaking parts of #37759
2021-06-10 12:28:47 +00:00
<description>
Returns all the icon types as a [PoolStringArray] filled with unique type names, for use in [method get_icon] and/or [method get_icon_list].
</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_stylebox" 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 13:28:05 +00:00
<return type="StyleBox" />
<argument index="0" name="name" type="String" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="1" name="theme_type" 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>
[docs] Clarification on theme's get_stylebox Remove reference to "icon" (must have been a copy-paste error) & clarify where to find out what names & node_types are valid. (cherry picked from commit d397c3216906fa59d49f041a7a4038d8cfe2f6e2)
2021-02-20 15:10:28 +00:00
Returns the [StyleBox] at [code]name[/code] if the theme has [code]node_type[/code].
Valid [code]name[/code]s may be found using [method get_stylebox_list]. Valid [code]node_type[/code]s may be found using [method get_stylebox_types].
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_stylebox_list" 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 13:28:05 +00:00
<return type="PoolStringArray" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="0" name="theme_type" 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>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order. See https://github.com/godotengine/godot-proposals/issues/1495#issuecomment-691507839
2020-09-12 16:30:40 +00:00
Returns all the [StyleBox]s as a [PoolStringArray] filled with each [StyleBox]'s name, for use in [method get_stylebox], if the theme has [code]node_type[/code].
[docs] Clarification on theme's get_stylebox Remove reference to "icon" (must have been a copy-paste error) & clarify where to find out what names & node_types are valid. (cherry picked from commit d397c3216906fa59d49f041a7a4038d8cfe2f6e2)
2021-02-20 15:10:28 +00:00
Valid [code]node_type[/code]s may be found using [method get_stylebox_types].
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_stylebox_types" 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 13:28:05 +00:00
<return type="PoolStringArray" />
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>
Expose missing Theme methods Backport of relevant, non-breaking parts of #37759
2021-06-10 12:28:47 +00:00
Returns all the [StyleBox] types as a [PoolStringArray] filled with unique type names, for use in [method get_stylebox] and/or [method get_stylebox_list].
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 utility methods to Theme, improve error messages and documentation Backport of relevant parts of #47251, #49308
2021-06-10 13:23:00 +00:00
<method name="get_theme_item" 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 13:28:05 +00:00
<return type="Variant" />
<argument index="0" name="data_type" type="int" enum="Theme.DataType" />
<argument index="1" name="name" type="String" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="2" name="theme_type" type="String" />
Add utility methods to Theme, improve error messages and documentation Backport of relevant parts of #47251, #49308
2021-06-10 13:23:00 +00:00
<description>
Returns the theme item of [code]data_type[/code] at [code]name[/code] if the theme has [code]node_type[/code].
Valid [code]name[/code]s may be found using [method get_theme_item_list] or a data type specific method. Valid [code]node_type[/code]s may be found using [method get_theme_item_types] or a data type specific method.
</description>
</method>
<method name="get_theme_item_list" 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 13:28:05 +00:00
<return type="PoolStringArray" />
<argument index="0" name="data_type" type="int" enum="Theme.DataType" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="1" name="theme_type" type="String" />
Add utility methods to Theme, improve error messages and documentation Backport of relevant parts of #47251, #49308
2021-06-10 13:23:00 +00:00
<description>
Returns all the theme items of [code]data_type[/code] as a [PoolStringArray] filled with each theme items's name, for use in [method get_theme_item] or a data type specific method, if the theme has [code]node_type[/code].
Valid [code]node_type[/code]s may be found using [method get_theme_item_types] or a data type specific method.
</description>
</method>
<method name="get_theme_item_types" 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 13:28:05 +00:00
<return type="PoolStringArray" />
<argument index="0" name="data_type" type="int" enum="Theme.DataType" />
Add utility methods to Theme, improve error messages and documentation Backport of relevant parts of #47251, #49308
2021-06-10 13:23:00 +00:00
<description>
Returns all the theme items of [code]data_type[/code] types as a [PoolStringArray] filled with unique type names, for use in [method get_theme_item], [method get_theme_item_list] or data type specific methods.
</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_type_list" 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 13:28:05 +00:00
<return type="PoolStringArray" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="0" name="theme_type" 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>
Expose missing Theme methods Backport of relevant, non-breaking parts of #37759
2021-06-10 12:28:47 +00:00
Returns all the theme types as a [PoolStringArray] filled with unique type names, for use in other [code]get_*[/code] functions of this theme.
[b]Note:[/b] [code]node_type[/code] has no effect and will be removed in future version.
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 type variations to Theme
2022-02-10 21:26:09 +00:00
<method name="get_type_variation_base" qualifiers="const">
<return type="String" />
<argument index="0" name="theme_type" type="String" />
<description>
Returns the name of the base theme type if [code]theme_type[/code] is a valid variation type. Returns an empty string otherwise.
</description>
</method>
<method name="get_type_variation_list" qualifiers="const">
<return type="PoolStringArray" />
<argument index="0" name="base_type" type="String" />
<description>
Returns a list of all type variations for the given [code]base_type[/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 20:42:36 +00:00
<method name="has_color" 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 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="name" type="String" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="1" name="theme_type" 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>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order. See https://github.com/godotengine/godot-proposals/issues/1495#issuecomment-691507839
2020-09-12 16:30:40 +00:00
Returns [code]true[/code] if [Color] with [code]name[/code] is in [code]node_type[/code].
Returns [code]false[/code] if the theme does not have [code]node_type[/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 20:42:36 +00:00
</description>
</method>
<method name="has_constant" 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 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="name" type="String" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="1" name="theme_type" 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>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order. See https://github.com/godotengine/godot-proposals/issues/1495#issuecomment-691507839
2020-09-12 16:30:40 +00:00
Returns [code]true[/code] if constant with [code]name[/code] is in [code]node_type[/code].
Returns [code]false[/code] if the theme does not have [code]node_type[/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 20:42:36 +00:00
</description>
</method>
Expose API to retrieve Theme's default font
2021-10-04 14:44:53 +00:00
<method name="has_default_font" qualifiers="const">
<return type="bool" />
<description>
Returns [code]true[/code] if this theme has a valid [member default_font] value.
</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="has_font" 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 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="name" type="String" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="1" name="theme_type" 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>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order. See https://github.com/godotengine/godot-proposals/issues/1495#issuecomment-691507839
2020-09-12 16:30:40 +00:00
Returns [code]true[/code] if [Font] with [code]name[/code] is in [code]node_type[/code].
Returns [code]false[/code] if the theme does not have [code]node_type[/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 20:42:36 +00:00
</description>
</method>
<method name="has_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 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="name" type="String" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="1" name="theme_type" 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>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order. See https://github.com/godotengine/godot-proposals/issues/1495#issuecomment-691507839
2020-09-12 16:30:40 +00:00
Returns [code]true[/code] if icon [Texture] with [code]name[/code] is in [code]node_type[/code].
Returns [code]false[/code] if the theme does not have [code]node_type[/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 20:42:36 +00:00
</description>
</method>
<method name="has_stylebox" 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 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="name" type="String" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="1" name="theme_type" 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>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order. See https://github.com/godotengine/godot-proposals/issues/1495#issuecomment-691507839
2020-09-12 16:30:40 +00:00
Returns [code]true[/code] if [StyleBox] with [code]name[/code] is in [code]node_type[/code].
Returns [code]false[/code] if the theme does not have [code]node_type[/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 20:42:36 +00:00
</description>
</method>
Add utility methods to Theme, improve error messages and documentation Backport of relevant parts of #47251, #49308
2021-06-10 13:23:00 +00:00
<method name="has_theme_item" 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 13:28:05 +00:00
<return type="bool" />
<argument index="0" name="data_type" type="int" enum="Theme.DataType" />
<argument index="1" name="name" type="String" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="2" name="theme_type" type="String" />
Add utility methods to Theme, improve error messages and documentation Backport of relevant parts of #47251, #49308
2021-06-10 13:23:00 +00:00
<description>
Returns [code]true[/code] if a theme item of [code]data_type[/code] with [code]name[/code] is in [code]node_type[/code].
Returns [code]false[/code] if the theme does not have [code]node_type[/code].
</description>
</method>
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<method name="is_type_variation" qualifiers="const">
<return type="bool" />
<argument index="0" name="theme_type" type="String" />
<argument index="1" name="base_type" type="String" />
<description>
Returns [code]true[/code] if [code]theme_type[/code] is marked as a variation of [code]base_type[/code].
</description>
</method>
Add support for partial custom editor themes
2021-08-13 22:06:21 +00:00
<method name="merge_with">
<return type="void" />
<argument index="0" name="other" type="Theme" />
<description>
Adds missing and overrides existing definitions with values from the [code]other[/code] [Theme].
[b]Note:[/b] This modifies the current theme. If you want to merge two themes together without modifying either one, create a new empty theme and merge the other two into it one after another.
</description>
</method>
Add an explicit way to remove a theme type Co-Authored-by: Yuri Sizov <yuris@humnom.net>
2022-04-05 03:46:47 +00:00
<method name="remove_type">
<return type="void" />
<argument index="0" name="theme_type" type="String" />
<description>
Removes the theme type, gracefully discarding defined theme items. If the type is a variation, this information is also erased. If the type is a base for type variations, those variations lose their base.
</description>
</method>
Add utility methods to Theme, improve error messages and documentation Backport of relevant parts of #47251, #49308
2021-06-10 13:23:00 +00:00
<method name="rename_color">
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 13:28:05 +00:00
<return type="void" />
<argument index="0" name="old_name" type="String" />
<argument index="1" name="name" type="String" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="2" name="theme_type" type="String" />
Add utility methods to Theme, improve error messages and documentation Backport of relevant parts of #47251, #49308
2021-06-10 13:23:00 +00:00
<description>
Renames the [Color] at [code]old_name[/code] to [code]name[/code] if the theme has [code]node_type[/code]. If [code]name[/code] is already taken, this method fails.
</description>
</method>
<method name="rename_constant">
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 13:28:05 +00:00
<return type="void" />
<argument index="0" name="old_name" type="String" />
<argument index="1" name="name" type="String" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="2" name="theme_type" type="String" />
Add utility methods to Theme, improve error messages and documentation Backport of relevant parts of #47251, #49308
2021-06-10 13:23:00 +00:00
<description>
Renames the constant at [code]old_name[/code] to [code]name[/code] if the theme has [code]node_type[/code]. If [code]name[/code] is already taken, this method fails.
</description>
</method>
<method name="rename_font">
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 13:28:05 +00:00
<return type="void" />
<argument index="0" name="old_name" type="String" />
<argument index="1" name="name" type="String" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="2" name="theme_type" type="String" />
Add utility methods to Theme, improve error messages and documentation Backport of relevant parts of #47251, #49308
2021-06-10 13:23:00 +00:00
<description>
Renames the [Font] at [code]old_name[/code] to [code]name[/code] if the theme has [code]node_type[/code]. If [code]name[/code] is already taken, this method fails.
</description>
</method>
<method name="rename_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 13:28:05 +00:00
<return type="void" />
<argument index="0" name="old_name" type="String" />
<argument index="1" name="name" type="String" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="2" name="theme_type" type="String" />
Add utility methods to Theme, improve error messages and documentation Backport of relevant parts of #47251, #49308
2021-06-10 13:23:00 +00:00
<description>
Renames the icon at [code]old_name[/code] to [code]name[/code] if the theme has [code]node_type[/code]. If [code]name[/code] is already taken, this method fails.
</description>
</method>
<method name="rename_stylebox">
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 13:28:05 +00:00
<return type="void" />
<argument index="0" name="old_name" type="String" />
<argument index="1" name="name" type="String" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="2" name="theme_type" type="String" />
Add utility methods to Theme, improve error messages and documentation Backport of relevant parts of #47251, #49308
2021-06-10 13:23:00 +00:00
<description>
Renames [StyleBox] at [code]old_name[/code] to [code]name[/code] if the theme has [code]node_type[/code]. If [code]name[/code] is already taken, this method fails.
</description>
</method>
<method name="rename_theme_item">
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 13:28:05 +00:00
<return type="void" />
<argument index="0" name="data_type" type="int" enum="Theme.DataType" />
<argument index="1" name="old_name" type="String" />
<argument index="2" name="name" type="String" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="3" name="theme_type" type="String" />
Add utility methods to Theme, improve error messages and documentation Backport of relevant parts of #47251, #49308
2021-06-10 13:23:00 +00:00
<description>
Renames the theme item of [code]data_type[/code] at [code]old_name[/code] to [code]name[/code] if the theme has [code]node_type[/code]. If [code]name[/code] is already taken, this method fails.
</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_color">
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 13:28:05 +00:00
<return type="void" />
<argument index="0" name="name" type="String" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="1" name="theme_type" type="String" />
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 13:28:05 +00:00
<argument index="2" name="color" type="Color" />
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>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order. See https://github.com/godotengine/godot-proposals/issues/1495#issuecomment-691507839
2020-09-12 16:30:40 +00:00
Sets the theme's [Color] to [code]color[/code] at [code]name[/code] in [code]node_type[/code].
Add utility methods to Theme, improve error messages and documentation Backport of relevant parts of #47251, #49308
2021-06-10 13:23:00 +00:00
Creates [code]node_type[/code] if the theme does not have it.
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_constant">
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 13:28:05 +00:00
<return type="void" />
<argument index="0" name="name" type="String" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="1" name="theme_type" type="String" />
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 13:28:05 +00:00
<argument index="2" name="constant" 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>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order. See https://github.com/godotengine/godot-proposals/issues/1495#issuecomment-691507839
2020-09-12 16:30:40 +00:00
Sets the theme's constant to [code]constant[/code] at [code]name[/code] in [code]node_type[/code].
Add utility methods to Theme, improve error messages and documentation Backport of relevant parts of #47251, #49308
2021-06-10 13:23:00 +00:00
Creates [code]node_type[/code] if the theme does not have it.
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_font">
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 13:28:05 +00:00
<return type="void" />
<argument index="0" name="name" type="String" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="1" name="theme_type" type="String" />
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 13:28:05 +00:00
<argument index="2" name="font" type="Font" />
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>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order. See https://github.com/godotengine/godot-proposals/issues/1495#issuecomment-691507839
2020-09-12 16:30:40 +00:00
Sets the theme's [Font] to [code]font[/code] at [code]name[/code] in [code]node_type[/code].
Add utility methods to Theme, improve error messages and documentation Backport of relevant parts of #47251, #49308
2021-06-10 13:23:00 +00:00
Creates [code]node_type[/code] if the theme does not have it.
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_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 13:28:05 +00:00
<return type="void" />
<argument index="0" name="name" type="String" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="1" name="theme_type" type="String" />
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 13:28:05 +00:00
<argument index="2" name="texture" 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 20:42:36 +00:00
<description>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order. See https://github.com/godotengine/godot-proposals/issues/1495#issuecomment-691507839
2020-09-12 16:30:40 +00:00
Sets the theme's icon [Texture] to [code]texture[/code] at [code]name[/code] in [code]node_type[/code].
Add utility methods to Theme, improve error messages and documentation Backport of relevant parts of #47251, #49308
2021-06-10 13:23:00 +00:00
Creates [code]node_type[/code] if the theme does not have it.
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_stylebox">
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 13:28:05 +00:00
<return type="void" />
<argument index="0" name="name" type="String" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="1" name="theme_type" type="String" />
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 13:28:05 +00:00
<argument index="2" name="texture" type="StyleBox" />
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>
Rename the `type` parameter to `node_type` in Theme and Control This makes it clearer that it expects a node type as a string (such as "Label") instead of a type like "TYPE_ARRAY". This is backwards-compatible since only the name of the parameter is changed, not its order. See https://github.com/godotengine/godot-proposals/issues/1495#issuecomment-691507839
2020-09-12 16:30:40 +00:00
Sets theme's [StyleBox] to [code]stylebox[/code] at [code]name[/code] in [code]node_type[/code].
Add utility methods to Theme, improve error messages and documentation Backport of relevant parts of #47251, #49308
2021-06-10 13:23:00 +00:00
Creates [code]node_type[/code] if the theme does not have it.
</description>
</method>
<method name="set_theme_item">
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 13:28:05 +00:00
<return type="void" />
<argument index="0" name="data_type" type="int" enum="Theme.DataType" />
<argument index="1" name="name" type="String" />
Add type variations to Theme
2022-02-10 21:26:09 +00:00
<argument index="2" name="theme_type" type="String" />
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 13:28:05 +00:00
<argument index="3" name="value" type="Variant" />
Add utility methods to Theme, improve error messages and documentation Backport of relevant parts of #47251, #49308
2021-06-10 13:23:00 +00:00
<description>
Sets the theme item of [code]data_type[/code] to [code]value[/code] at [code]name[/code] in [code]node_type[/code].
Does nothing if the [code]value[/code] type does not match [code]data_type[/code].
Creates [code]node_type[/code] if the theme does not have it.
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 type variations to Theme
2022-02-10 21:26:09 +00:00
<method name="set_type_variation">
<return type="void" />
<argument index="0" name="theme_type" type="String" />
<argument index="1" name="base_type" type="String" />
<description>
Marks [code]theme_type[/code] as a variation of [code]base_type[/code].
This adds [code]theme_type[/code] as a suggested option for [member Control.theme_type_variation] on a [Control] that is of the [code]base_type[/code] class.
Variations can also be nested, i.e. [code]base_type[/code] can be another variation. If a chain of variations ends with a [code]base_type[/code] matching the class of the [Control], the whole chain is going to be suggested as options.
[b]Note:[/b] Suggestions only show up if this theme resource is set as the project default theme. See [member ProjectSettings.gui/theme/custom].
</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
</methods>
<members>
doc: Sync classref with current source
2019-07-15 18:42:47 +00:00
<member name="default_font" type="Font" setter="set_default_font" getter="get_default_font">
Expose API to retrieve Theme's default font
2021-10-04 14:44:53 +00:00
The default font of this [Theme] resource. Used as a fallback value for font items defined in this theme, but having invalid values. If this value is also invalid, the global default value is used.
Use [method has_default_font] to check if this value is valid.
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>
</members>
<constants>
Add utility methods to Theme, improve error messages and documentation Backport of relevant parts of #47251, #49308
2021-06-10 13:23:00 +00:00
<constant name="DATA_TYPE_COLOR" value="0" enum="DataType">
Theme's [Color] item type.
</constant>
<constant name="DATA_TYPE_CONSTANT" value="1" enum="DataType">
Theme's constant item type.
</constant>
<constant name="DATA_TYPE_FONT" value="2" enum="DataType">
Theme's [Font] item type.
</constant>
<constant name="DATA_TYPE_ICON" value="3" enum="DataType">
Theme's icon [Texture] item type.
</constant>
<constant name="DATA_TYPE_STYLEBOX" value="4" enum="DataType">
Theme's [StyleBox] item type.
</constant>
<constant name="DATA_TYPE_MAX" value="5" enum="DataType">
Maximum value for the DataType enum.
</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 20:42:36 +00:00
</constants>
</class>