virtualx-engine/doc/classes/Theme.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="Theme" inherits="Resource" category="Core" version="3.0.2">
	<brief_description>
		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.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="clear_color">
			<return type="void">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<argument index="1" name="type" type="String">
			</argument>
			<description>
				Clears theme [Color] at [code]name[/code] if Theme has [code]type[/code].
			</description>
		</method>
		<method name="clear_constant">
			<return type="void">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<argument index="1" name="type" type="String">
			</argument>
			<description>
				Clears theme constant at [code]name[/code] if Theme has [code]type[/code].
			</description>
		</method>
		<method name="clear_font">
			<return type="void">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<argument index="1" name="type" type="String">
			</argument>
			<description>
				Clears [Font] at [code]name[/code] if Theme has [code]type[/code].
			</description>
		</method>
		<method name="clear_icon">
			<return type="void">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<argument index="1" name="type" type="String">
			</argument>
			<description>
				Clears icon at [code]name[/code] if Theme has [code]type[/code].
			</description>
		</method>
		<method name="clear_stylebox">
			<return type="void">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<argument index="1" name="type" type="String">
			</argument>
			<description>
				Clears [StyleBox] at [code]name[/code] if 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.
			</description>
		</method>
		<method name="get_color" qualifiers="const">
			<return type="Color">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<argument index="1" name="type" type="String">
			</argument>
			<description>
				Returns the [Color] at [code]name[/code] if Theme has [code]type[/code].
			</description>
		</method>
		<method name="get_color_list" qualifiers="const">
			<return type="PoolStringArray">
			</return>
			<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].
			</description>
		</method>
		<method name="get_constant" qualifiers="const">
			<return type="int">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<argument index="1" name="type" type="String">
			</argument>
			<description>
				Returns the constant at [code]name[/code] if Theme has [code]type[/code].
			</description>
		</method>
		<method name="get_constant_list" qualifiers="const">
			<return type="PoolStringArray">
			</return>
			<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].
			</description>
		</method>
		<method name="get_font" qualifiers="const">
			<return type="Font">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<argument index="1" name="type" type="String">
			</argument>
			<description>
				Returns the [Font] at [code]name[/code] if Theme has [code]type[/code].
			</description>
		</method>
		<method name="get_font_list" qualifiers="const">
			<return type="PoolStringArray">
			</return>
			<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].
			</description>
		</method>
		<method name="get_icon" qualifiers="const">
			<return type="Texture">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<argument index="1" name="type" type="String">
			</argument>
			<description>
				Returns the icon [Texture] at [code]name[/code] if Theme has [code]type[/code].
			</description>
		</method>
		<method name="get_icon_list" qualifiers="const">
			<return type="PoolStringArray">
			</return>
			<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].
			</description>
		</method>
		<method name="get_stylebox" qualifiers="const">
			<return type="StyleBox">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<argument index="1" name="type" type="String">
			</argument>
			<description>
				Returns the icon [StyleBox] at [code]name[/code] if Theme has [code]type[/code].
			</description>
		</method>
		<method name="get_stylebox_list" qualifiers="const">
			<return type="PoolStringArray">
			</return>
			<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].
			</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].
			</description>
		</method>
		<method name="get_type_list" qualifiers="const">
			<return type="PoolStringArray">
			</return>
			<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].
			</description>
		</method>
		<method name="has_color" qualifiers="const">
			<return type="bool">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<argument index="1" name="type" type="String">
			</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].
			</description>
		</method>
		<method name="has_constant" qualifiers="const">
			<return type="bool">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<argument index="1" name="type" type="String">
			</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].
			</description>
		</method>
		<method name="has_font" qualifiers="const">
			<return type="bool">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<argument index="1" name="type" type="String">
			</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].
			</description>
		</method>
		<method name="has_icon" qualifiers="const">
			<return type="bool">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<argument index="1" name="type" type="String">
			</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].
			</description>
		</method>
		<method name="has_stylebox" qualifiers="const">
			<return type="bool">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<argument index="1" name="type" type="String">
			</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].
			</description>
		</method>
		<method name="set_color">
			<return type="void">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<argument index="1" name="type" type="String">
			</argument>
			<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].
			</description>
		</method>
		<method name="set_constant">
			<return type="void">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<argument index="1" name="type" type="String">
			</argument>
			<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].
			</description>
		</method>
		<method name="set_font">
			<return type="void">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<argument index="1" name="type" type="String">
			</argument>
			<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].
			</description>
		</method>
		<method name="set_icon">
			<return type="void">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<argument index="1" name="type" type="String">
			</argument>
			<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].
			</description>
		</method>
		<method name="set_stylebox">
			<return type="void">
			</return>
			<argument index="0" name="name" type="String">
			</argument>
			<argument index="1" name="type" type="String">
			</argument>
			<argument index="2" name="texture" type="StyleBox">
			</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].
			</description>
		</method>
	</methods>
	<members>
		<member name="default_font" type="Font" setter="set_default_font" getter="get_default_font">
			The theme's default font.
		</member>
	</members>
	<constants>
	</constants>
</class>