godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-05 22:09:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

dync classref with current source

Browse Source
This commit is contained in:
Rémi Verschelde
2019-06-29 12:36:34 +02:00
parent 7d1e807f69
commit 05d7b34796
349 changed files with 3655 additions and 2920 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
classes/class_theme.rst
View File

@@ -91,9 +91,9 @@ Methods
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 :ref:`Control<class_Control>`, and it and its children will automatically use it.
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 :ref:`Control<class_Control>`; the Control 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.
Theme resources can alternatively be loaded by writing them in a ``.theme`` file, see the documentation for more information.
Tutorials
---------
@@ -126,37 +126,37 @@ Method Descriptions
- void **clear_color** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type **)**
Clears theme :ref:`Color<class_Color>` at ``name`` if Theme has ``type``.
Clears the :ref:`Color<class_Color>` at ``name`` if the Theme has ``type``.
.. _class_Theme_method_clear_constant:
- void **clear_constant** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type **)**
Clears theme constant at ``name`` if Theme has ``type``.
Clears the constant at ``name`` if the Theme has ``type``.
.. _class_Theme_method_clear_font:
- void **clear_font** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type **)**
Clears :ref:`Font<class_Font>` at ``name`` if Theme has ``type``.
Clears the :ref:`Font<class_Font>` at ``name`` if the Theme has ``type``.
.. _class_Theme_method_clear_icon:
- void **clear_icon** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type **)**
Clears icon at ``name`` if Theme has ``type``.
Clears the icon at ``name`` if the Theme has ``type``.
.. _class_Theme_method_clear_stylebox:
- void **clear_stylebox** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type **)**
Clears :ref:`StyleBox<class_StyleBox>` at ``name`` if Theme has ``type``.
Clears :ref:`StyleBox<class_StyleBox>` at ``name`` if the Theme has ``type``.
.. _class_Theme_method_copy_default_theme:
- void **copy_default_theme** **(** **)**
Sets theme values to a copy of the default theme values.
Sets the Theme's values to a copy of the default theme values.
.. _class_Theme_method_copy_theme:
@@ -166,73 +166,73 @@ Sets theme values to a copy of the default theme values.
- :ref:`Color<class_Color>` **get_color** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type **)** const
Returns the :ref:`Color<class_Color>` at ``name`` if Theme has ``type``.
Returns the :ref:`Color<class_Color>` at ``name`` if the Theme has ``type``.
.. _class_Theme_method_get_color_list:
- :ref:`PoolStringArray<class_PoolStringArray>` **get_color_list** **(** :ref:`String<class_String>` type **)** const
Returns all of the :ref:`Color<class_Color>`\ s as a :ref:`PoolStringArray<class_PoolStringArray>` filled with each :ref:`Color<class_Color>`'s name, for use in :ref:`get_color<class_Theme_method_get_color>`, if Theme has ``type``.
Returns all the :ref:`Color<class_Color>`\ s as a :ref:`PoolStringArray<class_PoolStringArray>` filled with each :ref:`Color<class_Color>`'s name, for use in :ref:`get_color<class_Theme_method_get_color>`, if the Theme has ``type``.
.. _class_Theme_method_get_constant:
- :ref:`int<class_int>` **get_constant** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type **)** const
Returns the constant at ``name`` if Theme has ``type``.
Returns the constant at ``name`` if the Theme has ``type``.
.. _class_Theme_method_get_constant_list:
- :ref:`PoolStringArray<class_PoolStringArray>` **get_constant_list** **(** :ref:`String<class_String>` type **)** const
Returns all of the constants as a :ref:`PoolStringArray<class_PoolStringArray>` filled with each constant's name, for use in :ref:`get_constant<class_Theme_method_get_constant>`, if Theme has ``type``.
Returns all the constants as a :ref:`PoolStringArray<class_PoolStringArray>` filled with each constant's name, for use in :ref:`get_constant<class_Theme_method_get_constant>`, if the Theme has ``type``.
.. _class_Theme_method_get_font:
- :ref:`Font<class_Font>` **get_font** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type **)** const
Returns the :ref:`Font<class_Font>` at ``name`` if Theme has ``type``.
Returns the :ref:`Font<class_Font>` at ``name`` if the Theme has ``type``.
.. _class_Theme_method_get_font_list:
- :ref:`PoolStringArray<class_PoolStringArray>` **get_font_list** **(** :ref:`String<class_String>` type **)** const
Returns all of the :ref:`Font<class_Font>`\ s as a :ref:`PoolStringArray<class_PoolStringArray>` filled with each :ref:`Font<class_Font>`'s name, for use in :ref:`get_font<class_Theme_method_get_font>`, if Theme has ``type``.
Returns all the :ref:`Font<class_Font>`\ s as a :ref:`PoolStringArray<class_PoolStringArray>` filled with each :ref:`Font<class_Font>`'s name, for use in :ref:`get_font<class_Theme_method_get_font>`, if the Theme has ``type``.
.. _class_Theme_method_get_icon:
- :ref:`Texture<class_Texture>` **get_icon** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type **)** const
Returns the icon :ref:`Texture<class_Texture>` at ``name`` if Theme has ``type``.
Returns the icon :ref:`Texture<class_Texture>` at ``name`` if the Theme has ``type``.
.. _class_Theme_method_get_icon_list:
- :ref:`PoolStringArray<class_PoolStringArray>` **get_icon_list** **(** :ref:`String<class_String>` type **)** const
Returns all of the icons as a :ref:`PoolStringArray<class_PoolStringArray>` filled with each :ref:`Texture<class_Texture>`'s name, for use in :ref:`get_icon<class_Theme_method_get_icon>`, if Theme has ``type``.
Returns all the icons as a :ref:`PoolStringArray<class_PoolStringArray>` filled with each :ref:`Texture<class_Texture>`'s name, for use in :ref:`get_icon<class_Theme_method_get_icon>`, if the Theme has ``type``.
.. _class_Theme_method_get_stylebox:
- :ref:`StyleBox<class_StyleBox>` **get_stylebox** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type **)** const
Returns the icon :ref:`StyleBox<class_StyleBox>` at ``name`` if Theme has ``type``.
Returns the icon :ref:`StyleBox<class_StyleBox>` at ``name`` if the Theme has ``type``.
.. _class_Theme_method_get_stylebox_list:
- :ref:`PoolStringArray<class_PoolStringArray>` **get_stylebox_list** **(** :ref:`String<class_String>` type **)** const
Returns all of the :ref:`StyleBox<class_StyleBox>`\ s as a :ref:`PoolStringArray<class_PoolStringArray>` filled with each :ref:`StyleBox<class_StyleBox>`'s name, for use in :ref:`get_stylebox<class_Theme_method_get_stylebox>`, if Theme has ``type``.
Returns all the :ref:`StyleBox<class_StyleBox>`\ s as a :ref:`PoolStringArray<class_PoolStringArray>` filled with each :ref:`StyleBox<class_StyleBox>`'s name, for use in :ref:`get_stylebox<class_Theme_method_get_stylebox>`, if the Theme has ``type``.
.. _class_Theme_method_get_stylebox_types:
- :ref:`PoolStringArray<class_PoolStringArray>` **get_stylebox_types** **(** **)** const
Returns all of the :ref:`StyleBox<class_StyleBox>` types as a :ref:`PoolStringArray<class_PoolStringArray>` filled with each :ref:`StyleBox<class_StyleBox>`'s type, for use in :ref:`get_stylebox<class_Theme_method_get_stylebox>` and/or :ref:`get_stylebox_list<class_Theme_method_get_stylebox_list>`, if Theme has ``type``.
Returns all the :ref:`StyleBox<class_StyleBox>` types as a :ref:`PoolStringArray<class_PoolStringArray>` filled with each :ref:`StyleBox<class_StyleBox>`'s type, for use in :ref:`get_stylebox<class_Theme_method_get_stylebox>` and/or :ref:`get_stylebox_list<class_Theme_method_get_stylebox_list>`, if the Theme has ``type``.
.. _class_Theme_method_get_type_list:
- :ref:`PoolStringArray<class_PoolStringArray>` **get_type_list** **(** :ref:`String<class_String>` type **)** const
Returns all of the types in ``type`` as a :ref:`PoolStringArray<class_PoolStringArray>` for use in any of the get\_\* functions, if Theme has ``type``.
Returns all the types in ``type`` as a :ref:`PoolStringArray<class_PoolStringArray>` for use in any of the get\_\* functions, if the Theme has ``type``.
.. _class_Theme_method_has_color:
@@ -240,7 +240,7 @@ Returns all of the types in ``type`` as a :ref:`PoolStringArray<class_PoolString
Returns ``true`` if :ref:`Color<class_Color>` with ``name`` is in ``type``.
Returns ``false`` if Theme does not have ``type``.
Returns ``false`` if the Theme does not have ``type``.
.. _class_Theme_method_has_constant:
@@ -248,7 +248,7 @@ Returns ``false`` if Theme does not have ``type``.
Returns ``true`` if constant with ``name`` is in ``type``.
Returns ``false`` if Theme does not have ``type``.
Returns ``false`` if the Theme does not have ``type``.
.. _class_Theme_method_has_font:
@@ -256,7 +256,7 @@ Returns ``false`` if Theme does not have ``type``.
Returns ``true`` if :ref:`Font<class_Font>` with ``name`` is in ``type``.
Returns ``false`` if Theme does not have ``type``.
Returns ``false`` if the Theme does not have ``type``.
.. _class_Theme_method_has_icon:
@@ -264,7 +264,7 @@ Returns ``false`` if Theme does not have ``type``.
Returns ``true`` if icon :ref:`Texture<class_Texture>` with ``name`` is in ``type``.
Returns ``false`` if Theme does not have ``type``.
Returns ``false`` if the Theme does not have ``type``.
.. _class_Theme_method_has_stylebox:
@@ -272,39 +272,39 @@ Returns ``false`` if Theme does not have ``type``.
Returns ``true`` if :ref:`StyleBox<class_StyleBox>` with ``name`` is in ``type``.
Returns ``false`` if Theme does not have ``type``.
Returns ``false`` if the Theme does not have ``type``.
.. _class_Theme_method_set_color:
- void **set_color** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type, :ref:`Color<class_Color>` color **)**
Sets Theme's :ref:`Color<class_Color>` to ``color`` at ``name`` in ``type``.
Sets the Theme's :ref:`Color<class_Color>` to ``color`` at ``name`` in ``type``.
Does nothing if Theme does not have ``type``.
Does nothing if the Theme does not have ``type``.
.. _class_Theme_method_set_constant:
- void **set_constant** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type, :ref:`int<class_int>` constant **)**
Sets Theme's constant to ``constant`` at ``name`` in ``type``.
Sets the Theme's constant to ``constant`` at ``name`` in ``type``.
Does nothing if Theme does not have ``type``.
Does nothing if the Theme does not have ``type``.
.. _class_Theme_method_set_font:
- void **set_font** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type, :ref:`Font<class_Font>` font **)**
Sets Theme's :ref:`Font<class_Font>` to ``font`` at ``name`` in ``type``.
Sets the Theme's :ref:`Font<class_Font>` to ``font`` at ``name`` in ``type``.
Does nothing if Theme does not have ``type``.
Does nothing if the Theme does not have ``type``.
.. _class_Theme_method_set_icon:
- void **set_icon** **(** :ref:`String<class_String>` name, :ref:`String<class_String>` type, :ref:`Texture<class_Texture>` texture **)**
Sets Theme's icon :ref:`Texture<class_Texture>` to ``texture`` at ``name`` in ``type``.
Sets the Theme's icon :ref:`Texture<class_Texture>` to ``texture`` at ``name`` in ``type``.
Does nothing if Theme does not have ``type``.
Does nothing if the Theme does not have ``type``.
.. _class_Theme_method_set_stylebox:
@@ -312,5 +312,5 @@ Does nothing if Theme does not have ``type``.
Sets Theme's :ref:`StyleBox<class_StyleBox>` to ``stylebox`` at ``name`` in ``type``.
Does nothing if Theme does not have ``type``.
Does nothing if the Theme does not have ``type``.