summaryrefslogtreecommitdiff
path: root/doc/classes/ProgressBar.xml
blob: 60b66a2493203b9223fcaf010c21779108677769 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
<?xml version="1.0" encoding="UTF-8" ?>
<class name="ProgressBar" inherits="Range" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		General-purpose progress bar.
	</brief_description>
	<description>
		General-purpose progress bar. Shows fill percentage from right to left.
	</description>
	<tutorials>
	</tutorials>
	<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" overrides="Control" default="0" />
		<member name="step" type="float" setter="set_step" getter="get_step" overrides="Range" default="0.01" />
	</members>
	<theme_items>
		<theme_item name="font_color" data_type="color" type="Color" default="Color(0.95, 0.95, 0.95, 1)">
			The color of the text.
		</theme_item>
		<theme_item name="font_outline_color" data_type="color" type="Color" default="Color(1, 1, 1, 1)">
			The tint of text outline of the [ProgressBar].
		</theme_item>
		<theme_item name="font_shadow_color" data_type="color" type="Color" default="Color(0, 0, 0, 1)">
			The color of the text's shadow.
		</theme_item>
		<theme_item name="outline_size" data_type="constant" type="int" default="0">
			The size of the text outline.
		</theme_item>
		<theme_item name="font" data_type="font" type="Font">
			Font used to draw the fill percentage if [member percent_visible] is [code]true[/code].
		</theme_item>
		<theme_item name="font_size" data_type="font_size" type="int">
			Font size used to draw the fill percentage if [member percent_visible] is [code]true[/code].
		</theme_item>
		<theme_item name="bg" data_type="style" type="StyleBox">
			The style of the background.
		</theme_item>
		<theme_item name="fg" data_type="style" type="StyleBox">
			The style of the progress (i.e. the part that fills the bar).
		</theme_item>
	</theme_items>
</class>