Theme¶
Inherits: Resource < RefCounted < Object
A resource used for styling/skinning Controls and Windows.
Description¶
A resource used for styling/skinning Control and Window nodes. While individual controls can be styled using their local theme overrides (see Control.add_theme_color_override), theme resources allow you to store and apply the same settings across all controls sharing the same type (e.g. style all Buttons 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 resource assigned to a control 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 ProjectSettings.gui/theme/custom to set up a project-scope theme that will be available to every control in your project.
Use 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.
Tutorials¶
Properties¶
|
||
|
Methods¶
Enumerations¶
enum DataType:
DataType DATA_TYPE_COLOR = 0
Theme's Color item type.
DataType DATA_TYPE_CONSTANT = 1
Theme's constant item type.
DataType DATA_TYPE_FONT = 2
Theme's Font item type.
DataType DATA_TYPE_FONT_SIZE = 3
Theme's font size item type.
DataType DATA_TYPE_ICON = 4
Theme's icon Texture2D item type.
DataType DATA_TYPE_STYLEBOX = 5
Theme's StyleBox item type.
DataType DATA_TYPE_MAX = 6
Maximum value for the DataType enum.
Property Descriptions¶
float default_base_scale = 0.0
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 0.0, the global scale factor is used (see ThemeDB.fallback_base_scale).
Use has_default_base_scale to check if this value is valid.
Font default_font
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 ThemeDB.fallback_font).
Use has_default_font to check if this value is valid.
int default_font_size = -1
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 ThemeDB.fallback_font_size).
Values below 0 are invalid and can be used to unset the property. Use has_default_font_size to check if this value is valid.
Method Descriptions¶
void add_type ( StringName theme_type )
Adds an empty theme type for every valid data type.
Note: Empty types are not saved with the theme. This method only exists to perform in-memory changes to the resource. Use available set_* methods to add theme items.
void clear ( )
Removes all the theme properties defined on the theme resource.
void clear_color ( StringName name, StringName theme_type )
Removes the Color property defined by name and theme_type, if it exists.
Fails if it doesn't exist. Use has_color to check for existence.
void clear_constant ( StringName name, StringName theme_type )
Removes the constant property defined by name and theme_type, if it exists.
Fails if it doesn't exist. Use has_constant to check for existence.
void clear_font ( StringName name, StringName theme_type )
Removes the Font property defined by name and theme_type, if it exists.
Fails if it doesn't exist. Use has_font to check for existence.
void clear_font_size ( StringName name, StringName theme_type )
Removes the font size property defined by name and theme_type, if it exists.
Fails if it doesn't exist. Use has_font_size to check for existence.
void clear_icon ( StringName name, StringName theme_type )
Removes the icon property defined by name and theme_type, if it exists.
Fails if it doesn't exist. Use has_icon to check for existence.
void clear_stylebox ( StringName name, StringName theme_type )
Removes the StyleBox property defined by name and theme_type, if it exists.
Fails if it doesn't exist. Use has_stylebox to check for existence.
void clear_theme_item ( DataType data_type, StringName name, StringName theme_type )
Removes the theme property of data_type defined by name and theme_type, if it exists.
Fails if it doesn't exist. Use has_theme_item to check for existence.
Note: This method is analogous to calling the corresponding data type specific method, but can be used for more generalized logic.
void clear_type_variation ( StringName theme_type )
Unmarks theme_type as being a variation of another theme type. See set_type_variation.
Color get_color ( StringName name, StringName theme_type ) const
Returns the Color property defined by name and theme_type, if it exists.
Returns the default color value if the property doesn't exist. Use has_color to check for existence.
PackedStringArray get_color_list ( String theme_type ) const
Returns a list of names for Color properties defined with theme_type. Use get_color_type_list to get a list of possible theme type names.
PackedStringArray get_color_type_list ( ) const
Returns a list of all unique theme type names for Color properties. Use get_type_list to get a list of all unique theme types.
int get_constant ( StringName name, StringName theme_type ) const
Returns the constant property defined by name and theme_type, if it exists.
Returns 0 if the property doesn't exist. Use has_constant to check for existence.
PackedStringArray get_constant_list ( String theme_type ) const
Returns a list of names for constant properties defined with theme_type. Use get_constant_type_list to get a list of possible theme type names.
PackedStringArray get_constant_type_list ( ) const
Returns a list of all unique theme type names for constant properties. Use get_type_list to get a list of all unique theme types.
Font get_font ( StringName name, StringName theme_type ) const
Returns the Font property defined by name and theme_type, if it exists.
Returns the default theme font if the property doesn't exist and the default theme font is set up (see default_font). Use has_font to check for existence of the property and has_default_font to check for existence of the default theme font.
Returns the engine fallback font value, if neither exist (see ThemeDB.fallback_font).
PackedStringArray get_font_list ( String theme_type ) const
Returns a list of names for Font properties defined with theme_type. Use get_font_type_list to get a list of possible theme type names.
int get_font_size ( StringName name, StringName theme_type ) const
Returns the font size property defined by name and theme_type, if it exists.
Returns the default theme font size if the property doesn't exist and the default theme font size is set up (see default_font_size). Use has_font_size to check for existence of the property and has_default_font_size to check for existence of the default theme font.
Returns the engine fallback font size value, if neither exist (see ThemeDB.fallback_font_size).
PackedStringArray get_font_size_list ( String theme_type ) const
Returns a list of names for font size properties defined with theme_type. Use get_font_size_type_list to get a list of possible theme type names.
PackedStringArray get_font_size_type_list ( ) const
Returns a list of all unique theme type names for font size properties. Use get_type_list to get a list of all unique theme types.
PackedStringArray get_font_type_list ( ) const
Returns a list of all unique theme type names for Font properties. Use get_type_list to get a list of all unique theme types.
Texture2D get_icon ( StringName name, StringName theme_type ) const
Returns the icon property defined by name and theme_type, if it exists.
Returns the engine fallback icon value if the property doesn't exist (see ThemeDB.fallback_icon). Use has_icon to check for existence.
PackedStringArray get_icon_list ( String theme_type ) const
Returns a list of names for icon properties defined with theme_type. Use get_icon_type_list to get a list of possible theme type names.
PackedStringArray get_icon_type_list ( ) const
Returns a list of all unique theme type names for icon properties. Use get_type_list to get a list of all unique theme types.
StyleBox get_stylebox ( StringName name, StringName theme_type ) const
Returns the StyleBox property defined by name and theme_type, if it exists.
Returns the engine fallback stylebox value if the property doesn't exist (see ThemeDB.fallback_stylebox). Use has_stylebox to check for existence.
PackedStringArray get_stylebox_list ( String theme_type ) const
Returns a list of names for StyleBox properties defined with theme_type. Use get_stylebox_type_list to get a list of possible theme type names.
PackedStringArray get_stylebox_type_list ( ) const
Returns a list of all unique theme type names for StyleBox properties. Use get_type_list to get a list of all unique theme types.
Variant get_theme_item ( DataType data_type, StringName name, StringName theme_type ) const
Returns the theme property of data_type defined by name and theme_type, if it exists.
Returns the engine fallback value if the property doesn't exist (see ThemeDB). Use has_theme_item to check for existence.
Note: This method is analogous to calling the corresponding data type specific method, but can be used for more generalized logic.
PackedStringArray get_theme_item_list ( DataType data_type, String theme_type ) const
Returns a list of names for properties of data_type defined with theme_type. Use get_theme_item_type_list to get a list of possible theme type names.
Note: This method is analogous to calling the corresponding data type specific method, but can be used for more generalized logic.
PackedStringArray get_theme_item_type_list ( DataType data_type ) const
Returns a list of all unique theme type names for data_type properties. Use get_type_list to get a list of all unique theme types.
Note: This method is analogous to calling the corresponding data type specific method, but can be used for more generalized logic.
PackedStringArray get_type_list ( ) const
Returns a list of all unique theme type names. Use the appropriate get_*_type_list method to get a list of unique theme types for a single data type.
StringName get_type_variation_base ( StringName theme_type ) const
Returns the name of the base theme type if theme_type is a valid variation type. Returns an empty string otherwise.
PackedStringArray get_type_variation_list ( StringName base_type ) const
Returns a list of all type variations for the given base_type.
bool has_color ( StringName name, StringName theme_type ) const
Returns true if the Color property defined by name and theme_type exists.
Returns false if it doesn't exist. Use set_color to define it.
bool has_constant ( StringName name, StringName theme_type ) const
Returns true if the constant property defined by name and theme_type exists.
Returns false if it doesn't exist. Use set_constant to define it.
bool has_default_base_scale ( ) const
Returns true if default_base_scale has a valid value.
Returns false if it doesn't. The value must be greater than 0.0 to be considered valid.
bool has_default_font ( ) const
Returns true if default_font has a valid value.
Returns false if it doesn't.
bool has_default_font_size ( ) const
Returns true if default_font_size has a valid value.
Returns false if it doesn't. The value must be greater than 0 to be considered valid.
bool has_font ( StringName name, StringName theme_type ) const
Returns true if the Font property defined by name and theme_type exists, or if the default theme font is set up (see has_default_font).
Returns false if neither exist. Use set_font to define the property.
bool has_font_size ( StringName name, StringName theme_type ) const
Returns true if the font size property defined by name and theme_type exists, or if the default theme font size is set up (see has_default_font_size).
Returns false if neither exist. Use set_font_size to define the property.
bool has_icon ( StringName name, StringName theme_type ) const
Returns true if the icon property defined by name and theme_type exists.
Returns false if it doesn't exist. Use set_icon to define it.
bool has_stylebox ( StringName name, StringName theme_type ) const
Returns true if the StyleBox property defined by name and theme_type exists.
Returns false if it doesn't exist. Use set_stylebox to define it.
bool has_theme_item ( DataType data_type, StringName name, StringName theme_type ) const
Returns true if the theme property of data_type defined by name and theme_type exists.
Returns false if it doesn't exist. Use set_theme_item to define it.
Note: This method is analogous to calling the corresponding data type specific method, but can be used for more generalized logic.
bool is_type_variation ( StringName theme_type, StringName base_type ) const
Returns true if theme_type is marked as a variation of base_type.
void merge_with ( Theme other )
Adds missing and overrides existing definitions with values from the other theme resource.
Note: 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.
void remove_type ( StringName theme_type )
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.
void rename_color ( StringName old_name, StringName name, StringName theme_type )
Renames the Color property defined by old_name and theme_type to name, if it exists.
Fails if it doesn't exist, or if a similar property with the new name already exists. Use has_color to check for existence, and clear_color to remove the existing property.
void rename_constant ( StringName old_name, StringName name, StringName theme_type )
Renames the constant property defined by old_name and theme_type to name, if it exists.
Fails if it doesn't exist, or if a similar property with the new name already exists. Use has_constant to check for existence, and clear_constant to remove the existing property.
void rename_font ( StringName old_name, StringName name, StringName theme_type )
Renames the Font property defined by old_name and theme_type to name, if it exists.
Fails if it doesn't exist, or if a similar property with the new name already exists. Use has_font to check for existence, and clear_font to remove the existing property.
void rename_font_size ( StringName old_name, StringName name, StringName theme_type )
Renames the font size property defined by old_name and theme_type to name, if it exists.
Fails if it doesn't exist, or if a similar property with the new name already exists. Use has_font_size to check for existence, and clear_font_size to remove the existing property.
void rename_icon ( StringName old_name, StringName name, StringName theme_type )
Renames the icon property defined by old_name and theme_type to name, if it exists.
Fails if it doesn't exist, or if a similar property with the new name already exists. Use has_icon to check for existence, and clear_icon to remove the existing property.
void rename_stylebox ( StringName old_name, StringName name, StringName theme_type )
Renames the StyleBox property defined by old_name and theme_type to name, if it exists.
Fails if it doesn't exist, or if a similar property with the new name already exists. Use has_stylebox to check for existence, and clear_stylebox to remove the existing property.
void rename_theme_item ( DataType data_type, StringName old_name, StringName name, StringName theme_type )
Renames the theme property of data_type defined by old_name and theme_type to name, if it exists.
Fails if it doesn't exist, or if a similar property with the new name already exists. Use has_theme_item to check for existence, and clear_theme_item to remove the existing property.
Note: This method is analogous to calling the corresponding data type specific method, but can be used for more generalized logic.
void set_color ( StringName name, StringName theme_type, Color color )
Creates or changes the value of the Color property defined by name and theme_type. Use clear_color to remove the property.
void set_constant ( StringName name, StringName theme_type, int constant )
Creates or changes the value of the constant property defined by name and theme_type. Use clear_constant to remove the property.
void set_font ( StringName name, StringName theme_type, Font font )
Creates or changes the value of the Font property defined by name and theme_type. Use clear_font to remove the property.
void set_font_size ( StringName name, StringName theme_type, int font_size )
Creates or changes the value of the font size property defined by name and theme_type. Use clear_font_size to remove the property.
void set_icon ( StringName name, StringName theme_type, Texture2D texture )
Creates or changes the value of the icon property defined by name and theme_type. Use clear_icon to remove the property.
void set_stylebox ( StringName name, StringName theme_type, StyleBox texture )
Creates or changes the value of the StyleBox property defined by name and theme_type. Use clear_stylebox to remove the property.
void set_theme_item ( DataType data_type, StringName name, StringName theme_type, Variant value )
Creates or changes the value of the theme property of data_type defined by name and theme_type. Use clear_theme_item to remove the property.
Fails if the value type is not accepted by data_type.
Note: This method is analogous to calling the corresponding data type specific method, but can be used for more generalized logic.
void set_type_variation ( StringName theme_type, StringName base_type )
Marks theme_type as a variation of base_type.
This adds theme_type as a suggested option for Control.theme_type_variation on a Control that is of the base_type class.
Variations can also be nested, i.e. base_type can be another variation. If a chain of variations ends with a base_type matching the class of the Control, the whole chain is going to be suggested as options.
Note: Suggestions only show up if this theme resource is set as the project default theme. See ProjectSettings.gui/theme/custom.