summaryrefslogtreecommitdiff
path: root/doc/classes/Theme.xml
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2019-06-22 01:04:47 +0200
committerHugo Locurcio <hugo.locurcio@hugo.pro>2019-06-27 22:30:19 +0200
commitf7f6115f7627df24a08a9a0882b2f573cc838eb1 (patch)
tree03fd75145084c88702dbbb7e54c42c7c02d54fa6 /doc/classes/Theme.xml
parent538c8eec15d72b67e102f47f9df7624c29d14607 (diff)
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
Diffstat (limited to 'doc/classes/Theme.xml')
-rw-r--r--doc/classes/Theme.xml68
1 files changed, 34 insertions, 34 deletions
diff --git a/doc/classes/Theme.xml b/doc/classes/Theme.xml
index 8fdef5540b..e4db9243ef 100644
--- a/doc/classes/Theme.xml
+++ b/doc/classes/Theme.xml
@@ -4,8 +4,8 @@
Theme for controls.
</brief_description>
<description>
- Theme for skinning controls. Controls can be skinned individually, but for complex applications it's more efficient to just create a global theme that defines everything. This theme can be applied to any [Control], and it and its children will automatically use it.
- Theme resources can be alternatively loaded by writing them in a .theme file, see docs for more info.
+ 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.
</description>
<tutorials>
<link>https://docs.godotengine.org/en/latest/tutorials/gui/gui_skinning.html</link>
@@ -25,7 +25,7 @@
<argument index="1" name="type" type="String">
</argument>
<description>
- Clears theme [Color] at [code]name[/code] if Theme has [code]type[/code].
+ Clears the [Color] at [code]name[/code] if the Theme has [code]type[/code].
</description>
</method>
<method name="clear_constant">
@@ -36,7 +36,7 @@
<argument index="1" name="type" type="String">
</argument>
<description>
- Clears theme constant at [code]name[/code] if Theme has [code]type[/code].
+ Clears the constant at [code]name[/code] if the Theme has [code]type[/code].
</description>
</method>
<method name="clear_font">
@@ -47,7 +47,7 @@
<argument index="1" name="type" type="String">
</argument>
<description>
- Clears [Font] at [code]name[/code] if Theme has [code]type[/code].
+ Clears the [Font] at [code]name[/code] if the Theme has [code]type[/code].
</description>
</method>
<method name="clear_icon">
@@ -58,7 +58,7 @@
<argument index="1" name="type" type="String">
</argument>
<description>
- Clears icon at [code]name[/code] if Theme has [code]type[/code].
+ Clears the icon at [code]name[/code] if the Theme has [code]type[/code].
</description>
</method>
<method name="clear_stylebox">
@@ -69,14 +69,14 @@
<argument index="1" name="type" type="String">
</argument>
<description>
- Clears [StyleBox] at [code]name[/code] if Theme has [code]type[/code].
+ Clears [StyleBox] at [code]name[/code] if the Theme has [code]type[/code].
</description>
</method>
<method name="copy_default_theme">
<return type="void">
</return>
<description>
- Sets theme values to a copy of the default theme values.
+ Sets the Theme's values to a copy of the default theme values.
</description>
</method>
<method name="copy_theme">
@@ -95,7 +95,7 @@
<argument index="1" name="type" type="String">
</argument>
<description>
- Returns the [Color] at [code]name[/code] if Theme has [code]type[/code].
+ Returns the [Color] at [code]name[/code] if the Theme has [code]type[/code].
</description>
</method>
<method name="get_color_list" qualifiers="const">
@@ -104,7 +104,7 @@
<argument index="0" name="type" type="String">
</argument>
<description>
- Returns all of the [Color]s as a [PoolStringArray] filled with each [Color]'s name, for use in [method get_color], if Theme has [code]type[/code].
+ 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]type[/code].
</description>
</method>
<method name="get_constant" qualifiers="const">
@@ -115,7 +115,7 @@
<argument index="1" name="type" type="String">
</argument>
<description>
- Returns the constant at [code]name[/code] if Theme has [code]type[/code].
+ Returns the constant at [code]name[/code] if the Theme has [code]type[/code].
</description>
</method>
<method name="get_constant_list" qualifiers="const">
@@ -124,7 +124,7 @@
<argument index="0" name="type" type="String">
</argument>
<description>
- Returns all of the constants as a [PoolStringArray] filled with each constant's name, for use in [method get_constant], if Theme has [code]type[/code].
+ Returns all the constants as a [PoolStringArray] filled with each constant's name, for use in [method get_constant], if the Theme has [code]type[/code].
</description>
</method>
<method name="get_font" qualifiers="const">
@@ -135,7 +135,7 @@
<argument index="1" name="type" type="String">
</argument>
<description>
- Returns the [Font] at [code]name[/code] if Theme has [code]type[/code].
+ Returns the [Font] at [code]name[/code] if the Theme has [code]type[/code].
</description>
</method>
<method name="get_font_list" qualifiers="const">
@@ -144,7 +144,7 @@
<argument index="0" name="type" type="String">
</argument>
<description>
- Returns all of the [Font]s as a [PoolStringArray] filled with each [Font]'s name, for use in [method get_font], if Theme has [code]type[/code].
+ 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]type[/code].
</description>
</method>
<method name="get_icon" qualifiers="const">
@@ -155,7 +155,7 @@
<argument index="1" name="type" type="String">
</argument>
<description>
- Returns the icon [Texture] at [code]name[/code] if Theme has [code]type[/code].
+ Returns the icon [Texture] at [code]name[/code] if the Theme has [code]type[/code].
</description>
</method>
<method name="get_icon_list" qualifiers="const">
@@ -164,7 +164,7 @@
<argument index="0" name="type" type="String">
</argument>
<description>
- Returns all of the icons as a [PoolStringArray] filled with each [Texture]'s name, for use in [method get_icon], if Theme has [code]type[/code].
+ Returns all the icons as a [PoolStringArray] filled with each [Texture]'s name, for use in [method get_icon], if the Theme has [code]type[/code].
</description>
</method>
<method name="get_stylebox" qualifiers="const">
@@ -175,7 +175,7 @@
<argument index="1" name="type" type="String">
</argument>
<description>
- Returns the icon [StyleBox] at [code]name[/code] if Theme has [code]type[/code].
+ Returns the icon [StyleBox] at [code]name[/code] if the Theme has [code]type[/code].
</description>
</method>
<method name="get_stylebox_list" qualifiers="const">
@@ -184,14 +184,14 @@
<argument index="0" name="type" type="String">
</argument>
<description>
- Returns all of the [StyleBox]s as a [PoolStringArray] filled with each [StyleBox]'s name, for use in [method get_stylebox], if Theme has [code]type[/code].
+ 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]type[/code].
</description>
</method>
<method name="get_stylebox_types" qualifiers="const">
<return type="PoolStringArray">
</return>
<description>
- Returns all of the [StyleBox] types as a [PoolStringArray] filled with each [StyleBox]'s type, for use in [method get_stylebox] and/or [method get_stylebox_list], if Theme has [code]type[/code].
+ Returns all the [StyleBox] types as a [PoolStringArray] filled with each [StyleBox]'s type, for use in [method get_stylebox] and/or [method get_stylebox_list], if the Theme has [code]type[/code].
</description>
</method>
<method name="get_type_list" qualifiers="const">
@@ -200,7 +200,7 @@
<argument index="0" name="type" type="String">
</argument>
<description>
- Returns all of the types in [code]type[/code] as a [PoolStringArray] for use in any of the get_* functions, if Theme has [code]type[/code].
+ Returns all the types in [code]type[/code] as a [PoolStringArray] for use in any of the get_* functions, if the Theme has [code]type[/code].
</description>
</method>
<method name="has_color" qualifiers="const">
@@ -212,7 +212,7 @@
</argument>
<description>
Returns [code]true[/code] if [Color] with [code]name[/code] is in [code]type[/code].
- Returns [code]false[/code] if Theme does not have [code]type[/code].
+ Returns [code]false[/code] if the Theme does not have [code]type[/code].
</description>
</method>
<method name="has_constant" qualifiers="const">
@@ -224,7 +224,7 @@
</argument>
<description>
Returns [code]true[/code] if constant with [code]name[/code] is in [code]type[/code].
- Returns [code]false[/code] if Theme does not have [code]type[/code].
+ Returns [code]false[/code] if the Theme does not have [code]type[/code].
</description>
</method>
<method name="has_font" qualifiers="const">
@@ -236,7 +236,7 @@
</argument>
<description>
Returns [code]true[/code] if [Font] with [code]name[/code] is in [code]type[/code].
- Returns [code]false[/code] if Theme does not have [code]type[/code].
+ Returns [code]false[/code] if the Theme does not have [code]type[/code].
</description>
</method>
<method name="has_icon" qualifiers="const">
@@ -248,7 +248,7 @@
</argument>
<description>
Returns [code]true[/code] if icon [Texture] with [code]name[/code] is in [code]type[/code].
- Returns [code]false[/code] if Theme does not have [code]type[/code].
+ Returns [code]false[/code] if the Theme does not have [code]type[/code].
</description>
</method>
<method name="has_stylebox" qualifiers="const">
@@ -260,7 +260,7 @@
</argument>
<description>
Returns [code]true[/code] if [StyleBox] with [code]name[/code] is in [code]type[/code].
- Returns [code]false[/code] if Theme does not have [code]type[/code].
+ Returns [code]false[/code] if the Theme does not have [code]type[/code].
</description>
</method>
<method name="set_color">
@@ -273,8 +273,8 @@
<argument index="2" name="color" type="Color">
</argument>
<description>
- Sets Theme's [Color] to [code]color[/code] at [code]name[/code] in [code]type[/code].
- Does nothing if Theme does not have [code]type[/code].
+ Sets the Theme's [Color] to [code]color[/code] at [code]name[/code] in [code]type[/code].
+ Does nothing if the Theme does not have [code]type[/code].
</description>
</method>
<method name="set_constant">
@@ -287,8 +287,8 @@
<argument index="2" name="constant" type="int">
</argument>
<description>
- Sets Theme's constant to [code]constant[/code] at [code]name[/code] in [code]type[/code].
- Does nothing if Theme does not have [code]type[/code].
+ Sets the Theme's constant to [code]constant[/code] at [code]name[/code] in [code]type[/code].
+ Does nothing if the Theme does not have [code]type[/code].
</description>
</method>
<method name="set_font">
@@ -301,8 +301,8 @@
<argument index="2" name="font" type="Font">
</argument>
<description>
- Sets Theme's [Font] to [code]font[/code] at [code]name[/code] in [code]type[/code].
- Does nothing if Theme does not have [code]type[/code].
+ Sets the Theme's [Font] to [code]font[/code] at [code]name[/code] in [code]type[/code].
+ Does nothing if the Theme does not have [code]type[/code].
</description>
</method>
<method name="set_icon">
@@ -315,8 +315,8 @@
<argument index="2" name="texture" type="Texture">
</argument>
<description>
- Sets Theme's icon [Texture] to [code]texture[/code] at [code]name[/code] in [code]type[/code].
- Does nothing if Theme does not have [code]type[/code].
+ Sets the Theme's icon [Texture] to [code]texture[/code] at [code]name[/code] in [code]type[/code].
+ Does nothing if the Theme does not have [code]type[/code].
</description>
</method>
<method name="set_stylebox">
@@ -330,7 +330,7 @@
</argument>
<description>
Sets Theme's [StyleBox] to [code]stylebox[/code] at [code]name[/code] in [code]type[/code].
- Does nothing if Theme does not have [code]type[/code].
+ Does nothing if the Theme does not have [code]type[/code].
</description>
</method>
</methods>