W3cubDocs

Theme

Inherits: Resource < Reference < Object

Theme for controls.

Description

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 .theme file, see the documentation for more information.

Tutorials

GUI skinning

Properties

Font	default_font

Methods

void	clear ( )
void	clear_color ( String name, String type )
void	clear_constant ( String name, String type )
void	clear_font ( String name, String type )
void	clear_icon ( String name, String type )
void	clear_stylebox ( String name, String type )
void	copy_default_theme ( )
void	copy_theme ( Theme other )
Color	get_color ( String name, String type ) const
PoolStringArray	get_color_list ( String type ) const
int	get_constant ( String name, String type ) const
PoolStringArray	get_constant_list ( String type ) const
Font	get_font ( String name, String type ) const
PoolStringArray	get_font_list ( String type ) const
Texture	get_icon ( String name, String type ) const
PoolStringArray	get_icon_list ( String type ) const
StyleBox	get_stylebox ( String name, String type ) const
PoolStringArray	get_stylebox_list ( String type ) const
PoolStringArray	get_stylebox_types ( ) const
PoolStringArray	get_type_list ( String type ) const
bool	has_color ( String name, String type ) const
bool	has_constant ( String name, String type ) const
bool	has_font ( String name, String type ) const
bool	has_icon ( String name, String type ) const
bool	has_stylebox ( String name, String type ) const
void	set_color ( String name, String type, Color color )
void	set_constant ( String name, String type, int constant )
void	set_font ( String name, String type, Font font )
void	set_icon ( String name, String type, Texture texture )
void	set_stylebox ( String name, String type, StyleBox texture )

Property Descriptions

Font default_font

Setter	set_default_font(value)
Getter	get_default_font()

The theme's default font.

Method Descriptions

void clear ( )

Clears all values on the theme.

void clear_color ( String name, String type )

Clears the Color at name if the theme has type.

void clear_constant ( String name, String type )

Clears the constant at name if the theme has type.

void clear_font ( String name, String type )

Clears the Font at name if the theme has type.

void clear_icon ( String name, String type )

Clears the icon at name if the theme has type.

void clear_stylebox ( String name, String type )

Clears StyleBox at name if the theme has type.

void copy_default_theme ( )

Sets the theme's values to a copy of the default theme values.

void copy_theme ( Theme other )

Sets the theme's values to a copy of a given theme.

Color get_color ( String name, String type ) const

Returns the Color at name if the theme has type.

PoolStringArray get_color_list ( String type ) const

Returns all the Colors as a PoolStringArray filled with each Color's name, for use in get_color, if the theme has type.

int get_constant ( String name, String type ) const

Returns the constant at name if the theme has type.

PoolStringArray get_constant_list ( String type ) const

Returns all the constants as a PoolStringArray filled with each constant's name, for use in get_constant, if the theme has type.

Font get_font ( String name, String type ) const

Returns the Font at name if the theme has type.

PoolStringArray get_font_list ( String type ) const

Returns all the Fonts as a PoolStringArray filled with each Font's name, for use in get_font, if the theme has type.

Texture get_icon ( String name, String type ) const

Returns the icon Texture at name if the theme has type.

PoolStringArray get_icon_list ( String type ) const

Returns all the icons as a PoolStringArray filled with each Texture's name, for use in get_icon, if the theme has type.

StyleBox get_stylebox ( String name, String type ) const

Returns the icon StyleBox at name if the theme has type.

PoolStringArray get_stylebox_list ( String type ) const

Returns all the StyleBoxs as a PoolStringArray filled with each StyleBox's name, for use in get_stylebox, if the theme has type.

PoolStringArray get_stylebox_types ( ) const

Returns all the StyleBox types as a PoolStringArray filled with each StyleBox's type, for use in get_stylebox and/or get_stylebox_list, if the theme has type.

PoolStringArray get_type_list ( String type ) const

Returns all the types in type as a PoolStringArray for use in any of the get_* functions, if the theme has type.

bool has_color ( String name, String type ) const

Returns true if Color with name is in type.

Returns false if the theme does not have type.

bool has_constant ( String name, String type ) const

Returns true if constant with name is in type.

Returns false if the theme does not have type.

bool has_font ( String name, String type ) const

Returns true if Font with name is in type.

Returns false if the theme does not have type.

bool has_icon ( String name, String type ) const

Returns true if icon Texture with name is in type.

Returns false if the theme does not have type.

bool has_stylebox ( String name, String type ) const

Returns true if StyleBox with name is in type.

Returns false if the theme does not have type.