1/**************************************************************************/
2/* progress_bar.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef PROGRESS_BAR_H
32#define PROGRESS_BAR_H
33
34#include "scene/gui/range.h"
35
36class ProgressBar : public Range {
37 GDCLASS(ProgressBar, Range);
38
39 bool show_percentage = true;
40
41 struct ThemeCache {
42 Ref<StyleBox> background_style;
43 Ref<StyleBox> fill_style;
44
45 Ref<Font> font;
46 int font_size = 0;
47 Color font_color;
48 int font_outline_size = 0;
49 Color font_outline_color;
50 } theme_cache;
51
52protected:
53 void _notification(int p_what);
54 static void _bind_methods();
55
56public:
57 enum FillMode {
58 FILL_BEGIN_TO_END,
59 FILL_END_TO_BEGIN,
60 FILL_TOP_TO_BOTTOM,
61 FILL_BOTTOM_TO_TOP,
62 FILL_MODE_MAX
63 };
64
65 void set_fill_mode(int p_fill);
66 int get_fill_mode();
67
68 void set_show_percentage(bool p_visible);
69 bool is_percentage_shown() const;
70
71 Size2 get_minimum_size() const override;
72 ProgressBar();
73
74private:
75 FillMode mode = FILL_BEGIN_TO_END;
76};
77
78VARIANT_ENUM_CAST(ProgressBar::FillMode);
79
80#endif // PROGRESS_BAR_H
81