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

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

581 lines
31 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-02-14 13:18:53 +00:00
<class name="Theme" inherits="Resource" version="4.0" 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>
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Theme resource for styling/skinning [Control]s and [Window]s.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</brief_description>
<description>
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
A theme resource is used for styling/skinning [Control] and [Window] nodes. While individual controls can be styled using their local theme overrides (see [method Control.add_theme_color_override]), theme resources allow you to store and apply the same settings between all controls sharing the same type (e.g. style all [Button]s the same). One theme resource can be used for the entire project, but you can also set a separate theme resource to a branch of control nodes. A theme resources assigned to a control node applies to the control itself, as well as all of its direct and indirect children (as long as a chain of controls is uninterrupted).
Use [member ProjectSettings.gui/theme/custom] to set up a project-scope theme that will be available to every control in your project.
Use [member Control.theme] of any control node to set up a theme that will be available to that control and all of its direct and indirect children.
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>
Replace Godot docs URL with `$DOCS_URL` in XML class reference
2021-11-15 09:43:07 +00:00
<link title="GUI skinning">$DOCS_URL/tutorials/ui/gui_skinning.html</link>
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
<link title="Using the theme editor">$DOCS_URL/tutorials/ui/gui_using_theme_editor.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
2022-02-11 14:53:58 +00:00
<method name="add_type">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="theme_type" type="StringName" />
Add an explicit way to remove a theme type
2022-02-11 14:53:58 +00:00
<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.
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>
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Removes all the theme properties defined on the theme resource.
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.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="name" type="StringName" />
<param index="1" name="theme_type" type="StringName" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Removes the [Color] property defined by [param name] and [param theme_type], if it exists.
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Fails if it doesn't exist. Use [method has_color] to check for existence.
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.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="name" type="StringName" />
<param index="1" name="theme_type" type="StringName" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Removes the constant property defined by [param name] and [param theme_type], if it exists.
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Fails if it doesn't exist. Use [method has_constant] to check for existence.
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.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="name" type="StringName" />
<param index="1" name="theme_type" type="StringName" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Removes the [Font] property defined by [param name] and [param theme_type], if it exists.
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Fails if it doesn't exist. Use [method has_font] to check for existence.
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>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<method name="clear_font_size">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="name" type="StringName" />
<param index="1" name="theme_type" type="StringName" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Removes the font size property defined by [param name] and [param theme_type], if it exists.
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Fails if it doesn't exist. Use [method has_font_size] to check for existence.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +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_icon">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="name" type="StringName" />
<param index="1" name="theme_type" type="StringName" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Removes the icon property defined by [param name] and [param theme_type], if it exists.
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Fails if it doesn't exist. Use [method has_icon] to check for existence.
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.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="name" type="StringName" />
<param index="1" name="theme_type" type="StringName" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Removes the [StyleBox] property defined by [param name] and [param theme_type], if it exists.
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Fails if it doesn't exist. Use [method has_stylebox] to check for existence.
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
2021-03-22 11:35:58 +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.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="data_type" type="int" enum="Theme.DataType" />
<param index="1" name="name" type="StringName" />
<param index="2" name="theme_type" type="StringName" />
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Removes the theme property of [param data_type] defined by [param name] and [param theme_type], if it exists.
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Fails if it doesn't exist. Use [method has_theme_item] to check for existence.
[b]Note:[/b] This method is analogous to calling the corresponding data type specific method, but can be used for more generalized logic.
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
</description>
</method>
Add type variations to Theme
2021-07-04 20:42:23 +00:00
<method name="clear_type_variation">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="theme_type" type="StringName" />
Add type variations to Theme
2021-07-04 20:42:23 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Unmarks [param theme_type] as being a variation of another theme type. See [method set_type_variation].
Add type variations to Theme
2021-07-04 20:42:23 +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.
2021-07-30 13:28:05 +00:00
<return type="Color" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="name" type="StringName" />
<param index="1" name="theme_type" type="StringName" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns the [Color] property defined by [param name] and [param theme_type], if it exists.
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Returns the default color value if the property doesn't exist. Use [method has_color] to check for existence.
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.
2021-07-30 13:28:05 +00:00
<return type="PackedStringArray" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns a list of names for [Color] properties defined with [param theme_type]. Use [method get_color_type_list] to get a list of possible theme type names.
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>
Remove unused argument in Theme method and expose missing methods
2020-04-10 14:50:28 +00:00
<method name="get_color_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.
2021-07-30 13:28:05 +00:00
<return type="PackedStringArray" />
Remove unused argument in Theme method and expose missing methods
2020-04-10 14:50:28 +00:00
<description>
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Returns a list of all unique theme type names for [Color] properties. Use [method get_type_list] to get a list of all unique theme types.
Remove unused argument in Theme method and expose missing methods
2020-04-10 14:50:28 +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_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.
2021-07-30 13:28:05 +00:00
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="name" type="StringName" />
<param index="1" name="theme_type" type="StringName" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns the constant property defined by [param name] and [param theme_type], if it exists.
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Returns [code]0[/code] if the property doesn't exist. Use [method has_constant] to check for existence.
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.
2021-07-30 13:28:05 +00:00
<return type="PackedStringArray" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns a list of names for constant properties defined with [param theme_type]. Use [method get_constant_type_list] to get a list of possible theme type names.
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>
Remove unused argument in Theme method and expose missing methods
2020-04-10 14:50:28 +00:00
<method name="get_constant_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.
2021-07-30 13:28:05 +00:00
<return type="PackedStringArray" />
Remove unused argument in Theme method and expose missing methods
2020-04-10 14:50:28 +00:00
<description>
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Returns a list of all unique theme type names for constant properties. Use [method get_type_list] to get a list of all unique theme types.
Remove unused argument in Theme method and expose missing methods
2020-04-10 14:50:28 +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_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.
2021-07-30 13:28:05 +00:00
<return type="Font" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="name" type="StringName" />
<param index="1" name="theme_type" type="StringName" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns the [Font] property defined by [param name] and [param theme_type], if it exists.
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Returns the default theme font if the property doesn't exist and the default theme font is set up (see [member default_font]). Use [method has_font] to check for existence of the property and [method has_default_font] to check for existence of the default theme font.
Add ThemeDB, expose previously static Theme methods
2022-08-08 16:29:36 +00:00
Returns the engine fallback font value, if neither exist (see [member ThemeDB.fallback_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>
</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.
2021-07-30 13:28:05 +00:00
<return type="PackedStringArray" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns a list of names for [Font] properties defined with [param theme_type]. Use [method get_font_type_list] to get a list of possible theme type names.
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>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<method name="get_font_size" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="int" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="name" type="StringName" />
<param index="1" name="theme_type" type="StringName" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns the font size property defined by [param name] and [param theme_type], if it exists.
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Returns the default theme font size if the property doesn't exist and the default theme font size is set up (see [member default_font_size]). Use [method has_font_size] to check for existence of the property and [method has_default_font_size] to check for existence of the default theme font.
Add ThemeDB, expose previously static Theme methods
2022-08-08 16:29:36 +00:00
Returns the engine fallback font size value, if neither exist (see [member ThemeDB.fallback_font_size]).
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
<method name="get_font_size_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.
2021-07-30 13:28:05 +00:00
<return type="PackedStringArray" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="theme_type" type="String" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns a list of names for font size properties defined with [param theme_type]. Use [method get_font_size_type_list] to get a list of possible theme type names.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
<method name="get_font_size_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.
2021-07-30 13:28:05 +00:00
<return type="PackedStringArray" />
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
<description>
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Returns a list of all unique theme type names for font size properties. Use [method get_type_list] to get a list of all unique theme types.
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
</description>
</method>
Remove unused argument in Theme method and expose missing methods
2020-04-10 14:50:28 +00:00
<method name="get_font_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.
2021-07-30 13:28:05 +00:00
<return type="PackedStringArray" />
Remove unused argument in Theme method and expose missing methods
2020-04-10 14:50:28 +00:00
<description>
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Returns a list of all unique theme type names for [Font] properties. Use [method get_type_list] to get a list of all unique theme types.
Remove unused argument in Theme method and expose missing methods
2020-04-10 14:50:28 +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_icon" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="Texture2D" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="name" type="StringName" />
<param index="1" name="theme_type" type="StringName" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns the icon property defined by [param name] and [param theme_type], if it exists.
Add ThemeDB, expose previously static Theme methods
2022-08-08 16:29:36 +00:00
Returns the engine fallback icon value if the property doesn't exist (see [member ThemeDB.fallback_icon]). Use [method has_icon] to check for existence.
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.
2021-07-30 13:28:05 +00:00
<return type="PackedStringArray" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns a list of names for icon properties defined with [param theme_type]. Use [method get_icon_type_list] to get a list of possible theme type names.
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>
Remove unused argument in Theme method and expose missing methods
2020-04-10 14:50:28 +00:00
<method name="get_icon_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.
2021-07-30 13:28:05 +00:00
<return type="PackedStringArray" />
Remove unused argument in Theme method and expose missing methods
2020-04-10 14:50:28 +00:00
<description>
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Returns a list of all unique theme type names for icon properties. Use [method get_type_list] to get a list of all unique theme types.
Remove unused argument in Theme method and expose missing methods
2020-04-10 14:50:28 +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_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.
2021-07-30 13:28:05 +00:00
<return type="StyleBox" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="name" type="StringName" />
<param index="1" name="theme_type" type="StringName" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns the [StyleBox] property defined by [param name] and [param theme_type], if it exists.
Add ThemeDB, expose previously static Theme methods
2022-08-08 16:29:36 +00:00
Returns the engine fallback stylebox value if the property doesn't exist (see [member ThemeDB.fallback_stylebox]). Use [method has_stylebox] to check for existence.
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.
2021-07-30 13:28:05 +00:00
<return type="PackedStringArray" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param 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>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns a list of names for [StyleBox] properties defined with [param theme_type]. Use [method get_stylebox_type_list] to get a list of possible theme type names.
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>
Remove unused argument in Theme method and expose missing methods
2020-04-10 14:50:28 +00:00
<method name="get_stylebox_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.
2021-07-30 13:28:05 +00:00
<return type="PackedStringArray" />
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>
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Returns a list of all unique theme type names for [StyleBox] properties. Use [method get_type_list] to get a list of all unique theme 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>
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +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.
2021-07-30 13:28:05 +00:00
<return type="Variant" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="data_type" type="int" enum="Theme.DataType" />
<param index="1" name="name" type="StringName" />
<param index="2" name="theme_type" type="StringName" />
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns the theme property of [param data_type] defined by [param name] and [param theme_type], if it exists.
Fix various typos in the classref (cherry picked from commit 03fcac3aa5deecb9a4009b0a7889bb5d6be252fb)
2023-03-09 06:56:23 +00:00
Returns the engine fallback value if the property doesn't exist (see [ThemeDB]). Use [method has_theme_item] to check for existence.
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
[b]Note:[/b] This method is analogous to calling the corresponding data type specific method, but can be used for more generalized logic.
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
</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.
2021-07-30 13:28:05 +00:00
<return type="PackedStringArray" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="data_type" type="int" enum="Theme.DataType" />
<param index="1" name="theme_type" type="String" />
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns a list of names for properties of [param data_type] defined with [param theme_type]. Use [method get_theme_item_type_list] to get a list of possible theme type names.
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
[b]Note:[/b] This method is analogous to calling the corresponding data type specific method, but can be used for more generalized logic.
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
</description>
</method>
<method name="get_theme_item_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.
2021-07-30 13:28:05 +00:00
<return type="PackedStringArray" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="data_type" type="int" enum="Theme.DataType" />
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns a list of all unique theme type names for [param data_type] properties. Use [method get_type_list] to get a list of all unique theme types.
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
[b]Note:[/b] This method is analogous to calling the corresponding data type specific method, but can be used for more generalized logic.
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +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_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.
2021-07-30 13:28:05 +00:00
<return type="PackedStringArray" />
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>
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Returns a list of all unique theme type names. Use the appropriate [code]get_*_type_list[/code] method to get a list of unique theme types for a single data type.
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
2021-07-04 20:42:23 +00:00
<method name="get_type_variation_base" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="StringName" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="theme_type" type="StringName" />
Add type variations to Theme
2021-07-04 20:42:23 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns the name of the base theme type if [param theme_type] is a valid variation type. Returns an empty string otherwise.
Add type variations to Theme
2021-07-04 20:42:23 +00:00
</description>
</method>
<method name="get_type_variation_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.
2021-07-30 13:28:05 +00:00
<return type="PackedStringArray" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="base_type" type="StringName" />
Add type variations to Theme
2021-07-04 20:42:23 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns a list of all type variations for the given [param base_type].
Add type variations to Theme
2021-07-04 20:42:23 +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="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.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="name" type="StringName" />
<param index="1" name="theme_type" type="StringName" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns [code]true[/code] if the [Color] property defined by [param name] and [param theme_type] exists.
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Returns [code]false[/code] if it doesn't exist. Use [method set_color] to define 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="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.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="name" type="StringName" />
<param index="1" name="theme_type" type="StringName" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns [code]true[/code] if the constant property defined by [param name] and [param theme_type] exists.
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Returns [code]false[/code] if it doesn't exist. Use [method set_constant] to define 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 the base scale factor to the Theme resource
2021-10-02 20:06:14 +00:00
<method name="has_default_base_scale" qualifiers="const">
<return type="bool" />
<description>
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Returns [code]true[/code] if [member default_base_scale] has a valid value.
Returns [code]false[/code] if it doesn't. The value must be greater than [code]0.0[/code] to be considered valid.
Add the base scale factor to the Theme resource
2021-10-02 20:06:14 +00:00
</description>
</method>
<method name="has_default_font" qualifiers="const">
<return type="bool" />
<description>
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Returns [code]true[/code] if [member default_font] has a valid value.
Returns [code]false[/code] if it doesn't.
Add the base scale factor to the Theme resource
2021-10-02 20:06:14 +00:00
</description>
</method>
<method name="has_default_font_size" qualifiers="const">
<return type="bool" />
<description>
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Returns [code]true[/code] if [member default_font_size] has a valid value.
Returns [code]false[/code] if it doesn't. The value must be greater than [code]0[/code] to be considered valid.
Add the base scale factor to the Theme resource
2021-10-02 20:06:14 +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="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.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="name" type="StringName" />
<param index="1" name="theme_type" type="StringName" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns [code]true[/code] if the [Font] property defined by [param name] and [param theme_type] exists, or if the default theme font is set up (see [method has_default_font]).
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Returns [code]false[/code] if neither exist. Use [method set_font] to define the property.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<method name="has_font_size" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="name" type="StringName" />
<param index="1" name="theme_type" type="StringName" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns [code]true[/code] if the font size property defined by [param name] and [param theme_type] exists, or if the default theme font size is set up (see [method has_default_font_size]).
Returns [code]false[/code] if neither exist. Use [method set_font_size] to define the property.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +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="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.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="name" type="StringName" />
<param index="1" name="theme_type" type="StringName" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns [code]true[/code] if the icon property defined by [param name] and [param theme_type] exists.
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Returns [code]false[/code] if it doesn't exist. Use [method set_icon] to define 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="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.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="name" type="StringName" />
<param index="1" name="theme_type" type="StringName" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns [code]true[/code] if the [StyleBox] property defined by [param name] and [param theme_type] exists.
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Returns [code]false[/code] if it doesn't exist. Use [method set_stylebox] to define 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 utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +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.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="data_type" type="int" enum="Theme.DataType" />
<param index="1" name="name" type="StringName" />
<param index="2" name="theme_type" type="StringName" />
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns [code]true[/code] if the theme property of [param data_type] defined by [param name] and [param theme_type] exists.
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Returns [code]false[/code] if it doesn't exist. Use [method set_theme_item] to define it.
[b]Note:[/b] This method is analogous to calling the corresponding data type specific method, but can be used for more generalized logic.
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
</description>
</method>
Add type variations to Theme
2021-07-04 20:42:23 +00:00
<method name="is_type_variation" qualifiers="const">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="theme_type" type="StringName" />
<param index="1" name="base_type" type="StringName" />
Add type variations to Theme
2021-07-04 20:42:23 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Returns [code]true[/code] if [param theme_type] is marked as a variation of [param base_type].
Add type variations to Theme
2021-07-04 20:42:23 +00:00
</description>
</method>
Add support for partial custom editor themes
2021-08-13 23:01:15 +00:00
<method name="merge_with">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="other" type="Theme" />
Add support for partial custom editor themes
2021-08-13 23:01:15 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Adds missing and overrides existing definitions with values from the [param other] theme resource.
Add support for partial custom editor themes
2021-08-13 23:01:15 +00:00
[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
2022-02-11 14:53:58 +00:00
<method name="remove_type">
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="theme_type" type="StringName" />
Add an explicit way to remove a theme type
2022-02-11 14:53:58 +00:00
<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
2021-03-22 11:35:58 +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.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="old_name" type="StringName" />
<param index="1" name="name" type="StringName" />
<param index="2" name="theme_type" type="StringName" />
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Renames the [Color] property defined by [param old_name] and [param theme_type] to [param name], if it exists.
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Fails if it doesn't exist, or if a similar property with the new name already exists. Use [method has_color] to check for existence, and [method clear_color] to remove the existing property.
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
</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.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="old_name" type="StringName" />
<param index="1" name="name" type="StringName" />
<param index="2" name="theme_type" type="StringName" />
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Renames the constant property defined by [param old_name] and [param theme_type] to [param name], if it exists.
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Fails if it doesn't exist, or if a similar property with the new name already exists. Use [method has_constant] to check for existence, and [method clear_constant] to remove the existing property.
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
</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.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="old_name" type="StringName" />
<param index="1" name="name" type="StringName" />
<param index="2" name="theme_type" type="StringName" />
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Renames the [Font] property defined by [param old_name] and [param theme_type] to [param name], if it exists.
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Fails if it doesn't exist, or if a similar property with the new name already exists. Use [method has_font] to check for existence, and [method clear_font] to remove the existing property.
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
</description>
</method>
<method name="rename_font_size">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="old_name" type="StringName" />
<param index="1" name="name" type="StringName" />
<param index="2" name="theme_type" type="StringName" />
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Renames the font size property defined by [param old_name] and [param theme_type] to [param name], if it exists.
Fails if it doesn't exist, or if a similar property with the new name already exists. Use [method has_font_size] to check for existence, and [method clear_font_size] to remove the existing property.
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
</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.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="old_name" type="StringName" />
<param index="1" name="name" type="StringName" />
<param index="2" name="theme_type" type="StringName" />
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Renames the icon property defined by [param old_name] and [param theme_type] to [param name], if it exists.
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Fails if it doesn't exist, or if a similar property with the new name already exists. Use [method has_icon] to check for existence, and [method clear_icon] to remove the existing property.
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
</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.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="old_name" type="StringName" />
<param index="1" name="name" type="StringName" />
<param index="2" name="theme_type" type="StringName" />
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Renames the [StyleBox] property defined by [param old_name] and [param theme_type] to [param name], if it exists.
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Fails if it doesn't exist, or if a similar property with the new name already exists. Use [method has_stylebox] to check for existence, and [method clear_stylebox] to remove the existing property.
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
</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.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="data_type" type="int" enum="Theme.DataType" />
<param index="1" name="old_name" type="StringName" />
<param index="2" name="name" type="StringName" />
<param index="3" name="theme_type" type="StringName" />
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Renames the theme property of [param data_type] defined by [param old_name] and [param theme_type] to [param name], if it exists.
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Fails if it doesn't exist, or if a similar property with the new name already exists. Use [method has_theme_item] to check for existence, and [method clear_theme_item] to remove the existing property.
[b]Note:[/b] This method is analogous to calling the corresponding data type specific method, but can be used for more generalized logic.
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="set_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.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="name" type="StringName" />
<param index="1" name="theme_type" type="StringName" />
<param 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>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Creates or changes the value of the [Color] property defined by [param name] and [param theme_type]. Use [method clear_color] to remove the property.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="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.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="name" type="StringName" />
<param index="1" name="theme_type" type="StringName" />
<param 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>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Creates or changes the value of the constant property defined by [param name] and [param theme_type]. Use [method clear_constant] to remove the property.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="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.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="name" type="StringName" />
<param index="1" name="theme_type" type="StringName" />
<param 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>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Creates or changes the value of the [Font] property defined by [param name] and [param theme_type]. Use [method clear_font] to remove the property.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<method name="set_font_size">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="name" type="StringName" />
<param index="1" name="theme_type" type="StringName" />
<param index="2" name="font_size" type="int" />
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Creates or changes the value of the font size property defined by [param name] and [param theme_type]. Use [method clear_font_size] to remove the property.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</description>
</method>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<method name="set_icon">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="name" type="StringName" />
<param index="1" name="theme_type" type="StringName" />
<param index="2" name="texture" type="Texture2D" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Creates or changes the value of the icon property defined by [param name] and [param theme_type]. Use [method clear_icon] to remove the property.
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</description>
</method>
<method name="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.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="name" type="StringName" />
<param index="1" name="theme_type" type="StringName" />
<param 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>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Creates or changes the value of the [StyleBox] property defined by [param name] and [param theme_type]. Use [method clear_stylebox] to remove the property.
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
</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.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="data_type" type="int" enum="Theme.DataType" />
<param index="1" name="name" type="StringName" />
<param index="2" name="theme_type" type="StringName" />
<param index="3" name="value" type="Variant" />
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Creates or changes the value of the theme property of [param data_type] defined by [param name] and [param theme_type]. Use [method clear_theme_item] to remove the property.
Fails if the [param value] type is not accepted by [param data_type].
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
[b]Note:[/b] This method is analogous to calling the corresponding data type specific method, but can be used for more generalized logic.
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
2021-07-04 20:42:23 +00:00
<method name="set_type_variation">
doc: Use self-closing tags for `return` and `argument` For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-30 13:28:05 +00:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 18:11:48 +00:00
<param index="0" name="theme_type" type="StringName" />
<param index="1" name="base_type" type="StringName" />
Add type variations to Theme
2021-07-04 20:42:23 +00:00
<description>
[doc] Use "param" instead of "code" to refer to parameters
2022-08-09 15:19:47 +00:00
Marks [param theme_type] as a variation of [param base_type].
This adds [param theme_type] as a suggested option for [member Control.theme_type_variation] on a [Control] that is of the [param base_type] class.
Variations can also be nested, i.e. [param base_type] can be another variation. If a chain of variations ends with a [param base_type] matching the class of the [Control], the whole chain is going to be suggested as options.
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
[b]Note:[/b] Suggestions only show up if this theme resource is set as the project default theme. See [member ProjectSettings.gui/theme/custom].
Add type variations to Theme
2021-07-04 20:42:23 +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
</methods>
<members>
Add the base scale factor to the Theme resource
2021-10-02 20:06:14 +00:00
<member name="default_base_scale" type="float" setter="set_default_base_scale" getter="get_default_base_scale" default="0.0">
Add ThemeDB, expose previously static Theme methods
2022-08-08 16:29:36 +00:00
The default base scale factor of this theme resource. Used by some controls to scale their visual properties based on the global scale factor. If this value is set to [code]0.0[/code], the global scale factor is used (see [member ThemeDB.fallback_base_scale]).
Add the base scale factor to the Theme resource
2021-10-02 20:06:14 +00:00
Use [method has_default_base_scale] to check if this value is valid.
</member>
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">
Add ThemeDB, expose previously static Theme methods
2022-08-08 16:29:36 +00:00
The default font of this theme resource. Used as the default value when trying to fetch a font resource that doesn't exist in this theme or is in invalid state. If the default font is also missing or invalid, the engine fallback value is used (see [member ThemeDB.fallback_font]).
Add the base scale factor to the Theme resource
2021-10-02 20:06:14 +00:00
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>
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
<member name="default_font_size" type="int" setter="set_default_font_size" getter="get_default_font_size" default="-1">
Add ThemeDB, expose previously static Theme methods
2022-08-08 16:29:36 +00:00
The default font size of this theme resource. Used as the default value when trying to fetch a font size value that doesn't exist in this theme or is in invalid state. If the default font size is also missing or invalid, the engine fallback value is used (see [member ThemeDB.fallback_font_size]).
Refine Theme documentation to make it more factual
2022-02-01 15:43:53 +00:00
Values below [code]0[/code] are invalid and can be used to unset the property. Use [method has_default_font_size] to check if this value is valid.
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-08-12 11:49:10 +00:00
</member>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 20:42:36 +00:00
</members>
<constants>
Add utility methods to Theme, improve error messages and documentation
2021-03-22 11:35:58 +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_FONT_SIZE" value="3" enum="DataType">
Theme's font size item type.
</constant>
<constant name="DATA_TYPE_ICON" value="4" enum="DataType">
Theme's icon [Texture2D] item type.
</constant>
<constant name="DATA_TYPE_STYLEBOX" value="5" enum="DataType">
Theme's [StyleBox] item type.
</constant>
<constant name="DATA_TYPE_MAX" value="6" 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>