virtualx-engine/doc/classes/ProgressBar.xml

40 lines
1.4 KiB
XML
Raw Normal View History

<?xml version="1.0" encoding="UTF-8" ?>
<class name="ProgressBar" inherits="Range" version="3.2">
<brief_description>
General-purpose progress bar.
</brief_description>
<description>
General-purpose progress bar. Shows fill percentage from right to left.
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="percent_visible" type="bool" setter="set_percent_visible" getter="is_percent_visible" default="true">
If [code]true[/code], the fill percentage is displayed on the bar.
</member>
<member name="size_flags_vertical" type="int" setter="set_v_size_flags" getter="get_v_size_flags" override="true" default="0" />
<member name="step" type="float" setter="set_step" getter="get_step" override="true" default="0.01" />
</members>
<constants>
</constants>
<theme_items>
<theme_item name="bg" type="StyleBox">
The style of the background.
</theme_item>
<theme_item name="fg" type="StyleBox">
The style of the progress (i.e. the part that fills the bar).
</theme_item>
<theme_item name="font" type="Font">
Font used to draw the fill percentage if [member percent_visible] is [code]true[/code].
</theme_item>
<theme_item name="font_color" type="Color" default="Color( 0.94, 0.94, 0.94, 1 )">
The color of the text.
</theme_item>
<theme_item name="font_color_shadow" type="Color" default="Color( 0, 0, 0, 1 )">
The color of the text's shadow.
</theme_item>
</theme_items>
</class>