TGUI  0.8.9

Progress bar widget. More...

#include <TGUI/Widgets/ProgressBar.hpp>

Inheritance diagram for tgui::ProgressBar:
tgui::ClickableWidget tgui::Widget tgui::SignalWidgetBase

Public Types

enum class  FillDirection { LeftToRight , RightToLeft , TopToBottom , BottomToTop }
 The fill direction of the progress bar. More...
 
typedef std::shared_ptr< ProgressBarPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const ProgressBarConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::ClickableWidget
typedef std::shared_ptr< ClickableWidgetPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const ClickableWidgetConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::Widget
typedef std::shared_ptr< WidgetPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const WidgetConstPtr
 Shared constant widget pointer.
 

Public Member Functions

ProgressBarRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
ProgressBarRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
void setSize (const Layout2d &size) override
 Changes the size of the progress bar. More...
 
void setMinimum (unsigned int minimum)
 Sets a minimum value. More...
 
unsigned int getMinimum () const
 Returns the minimum value. More...
 
void setMaximum (unsigned int maximum)
 Sets a maximum value. More...
 
unsigned int getMaximum () const
 Returns the maximum value. More...
 
void setValue (unsigned int value)
 Changes the current value. More...
 
unsigned int getValue () const
 Returns the current value. More...
 
unsigned int incrementValue ()
 Increments the value. More...
 
void setText (const sf::String &text)
 Changes the caption of the progress bar. More...
 
const sf::String & getText () const
 Returns the caption of the progress bar. More...
 
void setTextSize (unsigned int size) override
 Changes the character size of the text. More...
 
unsigned int getTextSize () const override
 Returns the character size of the text. More...
 
void setFillDirection (FillDirection direction)
 Changes the fill direction of the progress bar. More...
 
FillDirection getFillDirection () const
 Returns the fill direction of the progress bar. More...
 
bool mouseOnWidget (Vector2f pos) const override
 Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. More...
 
void draw (sf::RenderTarget &target, sf::RenderStates states) const override
 Draw the widget to a render target. More...
 
virtual void setSize (const Layout2d &size)
 Changes the size of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
- Public Member Functions inherited from tgui::ClickableWidget
 ClickableWidget ()
 Default constructor.
 
- Public Member Functions inherited from tgui::Widget
 Widget ()
 Default constructor.
 
 Widget (const Widget &)
 Copy constructor.
 
 Widget (Widget &&)
 Move constructor.
 
 ~Widget ()
 Destructor.
 
Widgetoperator= (const Widget &)
 Overload of copy assignment operator.
 
Widgetoperator= (Widget &&)
 Move assignment.
 
void setRenderer (std::shared_ptr< RendererData > rendererData)
 Sets a new renderer for the widget. The renderer determines how the widget looks. More...
 
WidgetRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
WidgetRenderergetRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
virtual void setPosition (const Layout2d &position)
 sets the position of the widget More...
 
void setPosition (Layout x, Layout y)
 Sets the position of the widget. More...
 
Vector2f getPosition () const
 Gets the position of the widget. More...
 
void setSize (Layout width, Layout height)
 Changes the size of the widget. More...
 
Vector2f getSize () const
 Returns the size of the widget. More...
 
virtual Vector2f getFullSize () const
 Returns the entire size that the widget is using. More...
 
virtual Vector2f getAbsolutePosition () const
 Get the absolute position of the widget instead of the relative position to its parent. More...
 
virtual Vector2f getWidgetOffset () const
 Returns the distance between the position where the widget is drawn and where the widget is placed. More...
 
virtual void showWithEffect (ShowAnimationType type, sf::Time duration)
 Shows the widget by introducing it with an animation. More...
 
virtual void hideWithEffect (ShowAnimationType type, sf::Time duration)
 Hides the widget by making it leave with an animation. More...
 
virtual void setVisible (bool visible)
 Shows or hides a widget. More...
 
bool isVisible () const
 Returns true when the widget is visible. More...
 
virtual void setEnabled (bool enabled)
 Enables or disables the widget. More...
 
bool isEnabled () const
 Returns true when the widget is enabled. More...
 
virtual void setFocused (bool focused)
 Focus or unfocus the widget. More...
 
bool isFocused () const
 Returns true when the widget is focused and false otherwise. More...
 
const std::string & getWidgetType () const
 Returns the type of the widget. More...
 
ContainergetParent () const
 Returns a pointer to the parent widget. More...
 
bool isAnimationPlaying () const
 Returns whether there is an active animation (started with showWithEffect or hideWithEffect) More...
 
virtual void moveToFront ()
 Places the widget before all other widgets. More...
 
virtual void moveToBack ()
 Places the widget behind all other widgets. More...
 
void setUserData (std::any userData)
 Stores some data into the widget. More...
 
template<typename T >
getUserData () const
 Returns data stored in the widget. More...
 
void setInheritedFont (const Font &font)
 Sets the font of the widget that is used when no font is set in the renderer. More...
 
const FontgetInheritedFont () const
 Returns the font of the widget that is used when no font is set in the renderer. More...
 
void setInheritedOpacity (float opacity)
 Sets the opacity of the widget that will be multiplied with the opacity set in the renderer. More...
 
float getInheritedOpacity () const
 Returns the opacity of the widget that is multiplied with the opacity set in the renderer. More...
 
void setToolTip (Widget::Ptr toolTip)
 Sets the tool tip that should be displayed when hovering over the widget. More...
 
Widget::Ptr getToolTip () const
 Returns the tool tip that is displayed when hovering over the widget. More...
 
void setWidgetName (const sf::String &name)
 Changes the name of a widget. More...
 
sf::String getWidgetName () const
 Returns the name of a widget. More...
 
void setFocusable (bool focusable)
 Changes whether a widget could be focused. More...
 
bool isFocusable () const
 Returns whether a widget could be focused. More...
 
virtual bool canGainFocus () const
 Returns whether the widget can currently gain focus. More...
 
bool isContainer () const
 Returns whether the widget is a container widget or not. More...
 
template<typename WidgetType >
std::shared_ptr< const WidgetType > cast () const
 Downcast const widget.
 
template<typename WidgetType >
std::shared_ptr< WidgetType > cast ()
 Downcast widget.
 
- Public Member Functions inherited from tgui::SignalWidgetBase
template<typename Func , typename... Args, typename std::enable_if< std::is_convertible< Func, std::function< void(const Args &...)> >::value >::type * = nullptr>
unsigned int connect (std::string signalName, Func &&handler, const Args &... args)
 Connects a signal handler that will be called when this signal is emitted. More...
 
template<typename Func , typename... BoundArgs, typename std::enable_if<!std::is_convertible< Func, std::function< void(const BoundArgs &...)> >::value &&std::is_convertible< Func, std::function< void(const BoundArgs &..., std::shared_ptr< Widget >, const std::string &)> >::value , ::type * = nullptr>
unsigned int connect (std::string signalName, Func &&handler, BoundArgs &&... args)
 Connects a signal handler that will be called when this signal is emitted. More...
 
template<typename Func , typename... BoundArgs, typename std::enable_if<!std::is_convertible< Func, std::function< void(const BoundArgs &...)> >::value &&!std::is_convertible< Func, std::function< void(const BoundArgs &..., std::shared_ptr< Widget >, const std::string &)> >::value , ::type * = nullptr>
unsigned int connect (std::string signalName, Func &&handler, BoundArgs &&... args)
 Connects a signal handler that will be called when this signal is emitted. More...
 
template<typename Func , typename... BoundArgs>
unsigned int connect (std::initializer_list< std::string > signalNames, Func &&handler, BoundArgs &&... args)
 Connect a signal handler to multiple signals. More...
 
bool disconnect (unsigned int id)
 Disconnects a signal handler. More...
 
void disconnectAll (std::string signalName)
 Disconnects all signal handler from a certain signal. More...
 
void disconnectAll ()
 Disconnects all signal handlers from signals.
 

Static Public Member Functions

static ProgressBar::Ptr create ()
 Creates a new progress bar widget. More...
 
static ProgressBar::Ptr copy (ProgressBar::ConstPtr progressBar)
 Makes a copy of another progress bar. More...
 
- Static Public Member Functions inherited from tgui::ClickableWidget
static ClickableWidget::Ptr create (Layout2d size={"100%", "100%"})
 Creates a new clickable widget. More...
 
static ClickableWidget::Ptr copy (ClickableWidget::ConstPtr widget)
 Makes a copy of another clickable widget. More...
 

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.
 
- Public Attributes inherited from tgui::ClickableWidget
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.
 
- Public Attributes inherited from tgui::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.
 
SignalAnimation onAnimationFinished = {"AnimationFinished"}
 A show or hide animation finished. Optional parameters: animation type, new widget visibility or both.
 

Protected Member Functions

SignalgetSignal (std::string signalName) override
 Retrieves a signal based on its name. More...
 
void rendererChanged (const std::string &property) override
 Function called when one of the properties of the renderer is changed. More...
 
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.
 
Widget::Ptr clone () const override
 Makes a copy of the widget if you don't know its exact type. More...
 
- Protected Member Functions inherited from tgui::Widget
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.
 

Detailed Description

Progress bar widget.

Member Enumeration Documentation

◆ FillDirection

The fill direction of the progress bar.

Determines in which direction the progress bar is filled when value goes from minimum to maximum.

Enumerator
LeftToRight 

Start filling at the left side and go to the right.

RightToLeft 

Start filling at the right side and go to the left.

TopToBottom 

Start filling at the top an go downward.

BottomToTop 

Start filling at the bottom and go upward.

Member Function Documentation

◆ clone()

Widget::Ptr tgui::ProgressBar::clone ( ) const
inlineoverrideprotectedvirtual

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.

Returns
Copy of the widget

Reimplemented from tgui::ClickableWidget.

◆ copy()

static ProgressBar::Ptr tgui::ProgressBar::copy ( ProgressBar::ConstPtr  progressBar)
static

Makes a copy of another progress bar.

Parameters
progressBarThe other progress bar
Returns
The new progress bar

◆ create()

static ProgressBar::Ptr tgui::ProgressBar::create ( )
static

Creates a new progress bar widget.

Returns
The new progress bar

◆ draw()

void tgui::ProgressBar::draw ( sf::RenderTarget &  target,
sf::RenderStates  states 
) const
overridevirtual

Draw the widget to a render target.

Parameters
targetRender target to draw to
statesCurrent render states

Reimplemented from tgui::ClickableWidget.

◆ getFillDirection()

FillDirection tgui::ProgressBar::getFillDirection ( ) const

Returns the fill direction of the progress bar.

Returns
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.

◆ getMaximum()

unsigned int tgui::ProgressBar::getMaximum ( ) const

Returns the maximum value.

Returns
The current maximum value

◆ getMinimum()

unsigned int tgui::ProgressBar::getMinimum ( ) const

Returns the minimum value.

Returns
The current minimum value

◆ getRenderer()

ProgressBarRenderer * tgui::ProgressBar::getRenderer ( )

Returns the renderer, which gives access to functions that determine how the widget is displayed.

Returns
Temporary pointer to the renderer
Warning
After calling this function, the widget has its own copy of the renderer and it will no longer be shared.

◆ getSharedRenderer()

ProgressBarRenderer * tgui::ProgressBar::getSharedRenderer ( )

Returns the renderer, which gives access to functions that determine how the widget is displayed.

Returns
Temporary pointer to the renderer that may be shared with other widgets using the same renderer

◆ getSignal()

Signal & tgui::ProgressBar::getSignal ( std::string  signalName)
overrideprotectedvirtual

Retrieves a signal based on its name.

Parameters
signalNameName of the signal
Returns
Signal that corresponds to the name
Exceptions
Exceptionwhen the name does not match any signal

Reimplemented from tgui::ClickableWidget.

◆ getText()

const sf::String & tgui::ProgressBar::getText ( ) const

Returns the caption of the progress bar.

Returns
Text that is drawn on top of the progress bar

◆ getTextSize()

unsigned int tgui::ProgressBar::getTextSize ( ) const
overridevirtual

Returns the character size of the text.

Returns
The current text size

Reimplemented from tgui::Widget.

◆ getValue()

unsigned int tgui::ProgressBar::getValue ( ) const

Returns the current value.

Returns
The current value

◆ incrementValue()

unsigned int tgui::ProgressBar::incrementValue ( )

Increments the value.

Returns
the new value

The value can never exceed the maximum.

◆ mouseOnWidget()

bool tgui::ProgressBar::mouseOnWidget ( Vector2f  pos) const
overridevirtual

Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.

Returns
Is the mouse on top of the widget?

Reimplemented from tgui::ClickableWidget.

◆ rendererChanged()

void tgui::ProgressBar::rendererChanged ( const std::string &  property)
overrideprotectedvirtual

Function called when one of the properties of the renderer is changed.

Parameters
propertyLowercase name of the property that was changed

Reimplemented from tgui::Widget.

◆ setFillDirection()

void tgui::ProgressBar::setFillDirection ( FillDirection  direction)

Changes the fill direction of the progress bar.

Parameters
directionIn 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.

◆ setMaximum()

void tgui::ProgressBar::setMaximum ( unsigned int  maximum)

Sets a maximum value.

Parameters
maximumThe new maximum value

When the value is too big then it will be changed to this maximum.

◆ setMinimum()

void tgui::ProgressBar::setMinimum ( unsigned int  minimum)

Sets a minimum value.

Parameters
minimumThe new minimum value

When the value is too small then it will be changed to this minimum.

◆ setSize() [1/3]

virtual void tgui::Widget::setSize ( const Layout2d size)
virtual

Changes the size of the widget.

Parameters
sizeSize of the widget

Usage examples:

// Give the widget an exact size
widget->setSize({40, 30});
// Give the widget a size relative to the size of its parent
widget->setSize({"20%", "5%"});
// Make the widget 50 pixels higher than some other widget and automatically resize it when the other widget resizes
widget->setSize({200, tgui::bindHeight(otherWidget) + 50});
TGUI_API Layout bindHeight(std::shared_ptr< Widget > widget)
Bind to the height of the widget.

Reimplemented from tgui::Widget.

◆ setSize() [2/3]

void tgui::ProgressBar::setSize ( const Layout2d size)
overridevirtual

Changes the size of the progress bar.

Parameters
sizeThe new size of the progress bar

Reimplemented from tgui::Widget.

◆ setSize() [3/3]

void tgui::Widget::setSize ( Layout  width,
Layout  height 
)
inline

Changes the size of the widget.

Parameters
widthWidth of the widget
heightHeight of the widget
Warning
This setSize overload must never be used from internal TGUI code or by custom widget implementations

◆ setText()

void tgui::ProgressBar::setText ( const sf::String &  text)

Changes the caption of the progress bar.

Parameters
textNew 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.

◆ setTextSize()

void tgui::ProgressBar::setTextSize ( unsigned int  size)
overridevirtual

Changes the character size of the text.

Parameters
sizeThe new text size. If the size is set to 0 then the text will be auto-sized to fit inside the progress bar

Reimplemented from tgui::Widget.

◆ setValue()

void tgui::ProgressBar::setValue ( unsigned int  value)

Changes the current value.

Parameters
valueThe new value

The value can't be smaller than the minimum or bigger than the maximum.


The documentation for this class was generated from the following file: