TGUI
1.0-rc2
|
Progress bar widget. More...
#include <TGUI/Widgets/ProgressBar.hpp>
Public Types | |
enum class | FillDirection { LeftToRight , RightToLeft , TopToBottom , BottomToTop } |
The fill direction of the progress bar. More... | |
using | Ptr = std::shared_ptr< ProgressBar > |
Shared widget pointer. | |
using | ConstPtr = std::shared_ptr< const ProgressBar > |
Shared constant widget pointer. | |
![]() | |
using | Ptr = std::shared_ptr< ClickableWidget > |
Shared widget pointer. | |
using | ConstPtr = std::shared_ptr< const ClickableWidget > |
Shared constant widget pointer. | |
![]() | |
using | Ptr = std::shared_ptr< Widget > |
Shared widget pointer. | |
using | ConstPtr = std::shared_ptr< const Widget > |
Shared constant widget pointer. | |
Public Member Functions | |
ProgressBar (const char *typeName=StaticWidgetType, bool initRenderer=true) | |
TGUI_NODISCARD ProgressBarRenderer * | getSharedRenderer () override |
Returns the renderer, which gives access to functions that determine how the widget is displayed. | |
TGUI_NODISCARD const ProgressBarRenderer * | getSharedRenderer () const override |
TGUI_NODISCARD ProgressBarRenderer * | getRenderer () override |
Returns the renderer, which gives access to functions that determine how the widget is displayed. | |
void | setSize (const Layout2d &size) override |
Changes the size of the progress bar. | |
void | setMinimum (unsigned int minimum) |
Sets a minimum value. | |
TGUI_NODISCARD unsigned int | getMinimum () const |
Returns the minimum value. | |
void | setMaximum (unsigned int maximum) |
Sets a maximum value. | |
TGUI_NODISCARD unsigned int | getMaximum () const |
Returns the maximum value. | |
void | setValue (unsigned int value) |
Changes the current value. | |
TGUI_NODISCARD unsigned int | getValue () const |
Returns the current value. | |
unsigned int | incrementValue () |
Increments the value. | |
void | setText (const String &text) |
Changes the caption of the progress bar. | |
TGUI_NODISCARD const String & | getText () const |
Returns the caption of the progress bar. | |
void | setFillDirection (FillDirection direction) |
Changes the fill direction of the progress bar. | |
TGUI_NODISCARD FillDirection | getFillDirection () const |
Returns the fill direction of the progress bar. | |
TGUI_NODISCARD bool | isMouseOnWidget (Vector2f pos) const override |
Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. | |
void | draw (BackendRenderTarget &target, RenderStates states) const override |
Draw the widget to a render target. | |
virtual void | setSize (const Layout2d &size) |
Changes the size of the widget. | |
void | setSize (Layout width, Layout height) |
Changes the size of the widget. | |
![]() | |
ClickableWidget (const char *typeName=StaticWidgetType, bool initRenderer=true) | |
bool | leftMousePressed (Vector2f pos) override |
void | leftMouseReleased (Vector2f pos) override |
void | rightMousePressed (Vector2f pos) override |
void | rightMouseReleased (Vector2f pos) override |
void | rightMouseButtonNoLongerDown () override |
![]() | |
Widget (const char *typeName, bool initRenderer) | |
Widget (const Widget &) | |
Copy constructor. | |
Widget (Widget &&) noexcept | |
Move constructor. | |
virtual | ~Widget () |
Destructor. | |
Widget & | operator= (const Widget &) |
Overload of copy assignment operator. | |
Widget & | operator= (Widget &&) noexcept |
Move assignment. | |
void | setRenderer (std::shared_ptr< RendererData > rendererData) |
Sets a new renderer for the widget. The renderer determines how the widget looks. | |
virtual void | setPosition (const Layout2d &position) |
sets the position of the widget | |
void | setPosition (Layout x, Layout y) |
Sets the position of the widget. | |
TGUI_NODISCARD Vector2f | getPosition () const |
Gets the position of the widget. | |
void | setSize (Layout width, Layout height) |
Changes the size of the widget. | |
void | setWidth (Layout width) |
Changes the width of the widget. | |
void | setHeight (Layout height) |
Changes the height of the widget. | |
TGUI_NODISCARD Vector2f | getSize () const |
Returns the size of the widget. | |
virtual TGUI_NODISCARD Vector2f | getFullSize () const |
Returns the entire size that the widget is using. | |
virtual TGUI_NODISCARD Vector2f | getAbsolutePosition (Vector2f offset={}) const |
Get the absolute position of the widget instead of the relative position to its parent. | |
virtual TGUI_NODISCARD Vector2f | getWidgetOffset () const |
Returns the distance between the position where the widget is drawn and where the widget is placed. | |
void | setOrigin (float x, float y) |
Sets the origin point on which the position, scale and rotation is based. | |
void | setOrigin (Vector2f origin) |
Sets the origin point on which the position, scale and rotation is based. | |
TGUI_NODISCARD Vector2f | getOrigin () const |
Returns the relative origin point on which the position, scale and rotation is based. | |
void | setScale (Vector2f scaleFactors) |
Sets the scaling to be applied to the widget. | |
void | setScale (Vector2f scaleFactors, Vector2f origin) |
Sets the scaling to be applied to the widget. | |
void | setScale (float scaleFactor) |
Sets the scaling to be applied to the widget. | |
void | setScale (float scaleFactor, Vector2f origin) |
Sets the scaling to be applied to the widget. | |
TGUI_NODISCARD Vector2f | getScale () const |
Returns the scaling to be applied to the widget. | |
TGUI_NODISCARD Vector2f | getScaleOrigin () const |
Returns the origin used for scaling. | |
void | setRotation (float angle) |
Sets the rotation to be applied to the widget. | |
void | setRotation (float angle, Vector2f origin) |
Sets the rotation to be applied to the widget. | |
TGUI_NODISCARD float | getRotation () const |
Returns the rotation to be applied to the widget. | |
TGUI_NODISCARD Vector2f | getRotationOrigin () const |
Returns the origin used for rotations. | |
void | showWithEffect (ShowEffectType type, Duration duration) |
Shows the widget by introducing it with an animation. | |
void | hideWithEffect (ShowEffectType type, Duration duration) |
Hides the widget by making it leave with an animation. | |
void | moveWithAnimation (Layout2d position, Duration duration) |
Moves the widget from its current position to the given position, over a given duration. | |
void | resizeWithAnimation (Layout2d size, Duration duration) |
Resizes the widget from its current size to the given size, over a given duration. | |
virtual void | setVisible (bool visible) |
Shows or hides a widget. | |
TGUI_NODISCARD bool | isVisible () const |
Returns true when the widget is visible. | |
virtual void | setEnabled (bool enabled) |
Enables or disables the widget. | |
TGUI_NODISCARD bool | isEnabled () const |
Returns true when the widget is enabled. | |
virtual void | setFocused (bool focused) |
Focus or unfocus the widget. | |
TGUI_NODISCARD bool | isFocused () const |
Returns true when the widget is focused and false otherwise. | |
TGUI_NODISCARD const String & | getWidgetType () const |
Returns the type of the widget. | |
TGUI_NODISCARD Container * | getParent () const |
Returns a pointer to the parent widget. | |
TGUI_NODISCARD BackendGui * | getParentGui () const |
Returns a pointer to the gui to which this widget belongs. | |
TGUI_NODISCARD bool | isAnimationPlaying () const |
Returns whether there is an active animation (started with showWithEffect or hideWithEffect) | |
void | moveToFront () |
Places the widget before all other widgets. | |
void | moveToBack () |
Places the widget behind all other widgets. | |
void | setUserData (Any userData) |
Stores some data into the widget. | |
template<typename DataType > | |
TGUI_NODISCARD DataType | getUserData () const |
Returns data stored in the widget. | |
TGUI_NODISCARD bool | hasUserData () const |
Returns whether data stored in the widget. | |
void | setInheritedFont (const Font &font) |
Sets the font of the widget that is used when no font is set in the renderer. | |
TGUI_NODISCARD const Font & | getInheritedFont () const |
Returns the font of the widget that is used when no font is set in the renderer. | |
void | setInheritedOpacity (float opacity) |
Sets the opacity of the widget that will be multiplied with the opacity set in the renderer. | |
TGUI_NODISCARD float | getInheritedOpacity () const |
Returns the opacity of the widget that is multiplied with the opacity set in the renderer. | |
void | setTextSize (unsigned int size) |
Changes the character size of text in this widget if it uses text. | |
TGUI_NODISCARD unsigned int | getTextSize () const |
Returns the character size of text in this widget. | |
void | setToolTip (Widget::Ptr toolTip) |
Sets the tool tip that should be displayed when hovering over the widget. | |
TGUI_NODISCARD Widget::Ptr | getToolTip () const |
Returns the tool tip that is displayed when hovering over the widget. | |
void | setWidgetName (const String &name) |
Changes the name of a widget. | |
TGUI_NODISCARD String | getWidgetName () const |
Returns the name of a widget. | |
void | setMouseCursor (Cursor::Type cursor) |
Changes which mouse cursor is shown when hovering over the widget. | |
TGUI_NODISCARD Cursor::Type | getMouseCursor () const |
Returns which mouse cursor is shown when hovering over the widget. | |
void | setFocusable (bool focusable) |
Changes whether a widget could be focused. | |
TGUI_NODISCARD bool | isFocusable () const |
Returns whether a widget could be focused. | |
void | finishAllAnimations () |
Makes all animations of the widget finish immediately. | |
virtual TGUI_NODISCARD bool | canGainFocus () const |
Returns whether the widget can currently gain focus. | |
TGUI_NODISCARD bool | isContainer () const |
Returns whether the widget is a container widget or not. | |
TGUI_NODISCARD bool | isDraggableWidget () const |
Returns whether the widget has something to drag (e.g. slider or scrollbar thumbs) | |
TGUI_NODISCARD bool | isMouseDown () const |
Returns whether the left mouse button has been pressed on top of the widget. | |
virtual void | setParent (Container *parent) |
virtual bool | updateTime (Duration elapsedTime) |
virtual void | mouseReleased (Event::MouseButton button, Vector2f pos) |
virtual void | mouseMoved (Vector2f pos) |
virtual void | keyPressed (const Event::KeyEvent &event) |
virtual void | textEntered (char32_t key) |
virtual bool | scrolled (float delta, Vector2f pos, bool touch) |
virtual void | mouseNoLongerOnWidget () |
virtual void | leftMouseButtonNoLongerDown () |
virtual TGUI_NODISCARD Widget::Ptr | askToolTip (Vector2f mousePos) |
TGUI_NODISCARD const Layout2d & | getPositionLayout () const |
TGUI_NODISCARD const Layout2d & | getSizeLayout () const |
void | bindPositionLayout (Layout *layout) |
void | unbindPositionLayout (Layout *layout) |
void | bindSizeLayout (Layout *layout) |
void | unbindSizeLayout (Layout *layout) |
template<typename WidgetType > | |
TGUI_NODISCARD std::shared_ptr< const WidgetType > | cast () const |
Downcast const widget. | |
template<typename WidgetType > | |
TGUI_NODISCARD std::shared_ptr< WidgetType > | cast () |
Downcast widget. | |
void | rendererChangedCallback (const String &property) |
Static Public Member Functions | |
static TGUI_NODISCARD ProgressBar::Ptr | create () |
Creates a new progress bar widget. | |
static TGUI_NODISCARD ProgressBar::Ptr | copy (const ProgressBar::ConstPtr &progressBar) |
Makes a copy of another progress bar. | |
![]() | |
static TGUI_NODISCARD ClickableWidget::Ptr | create (const Layout2d &size={"100%", "100%"}) |
Creates a new clickable widget. | |
static TGUI_NODISCARD ClickableWidget::Ptr | copy (const ClickableWidget::ConstPtr &widget) |
Makes a copy of another clickable widget. | |
Public Attributes | |
SignalUInt | onValueChange = {"ValueChanged"} |
Value of the progress bar changed. Optional parameter: new value. | |
Signal | onFull = {"Full"} |
Value of the progress bar changed and he progress bar became full. | |
![]() | |
SignalVector2f | onMousePress = {"MousePressed"} |
The mouse went down on the widget. Optional parameter: mouse position relative to widget. | |
SignalVector2f | onMouseRelease = {"MouseReleased"} |
The mouse was released on top of the widget. Optional parameter: mouse position relative to widget. | |
SignalVector2f | onClick = {"Clicked"} |
The widget was clicked. Optional parameter: mouse position relative to widget. | |
SignalVector2f | onRightMousePress = {"RightMousePressed"} |
The right mouse button went down on the widget. Optional parameter: mouse position relative to widget. | |
SignalVector2f | onRightMouseRelease = {"RightMouseReleased"} |
The right mouse button was released on top of the widget. Optional parameter: mouse position relative to widget. | |
SignalVector2f | onRightClick = {"RightClicked"} |
The widget was right clicked. Optional parameter: mouse position relative to widget. | |
![]() | |
SignalVector2f | onPositionChange = {"PositionChanged"} |
The position of the widget changed. Optional parameter: new position. | |
SignalVector2f | onSizeChange = {"SizeChanged"} |
The size of the widget changed. Optional parameter: new size. | |
Signal | onFocus = {"Focused"} |
The widget was focused. | |
Signal | onUnfocus = {"Unfocused"} |
The widget was unfocused. | |
Signal | onMouseEnter = {"MouseEntered"} |
The mouse entered the widget. | |
Signal | onMouseLeave = {"MouseLeft"} |
The mouse left the widget. | |
SignalShowEffect | onShowEffectFinish = {"ShowEffectFinished"} |
A show or hide effect finished. Optional parameters: effect type, new widget visibility or both. | |
SignalAnimationType | onAnimationFinish = {"AnimationFinished"} |
An animation has finished. | |
Static Public Attributes | |
static constexpr const char | StaticWidgetType [] = "ProgressBar" |
Type name of the widget. | |
![]() | |
static constexpr const char | StaticWidgetType [] = "ClickableWidget" |
Type name of the widget. | |
Protected Member Functions | |
TGUI_NODISCARD Signal & | getSignal (String signalName) override |
Retrieves a signal based on its name. | |
void | rendererChanged (const String &property) override |
Function called when one of the properties of the renderer is changed. | |
TGUI_NODISCARD 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. | |
void | load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override |
Loads the widget from a tree of nodes. | |
void | updateTextSize () override |
Called when the text size is changed (either by setTextSize or via the renderer) | |
TGUI_NODISCARD Vector2f | getInnerSize () const |
void | recalculateFillSize () |
TGUI_NODISCARD Vector2f | getFrontImageSize () const |
TGUI_NODISCARD Widget::Ptr | clone () const override |
Makes a copy of the widget if you don't know its exact type. | |
![]() | |
virtual void | mouseEnteredWidget () |
This function is called when the mouse enters the widget. | |
virtual void | mouseLeftWidget () |
This function is called when the mouse leaves the widget. | |
Protected Attributes | |
unsigned int | m_minimum = 0 |
unsigned int | m_maximum = 100 |
unsigned int | m_value = 0 |
Text | m_textBack |
Text | m_textFront |
FloatRect | m_backRect |
FloatRect | m_frontRect |
FillDirection | m_fillDirection = FillDirection::LeftToRight |
Sprite | m_spriteBackground |
Sprite | m_spriteFill |
Borders | m_bordersCached |
Color | m_borderColorCached |
Color | m_backgroundColorCached |
Color | m_fillColorCached |
![]() | |
String | m_type |
String | m_name |
Layout2d | m_position |
Stores the position of this widget. | |
Layout2d | m_size |
Stores the size of this widget. | |
unsigned int | m_textSize = 0 |
Vector2f | m_origin |
Optional< Vector2f > | m_rotationOrigin |
Optional< Vector2f > | m_scaleOrigin |
Vector2f | m_scaleFactors = {1, 1} |
float | m_rotationDeg = 0 |
Vector2f | m_prevPosition |
Vector2f | m_prevSize |
std::unordered_set< Layout * > | m_boundPositionLayouts |
std::unordered_set< Layout * > | m_boundSizeLayouts |
bool | m_enabled = true |
Stores the flag indicating whether this widget is enabled. | |
bool | m_visible = true |
Stores the flag indicating whether this widget is visible. | |
Container * | m_parent = nullptr |
BackendGui * | m_parentGui = nullptr |
bool | m_mouseHover = false |
bool | m_mouseDown = false |
bool | m_focused = false |
bool | m_focusable = true |
Duration | m_animationTimeElapsed |
bool | m_containerWidget = false |
Widget::Ptr | m_toolTip = nullptr |
aurora::CopiedPtr< WidgetRenderer > | m_renderer = nullptr |
std::vector< std::unique_ptr< priv::Animation > > | m_showAnimations |
Font | m_inheritedFont |
float | m_inheritedOpacity = 1 |
Font | m_fontCached = Font::getGlobalFont() |
float | m_opacityCached = 1 |
bool | m_transparentTextureCached = false |
unsigned int | m_textSizeCached = 0 |
Any | m_userData |
Cursor::Type | m_mouseCursor = Cursor::Type::Arrow |
Additional Inherited Members | |
![]() | |
using | SavingRenderersMap = std::map< const Widget *, std::pair< std::unique_ptr< DataIO::Node >, String > > |
using | LoadingRenderersMap = std::map< String, std::shared_ptr< RendererData > > |
Progress bar widget.
|
strong |
The fill direction of the progress bar.
Determines in which direction the progress bar is filled when value goes from minimum to maximum.
|
overrideprotectedvirtual |
Makes a copy of the widget if you don't know its exact type.
This function should only be used when you don't know the type of the widget. If you know what kind of widget you are copying, you should use the copy function.
Reimplemented from tgui::ClickableWidget.
|
static |
Makes a copy of another progress bar.
progressBar | The other progress bar |
|
static |
Creates a new progress bar widget.
|
overridevirtual |
Draw the widget to a render target.
target | Render target to draw to |
states | Current render states |
Reimplemented from tgui::ClickableWidget.
TGUI_NODISCARD FillDirection tgui::ProgressBar::getFillDirection | ( | ) | const |
Returns the fill direction of the progress bar.
By default the progress bar is filled from left to right.
TGUI_NODISCARD unsigned int tgui::ProgressBar::getMaximum | ( | ) | const |
Returns the maximum value.
TGUI_NODISCARD unsigned int tgui::ProgressBar::getMinimum | ( | ) | const |
Returns the minimum value.
|
overridevirtual |
Returns the renderer, which gives access to functions that determine how the widget is displayed.
Reimplemented from tgui::Widget.
|
overridevirtual |
Reimplemented from tgui::Widget.
|
overridevirtual |
Returns the renderer, which gives access to functions that determine how the widget is displayed.
Reimplemented from tgui::Widget.
Retrieves a signal based on its name.
signalName | Name of the signal |
Exception | when the name does not match any signal |
Reimplemented from tgui::ClickableWidget.
TGUI_NODISCARD const String & tgui::ProgressBar::getText | ( | ) | const |
Returns the caption of the progress bar.
TGUI_NODISCARD unsigned int tgui::ProgressBar::getValue | ( | ) | const |
Returns the current value.
unsigned int tgui::ProgressBar::incrementValue | ( | ) |
Increments the value.
The value can never exceed the maximum.
|
overridevirtual |
Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.
Reimplemented from tgui::ClickableWidget.
|
overrideprotectedvirtual |
Loads the widget from a tree of nodes.
Reimplemented from tgui::Widget.
|
overrideprotectedvirtual |
Function called when one of the properties of the renderer is changed.
property | Name of the property that was changed |
Reimplemented from tgui::Widget.
|
overrideprotectedvirtual |
Saves the widget as a tree node in order to save it to a file.
Reimplemented from tgui::Widget.
void tgui::ProgressBar::setFillDirection | ( | FillDirection | direction | ) |
Changes the fill direction of the progress bar.
direction | In which direction is the progress bar filled when the value goes from minimum to maximum? |
By default the progress bar is filled from left to right.
void tgui::ProgressBar::setMaximum | ( | unsigned int | maximum | ) |
Sets a maximum value.
maximum | The new maximum value |
When the value is too big then it will be changed to this maximum.
void tgui::ProgressBar::setMinimum | ( | unsigned int | minimum | ) |
Sets a minimum value.
minimum | The new minimum value |
When the value is too small then it will be changed to this minimum.
|
virtual |
Changes the size of the widget.
size | Size of the widget |
Usage examples:
Reimplemented from tgui::Widget.
|
overridevirtual |
Changes the size of the progress bar.
size | The new size of the progress bar |
Reimplemented from tgui::Widget.
Changes the size of the widget.
width | Width of the widget |
height | Height of the widget |
void tgui::ProgressBar::setText | ( | const String & | text | ) |
Changes the caption of the progress bar.
text | New text to draw on top of the progress bar |
This text will be centered in the progress bar. It could e.g. contain the progress.
void tgui::ProgressBar::setValue | ( | unsigned int | value | ) |
Changes the current value.
value | The new value |
The value can't be smaller than the minimum or bigger than the maximum.
|
overrideprotectedvirtual |
Called when the text size is changed (either by setTextSize or via the renderer)
Reimplemented from tgui::Widget.