godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2025-12-31 17:49:03 +03:00
Code Issues Packages Projects Releases Wiki Activity
Files
2.1
godot-docs/classes/class_theme.rst
Rémi Verschelde f629e839e5 Sync classref with 2.1 source, goodbye 2.0!
2016-08-10 21:33:38 +02:00

214 lines
18 KiB
ReStructuredText
Raw Permalink Blame History

.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
.. _class_Theme:
Theme
=====
**Inherits:** :ref:`Resource<class_resource>` **<** :ref:`Reference<class_reference>` **<** :ref:`Object<class_object>`
**Category:** Core
Brief Description
-----------------
Theme for controls.
Member Functions
----------------
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_color<class_Theme_clear_color>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_constant<class_Theme_clear_constant>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_font<class_Theme_clear_font>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_icon<class_Theme_clear_icon>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`clear_stylebox<class_Theme_clear_stylebox>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`copy_default_theme<class_Theme_copy_default_theme>` **(** **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Color<class_color>` | :ref:`get_color<class_Theme_get_color>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringArray<class_stringarray>` | :ref:`get_color_list<class_Theme_get_color_list>` **(** :ref:`String<class_string>` type **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_constant<class_Theme_get_constant>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringArray<class_stringarray>` | :ref:`get_constant_list<class_Theme_get_constant_list>` **(** :ref:`String<class_string>` type **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Object<class_object>` | :ref:`get_default_font<class_Theme_get_default_font>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Font<class_font>` | :ref:`get_font<class_Theme_get_font>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringArray<class_stringarray>` | :ref:`get_font_list<class_Theme_get_font_list>` **(** :ref:`String<class_string>` type **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Texture<class_texture>` | :ref:`get_icon<class_Theme_get_icon>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringArray<class_stringarray>` | :ref:`get_icon_list<class_Theme_get_icon_list>` **(** :ref:`String<class_string>` type **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StyleBox<class_stylebox>` | :ref:`get_stylebox<class_Theme_get_stylebox>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringArray<class_stringarray>` | :ref:`get_stylebox_list<class_Theme_get_stylebox_list>` **(** :ref:`String<class_string>` type **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringArray<class_stringarray>` | :ref:`get_stylebox_types<class_Theme_get_stylebox_types>` **(** **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`StringArray<class_stringarray>` | :ref:`get_type_list<class_Theme_get_type_list>` **(** :ref:`String<class_string>` type **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_color<class_Theme_has_color>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_constant<class_Theme_has_constant>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_font<class_Theme_has_font>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_icon<class_Theme_has_icon>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`has_stylebox<class_Theme_has_stylebox>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type **)** const |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_color<class_Theme_set_color>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type, :ref:`Color<class_color>` color **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_constant<class_Theme_set_constant>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type, :ref:`int<class_int>` constant **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_default_font<class_Theme_set_default_font>` **(** :ref:`Object<class_object>` font **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_font<class_Theme_set_font>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type, :ref:`Font<class_font>` font **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_icon<class_Theme_set_icon>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type, :ref:`Texture<class_texture>` texture **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| void | :ref:`set_stylebox<class_Theme_set_stylebox>` **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type, :ref:`StyleBox<class_stylebox>` texture **)** |
+----------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
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.
Theme resources can be alternatively loaded by writing them in a .theme file, see docs for more info.
Member Function Description
---------------------------
.. _class_Theme_clear_color:
- void **clear_color** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type **)**
.. _class_Theme_clear_constant:
- void **clear_constant** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type **)**
.. _class_Theme_clear_font:
- void **clear_font** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type **)**
.. _class_Theme_clear_icon:
- void **clear_icon** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type **)**
.. _class_Theme_clear_stylebox:
- void **clear_stylebox** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type **)**
.. _class_Theme_copy_default_theme:
- void **copy_default_theme** **(** **)**
.. _class_Theme_get_color:
- :ref:`Color<class_color>` **get_color** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type **)** const
.. _class_Theme_get_color_list:
- :ref:`StringArray<class_stringarray>` **get_color_list** **(** :ref:`String<class_string>` type **)** const
.. _class_Theme_get_constant:
- :ref:`int<class_int>` **get_constant** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type **)** const
.. _class_Theme_get_constant_list:
- :ref:`StringArray<class_stringarray>` **get_constant_list** **(** :ref:`String<class_string>` type **)** const
.. _class_Theme_get_default_font:
- :ref:`Object<class_object>` **get_default_font** **(** **)** const
.. _class_Theme_get_font:
- :ref:`Font<class_font>` **get_font** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type **)** const
.. _class_Theme_get_font_list:
- :ref:`StringArray<class_stringarray>` **get_font_list** **(** :ref:`String<class_string>` type **)** const
.. _class_Theme_get_icon:
- :ref:`Texture<class_texture>` **get_icon** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type **)** const
.. _class_Theme_get_icon_list:
- :ref:`StringArray<class_stringarray>` **get_icon_list** **(** :ref:`String<class_string>` type **)** const
.. _class_Theme_get_stylebox:
- :ref:`StyleBox<class_stylebox>` **get_stylebox** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type **)** const
.. _class_Theme_get_stylebox_list:
- :ref:`StringArray<class_stringarray>` **get_stylebox_list** **(** :ref:`String<class_string>` type **)** const
.. _class_Theme_get_stylebox_types:
- :ref:`StringArray<class_stringarray>` **get_stylebox_types** **(** **)** const
.. _class_Theme_get_type_list:
- :ref:`StringArray<class_stringarray>` **get_type_list** **(** :ref:`String<class_string>` type **)** const
.. _class_Theme_has_color:
- :ref:`bool<class_bool>` **has_color** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type **)** const
.. _class_Theme_has_constant:
- :ref:`bool<class_bool>` **has_constant** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type **)** const
.. _class_Theme_has_font:
- :ref:`bool<class_bool>` **has_font** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type **)** const
.. _class_Theme_has_icon:
- :ref:`bool<class_bool>` **has_icon** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type **)** const
.. _class_Theme_has_stylebox:
- :ref:`bool<class_bool>` **has_stylebox** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type **)** const
.. _class_Theme_set_color:
- void **set_color** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type, :ref:`Color<class_color>` color **)**
.. _class_Theme_set_constant:
- void **set_constant** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type, :ref:`int<class_int>` constant **)**
.. _class_Theme_set_default_font:
- void **set_default_font** **(** :ref:`Object<class_object>` font **)**
.. _class_Theme_set_font:
- void **set_font** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type, :ref:`Font<class_font>` font **)**
.. _class_Theme_set_icon:
- void **set_icon** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type, :ref:`Texture<class_texture>` texture **)**
.. _class_Theme_set_stylebox:
- void **set_stylebox** **(** :ref:`String<class_string>` name, :ref:`String<class_string>` type, :ref:`StyleBox<class_stylebox>` texture **)**
Reference in New Issue View Git Blame Copy Permalink