diff options
Diffstat (limited to 'doc/classes/TextureProgress.xml')
| -rw-r--r-- | doc/classes/TextureProgress.xml | 189 |
1 files changed, 189 insertions, 0 deletions
diff --git a/doc/classes/TextureProgress.xml b/doc/classes/TextureProgress.xml new file mode 100644 index 0000000000..1ac031c411 --- /dev/null +++ b/doc/classes/TextureProgress.xml @@ -0,0 +1,189 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="TextureProgress" inherits="Range" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Textured progress bar implementation. + </brief_description> + <description> + [ProgressBar] implementation that is easier to theme (by just passing a few textures). + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="get_fill_degrees"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_fill_mode"> + <return type="int"> + </return> + <description> + </description> + </method> + <method name="get_nine_patch_stretch" qualifiers="const"> + <return type="bool"> + </return> + <description> + Returns true if textures are stretched as nine-patches or false otherwise. + </description> + </method> + <method name="get_over_texture" qualifiers="const"> + <return type="Texture"> + </return> + <description> + </description> + </method> + <method name="get_progress_texture" qualifiers="const"> + <return type="Texture"> + </return> + <description> + </description> + </method> + <method name="get_radial_center_offset"> + <return type="Vector2"> + </return> + <description> + </description> + </method> + <method name="get_radial_initial_angle"> + <return type="float"> + </return> + <description> + </description> + </method> + <method name="get_stretch_margin" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="margin" type="int" enum="Margin"> + </argument> + <description> + Return nine-patch texture offset for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). + </description> + </method> + <method name="get_under_texture" qualifiers="const"> + <return type="Texture"> + </return> + <description> + </description> + </method> + <method name="set_fill_degrees"> + <return type="void"> + </return> + <argument index="0" name="mode" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_fill_mode"> + <return type="void"> + </return> + <argument index="0" name="mode" type="int"> + </argument> + <description> + </description> + </method> + <method name="set_nine_patch_stretch"> + <return type="void"> + </return> + <argument index="0" name="stretch" type="bool"> + </argument> + <description> + Set if textures should be stretched as nine-patches. + </description> + </method> + <method name="set_over_texture"> + <return type="void"> + </return> + <argument index="0" name="tex" type="Texture"> + </argument> + <description> + </description> + </method> + <method name="set_progress_texture"> + <return type="void"> + </return> + <argument index="0" name="tex" type="Texture"> + </argument> + <description> + </description> + </method> + <method name="set_radial_center_offset"> + <return type="void"> + </return> + <argument index="0" name="mode" type="Vector2"> + </argument> + <description> + </description> + </method> + <method name="set_radial_initial_angle"> + <return type="void"> + </return> + <argument index="0" name="mode" type="float"> + </argument> + <description> + </description> + </method> + <method name="set_stretch_margin"> + <return type="void"> + </return> + <argument index="0" name="margin" type="int" enum="Margin"> + </argument> + <argument index="1" name="value" type="int"> + </argument> + <description> + Set nine-patch texture offset for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM). + </description> + </method> + <method name="set_under_texture"> + <return type="void"> + </return> + <argument index="0" name="tex" type="Texture"> + </argument> + <description> + </description> + </method> + </methods> + <members> + <member name="fill_mode" type="int" setter="set_fill_mode" getter="get_fill_mode"> + </member> + <member name="nine_patch_stretch" type="bool" setter="set_nine_patch_stretch" getter="get_nine_patch_stretch"> + </member> + <member name="radial_center_offset" type="Vector2" setter="set_radial_center_offset" getter="get_radial_center_offset"> + </member> + <member name="radial_fill_degrees" type="float" setter="set_fill_degrees" getter="get_fill_degrees"> + </member> + <member name="radial_initial_angle" type="float" setter="set_radial_initial_angle" getter="get_radial_initial_angle"> + </member> + <member name="stretch_margin_bottom" type="int" setter="set_stretch_margin" getter="get_stretch_margin"> + </member> + <member name="stretch_margin_left" type="int" setter="set_stretch_margin" getter="get_stretch_margin"> + </member> + <member name="stretch_margin_right" type="int" setter="set_stretch_margin" getter="get_stretch_margin"> + </member> + <member name="stretch_margin_top" type="int" setter="set_stretch_margin" getter="get_stretch_margin"> + </member> + <member name="texture_over" type="Texture" setter="set_over_texture" getter="get_over_texture"> + </member> + <member name="texture_progress" type="Texture" setter="set_progress_texture" getter="get_progress_texture"> + </member> + <member name="texture_under" type="Texture" setter="set_under_texture" getter="get_under_texture"> + </member> + </members> + <constants> + <constant name="FILL_LEFT_TO_RIGHT" value="0"> + </constant> + <constant name="FILL_RIGHT_TO_LEFT" value="1"> + </constant> + <constant name="FILL_TOP_TO_BOTTOM" value="2"> + </constant> + <constant name="FILL_BOTTOM_TO_TOP" value="3"> + </constant> + <constant name="FILL_CLOCKWISE" value="4"> + </constant> + <constant name="FILL_COUNTER_CLOCKWISE" value="5"> + </constant> + </constants> +</class> |