TGUI  1.0-alpha
ProgressBar.hpp
1
2//
3// TGUI - Texus' Graphical User Interface
4// Copyright (C) 2012-2022 Bruno Van de Velde (vdv_b@tgui.eu)
5//
6// This software is provided 'as-is', without any express or implied warranty.
7// In no event will the authors be held liable for any damages arising from the use of this software.
8//
9// Permission is granted to anyone to use this software for any purpose,
10// including commercial applications, and to alter it and redistribute it freely,
11// subject to the following restrictions:
12//
13// 1. The origin of this software must not be misrepresented;
14// you must not claim that you wrote the original software.
15// If you use this software in a product, an acknowledgment
16// in the product documentation would be appreciated but is not required.
17//
18// 2. Altered source versions must be plainly marked as such,
19// and must not be misrepresented as being the original software.
20//
21// 3. This notice may not be removed or altered from any source distribution.
22//
24
25
26#ifndef TGUI_PROGRESS_BAR_HPP
27#define TGUI_PROGRESS_BAR_HPP
28
29
30#include <TGUI/Renderers/ProgressBarRenderer.hpp>
31#include <TGUI/Widgets/ClickableWidget.hpp>
32#include <TGUI/Text.hpp>
33
35
36namespace tgui
37{
41 class TGUI_API ProgressBar : public ClickableWidget
42 {
43 public:
44
45 typedef std::shared_ptr<ProgressBar> Ptr;
46 typedef std::shared_ptr<const ProgressBar> ConstPtr;
47
48
55 enum class FillDirection
56 {
57 LeftToRight,
58 RightToLeft,
59 TopToBottom,
60 BottomToTop
61 };
62
63
71 ProgressBar(const char* typeName = "ProgressBar", bool initRenderer = true);
72
73
81
82
92
93
99 const ProgressBarRenderer* getSharedRenderer() const;
100
107
108
115 void setSize(const Layout2d& size) override;
116 using Widget::setSize;
117
118
127 void setMinimum(unsigned int minimum);
128
129
136 unsigned int getMinimum() const;
137
138
147 void setMaximum(unsigned int maximum);
148
149
156 unsigned int getMaximum() const;
157
158
167 void setValue(unsigned int value);
168
169
176 unsigned int getValue() const;
177
178
187 unsigned int incrementValue();
188
189
198 void setText(const String& text);
199
200
207 const String& getText() const;
208
209
219
220
230
231
236 bool isMouseOnWidget(Vector2f pos) const override;
237
238
246 void draw(BackendRenderTarget& target, RenderStates states) const override;
247
248
250 protected:
251
261 Signal& getSignal(String signalName) override;
262
263
270 void rendererChanged(const String& property) override;
271
272
276 std::unique_ptr<DataIO::Node> save(SavingRenderersMap& renderers) const override;
277
278
282 void load(const std::unique_ptr<DataIO::Node>& node, const LoadingRenderersMap& renderers) override;
283
284
288 void updateTextSize() override;
289
290
292 // Returns the size without the borders
294 Vector2f getInnerSize() const;
295
296
298 // When the value changes, or when the minimum/maximum limits change then a smaller of bigger piece of the front image
299 // must be drawn. This function is called to calculate the size of the piece to draw.
301 void recalculateFillSize();
302
303
305 // Returns the size of the front image.
307 Vector2f getFrontImageSize() const;
308
309
311 // Makes a copy of the widget
313 Widget::Ptr clone() const override;
314
315
317 public:
318
319 SignalUInt onValueChange = {"ValueChanged"};
320 Signal onFull = {"Full"};
321
322
324 protected:
325
326 unsigned int m_minimum = 0;
327 unsigned int m_maximum = 100;
328 unsigned int m_value = 0;
329
330 Text m_textBack;
331 Text m_textFront;
332
333 FloatRect m_backRect;
334 FloatRect m_frontRect;
335
336 FillDirection m_fillDirection = FillDirection::LeftToRight;
337
338 Sprite m_spriteBackground;
339 Sprite m_spriteFill;
340
341 // Cached renderer properties
342 Borders m_bordersCached;
343 Color m_borderColorCached;
344 Color m_backgroundColorCached;
345 Color m_fillColorCached;
346 };
347
348
350}
351
353
354#endif // TGUI_PROGRESS_BAR_HPP
Base class for render targets.
Definition: BackendRenderTarget.hpp:48
Clickable widget.
Definition: ClickableWidget.hpp:40
Wrapper for colors.
Definition: Color.hpp:63
Class to store the position or size of a widget.
Definition: Layout.hpp:284
Definition: Outline.hpp:39
Definition: ProgressBarRenderer.hpp:37
Progress bar widget.
Definition: ProgressBar.hpp:42
Widget::Ptr clone() const override
Makes a copy of the widget if you don't know its exact type.
FillDirection getFillDirection() const
Returns the fill direction of the progress bar.
unsigned int getValue() const
Returns the current value.
void setFillDirection(FillDirection direction)
Changes the fill direction of the progress bar.
void setMaximum(unsigned int maximum)
Sets a maximum value.
void updateTextSize() override
Called when the text size is changed (either by setTextSize or via the renderer)
bool isMouseOnWidget(Vector2f pos) const override
Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget...
static ProgressBar::Ptr copy(ProgressBar::ConstPtr progressBar)
Makes a copy of another progress bar.
std::shared_ptr< const ProgressBar > ConstPtr
Shared constant widget pointer.
Definition: ProgressBar.hpp:46
ProgressBarRenderer * getRenderer()
Returns the renderer, which gives access to functions that determine how the widget is displayed.
std::shared_ptr< ProgressBar > Ptr
Shared widget pointer.
Definition: ProgressBar.hpp:45
void setValue(unsigned int value)
Changes the current value.
Signal & getSignal(String signalName) override
Retrieves a signal based on its name.
unsigned int incrementValue()
Increments the value.
void setMinimum(unsigned int minimum)
Sets a minimum value.
void setText(const String &text)
Changes the caption of the progress bar.
void setSize(const Layout2d &size) override
Changes the size of the progress bar.
static ProgressBar::Ptr create()
Creates a new progress bar widget.
FillDirection
The fill direction of the progress bar.
Definition: ProgressBar.hpp:56
void draw(BackendRenderTarget &target, RenderStates states) const override
Draw the widget to a render target.
unsigned int getMinimum() const
Returns the minimum value.
unsigned int getMaximum() const
Returns the maximum value.
void rendererChanged(const String &property) override
Function called when one of the properties of the renderer is changed.
ProgressBarRenderer * getSharedRenderer()
Returns the renderer, which gives access to functions that determine how the widget is displayed.
const String & getText() const
Returns the caption of the progress bar.
void load(const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
Loads the widget from a tree of nodes.
std::unique_ptr< DataIO::Node > save(SavingRenderersMap &renderers) const override
Saves the widget as a tree node in order to save it to a file.
Signal to which the user can subscribe to get callbacks from.
Definition: Signal.hpp:58
Definition: Sprite.hpp:45
Wrapper class to store strings.
Definition: String.hpp:79
Definition: Text.hpp:48
std::shared_ptr< Widget > Ptr
Shared widget pointer.
Definition: Widget.hpp:73
virtual void setSize(const Layout2d &size)
Changes the size of the widget.
Namespace that contains all TGUI functions and classes.
Definition: AbsoluteOrRelativeValue.hpp:36
States used for drawing.
Definition: RenderStates.hpp:39