2017-09-13 04:42:36 +08:00
<?xml version="1.0" encoding="UTF-8" ?>
2023-07-06 16:08:05 +08:00
<class name= "ProgressBar" inherits= "Range" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../class.xsd" >
2017-09-13 04:42:36 +08:00
<brief_description >
2023-04-30 22:26:09 +08:00
A control used for visual representation of a percentage.
2017-09-13 04:42:36 +08:00
</brief_description>
<description >
2023-04-30 22:26:09 +08:00
A control used for visual representation of a percentage. Shows fill percentage from right to left.
2017-09-13 04:42:36 +08:00
</description>
<tutorials >
</tutorials>
<members >
2024-01-18 08:49:57 +08:00
<member name= "editor_preview_indeterminate" type= "bool" setter= "set_editor_preview_indeterminate" getter= "is_editor_preview_indeterminate_enabled" >
If [code]false[/code], the [member indeterminate] animation will be paused in the editor.
</member>
2021-02-19 14:02:59 +08:00
<member name= "fill_mode" type= "int" setter= "set_fill_mode" getter= "get_fill_mode" default= "0" >
The fill direction. See [enum FillMode] for possible values.
</member>
2024-01-18 08:49:57 +08:00
<member name= "indeterminate" type= "bool" setter= "set_indeterminate" getter= "is_indeterminate" default= "false" >
When set to [code]true[/code], the progress bar indicates that something is happening with an animation, but does not show the fill percentage or value.
</member>
2022-08-29 21:20:48 +08:00
<member name= "show_percentage" type= "bool" setter= "set_show_percentage" getter= "is_percentage_shown" default= "true" >
2019-06-29 21:24:23 +08:00
If [code]true[/code], the fill percentage is displayed on the bar.
2017-09-13 04:42:36 +08:00
</member>
</members>
2021-02-19 14:02:59 +08:00
<constants >
<constant name= "FILL_BEGIN_TO_END" value= "0" enum= "FillMode" >
The progress bar fills from begin to end horizontally, according to the language direction. If [method Control.is_layout_rtl] returns [code]false[/code], it fills from left to right, and if it returns [code]true[/code], it fills from right to left.
</constant>
<constant name= "FILL_END_TO_BEGIN" value= "1" enum= "FillMode" >
The progress bar fills from end to begin horizontally, according to the language direction. If [method Control.is_layout_rtl] returns [code]false[/code], it fills from right to left, and if it returns [code]true[/code], it fills from left to right.
</constant>
<constant name= "FILL_TOP_TO_BOTTOM" value= "2" enum= "FillMode" >
The progress fills from top to bottom.
</constant>
<constant name= "FILL_BOTTOM_TO_TOP" value= "3" enum= "FillMode" >
The progress fills from bottom to top.
</constant>
</constants>
2017-09-13 04:42:36 +08:00
<theme_items >
2021-12-31 00:22:06 +08:00
<theme_item name= "font_color" data_type= "color" type= "Color" default= "Color(0.95, 0.95, 0.95, 1)" >
2020-03-04 02:21:21 +08:00
The color of the text.
2017-09-13 04:42:36 +08:00
</theme_item>
2021-11-06 03:50:01 +08:00
<theme_item name= "font_outline_color" data_type= "color" type= "Color" default= "Color(0, 0, 0, 1)" >
2020-12-26 05:45:28 +08:00
The tint of text outline of the [ProgressBar].
</theme_item>
2021-12-02 02:02:20 +08:00
<theme_item name= "outline_size" data_type= "constant" type= "int" default= "0" >
The size of the text outline.
2022-12-20 00:15:44 +08:00
[b]Note:[/b] If using a font with [member FontFile.multichannel_signed_distance_field] enabled, its [member FontFile.msdf_pixel_range] must be set to at least [i]twice[/i] the value of [theme_item outline_size] for outline rendering to look correct. Otherwise, the outline may appear to be cut off earlier than intended.
2021-12-02 02:02:20 +08:00
</theme_item>
<theme_item name= "font" data_type= "font" type= "Font" >
2022-08-29 21:20:48 +08:00
Font used to draw the fill percentage if [member show_percentage] is [code]true[/code].
2021-12-02 02:02:20 +08:00
</theme_item>
2021-08-05 00:54:41 +08:00
<theme_item name= "font_size" data_type= "font_size" type= "int" >
2022-08-29 21:20:48 +08:00
Font size used to draw the fill percentage if [member show_percentage] is [code]true[/code].
2020-08-12 19:49:10 +08:00
</theme_item>
2022-09-07 01:09:32 +08:00
<theme_item name= "background" data_type= "style" type= "StyleBox" >
2021-12-02 02:02:20 +08:00
The style of the background.
</theme_item>
2022-09-07 01:09:32 +08:00
<theme_item name= "fill" data_type= "style" type= "StyleBox" >
2021-12-02 02:02:20 +08:00
The style of the progress (i.e. the part that fills the bar).
2020-12-26 05:45:28 +08:00
</theme_item>
2017-09-13 04:42:36 +08:00
</theme_items>
</class>