Progress bar widget. More...

#include <TGUI/Widgets/ProgressBar.hpp>

Inheritance diagram for tgui::ProgressBar:

Public Types
enum class	FillDirection { LeftToRight , RightToLeft , TopToBottom , BottomToTop }
	The fill direction of the progress bar. More...

typedef std::shared_ptr< ProgressBar >	Ptr
	Shared widget pointer.

typedef std::shared_ptr< const ProgressBar >	ConstPtr
	Shared constant widget pointer.

Public Types inherited from tgui::ClickableWidget
typedef std::shared_ptr< ClickableWidget >	Ptr
	Shared widget pointer.

typedef std::shared_ptr< const ClickableWidget >	ConstPtr
	Shared constant widget pointer.

Public Types inherited from tgui::Widget
typedef std::shared_ptr< Widget >	Ptr
	Shared widget pointer.

typedef std::shared_ptr< const Widget >	ConstPtr
	Shared constant widget pointer.

Public Member Functions
	ProgressBar ()
	Default constructor.

std::shared_ptr< ProgressBarRenderer >	getRenderer () const
	Returns the renderer, which gives access to functions that determine how the widget is displayed. More...

virtual void	setPosition (const Layout2d &position) override
	Set the position of the widget. More...

void	setSize (const Layout2d &size) override
	Changes the size of the progress bar. More...

virtual sf::Vector2f	getFullSize () const override
	Returns the full size of the progress bar. More...

virtual void	setFont (const Font &font) override
	Changes the font of the text in the widget. More...

void	setMinimum (unsigned int minimum)
	Sets a minimum value. More...

void	setMaximum (unsigned int maximum)
	Sets a maximum value. More...

void	setValue (unsigned int value)
	Changes the current value. More...

unsigned int	getMinimum () const
	Returns the minimum value. More...

unsigned int	getMaximum () const
	Returns the maximum value. More...

unsigned int	getValue () const
	Returns the current value. More...

unsigned int	incrementValue ()
	Increment the value. More...

void	setText (const sf::String &text)
	Changes the caption of the progress bar. More...

sf::String	getText () const
	Returns the caption of the progress bar. More...

void	setTextSize (unsigned int size)
	Changes the character size of the text. More...

unsigned int	getTextSize () const
	Returns the character size of the text. More...

void	setFillDirection (FillDirection direction)
	Changes the fill direction of the progress bar. More...

FillDirection	getFillDirection ()
	Returns the fill direction of the progress bar. More...

virtual void	setOpacity (float opacity) override
	Changes the opacity of the widget. More...

virtual sf::Vector2f	getWidgetOffset () const override
	Returns the distance between the position where the widget is drawn and where the widget is placed. More...

virtual void	setPosition (const Layout2d &position)
	set the position of the widget More...

void	setPosition (const Layout &x, const Layout &y)
	set the position of the widget More...

virtual void	setSize (const Layout2d &size)
	Changes the size of the widget. More...

void	setSize (const Layout &width, const Layout &height)
	Changes the size of the widget. More...

Public Member Functions inherited from tgui::ClickableWidget
	ClickableWidget (const Layout2d &size={100, 100})
	Default constructor. More...

	ClickableWidget (const Layout &width, const Layout &height)
	Constructor. More...

Public Member Functions inherited from tgui::Widget
	Widget ()
	Default constructor.

	Widget (const Widget &copy)
	Copy constructor. More...

	~Widget ()
	Destructor.

Widget &	operator= (const Widget &right)
	Overload of assignment operator. More...

std::shared_ptr< WidgetRenderer >	getRenderer () const
	Returns the renderer, which gives access to functions that determine how the widget is displayed. More...

virtual sf::Vector2f	getAbsolutePosition () const
	Get the absolute position of the widget instead of the relative position to its parent. More...

virtual void	show ()
	Shows the widget. More...

virtual void	showWithEffect (ShowAnimationType type, sf::Time duration)
	Shows the widget by introducing it with an animation. More...

virtual void	hide ()
	Hides the widget. More...

virtual void	hideWithEffect (ShowAnimationType type, sf::Time duration)
	Hides the widget by making it leave with an animation. More...

bool	isVisible () const
	Returns true when the widget is visible. More...

virtual void	enable ()
	Enables the widget. More...

virtual void	disable (bool blockMouseEvents=true)
	Disables the widget. More...

bool	isEnabled () const
	Returns true when the widget is enabled. More...

virtual void	focus ()
	Focus the widget. More...

virtual void	unfocus ()
	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...

Container *	getParent () const
	Returns a pointer to the parent widget. More...

float	getOpacity () const
	Returns the opacity of the widget. More...

virtual void	moveToFront ()
	Places the widget before all other widgets.

virtual void	moveToBack ()
	Places the widget behind all other widgets.

void	setToolTip (Widget::Ptr toolTip)
	Sets the tool tip that should be displayed when hovering over the widget. More...

Widget::Ptr	getToolTip ()
	Returns the tool tip that is displayed when hovering over the widget. More...

std::shared_ptr< sf::Font >	getFont () const
	Returns the font associated with the widget (if any) More...

void	detachTheme ()
	Detach the theme from the widget. More...

std::shared_ptr< BaseTheme >	getTheme () const
	Returns the theme to which the widget is currently connected. More...

std::string	getPrimaryLoadingParameter () const
	Returns the primary parameter that was passed to the loader to load this widget. More...

std::string	getSecondaryLoadingParameter () const
	Returns the secondary parameter that was passed to the loader to load this widget. More...

void	setPosition (const Layout &x, const Layout &y)
	set the position of the widget More...

void	setSize (const Layout &width, const Layout &height)
	Changes the size of the widget. More...

Public Member Functions inherited from tgui::Transformable
virtual	~Transformable ()
	Virtual destructor.

void	setPosition (const Layout &x, const Layout &y)
	set the position of the widget More...

sf::Vector2f	getPosition () const
	get the position of the widget More...

void	move (const Layout2d &offset)
	Move the widget by a given offset. More...

void	move (const Layout &x, const Layout &y)
	Move the widget by a given offset. More...

void	setSize (const Layout &width, const Layout &height)
	Changes the size of the widget. More...

virtual sf::Vector2f	getSize () const
	Returns the size of the widget. More...

void	scale (const Layout2d &factors)
	Scale the widget. More...

void	scale (const Layout &x, const Layout &y)
	Scale the widget. More...

Public Member Functions inherited from tgui::SignalWidgetBase
	SignalWidgetBase ()=default
	Default constructor.

	SignalWidgetBase (const SignalWidgetBase &copy)
	Copy constructor. More...

SignalWidgetBase &	operator= (const SignalWidgetBase &right)
	Overload of assignment operator. More...

template<typename Func , typename... Args>
unsigned int	connect (const std::string &signalNames, Func func, Args... args)
	Connects a signal handler function to one or more signals. More...

template<typename Func , typename... Args>
unsigned int	connectEx (const std::string &signalName, Func func, Args... args)
	Connects a signal handler function to one or more signals. More...

void	disconnect (unsigned int id)
	Disconnects a connection. More...

void	disconnectAll (const std::string &signalName)
	Disconnect all connections from a certain signal. More...

void	disconnectAll ()
	Disconnect all connections from a all 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...

Protected Member Functions
virtual void	reload (const std::string &primary="", const std::string &secondary="", bool force=false) override
	Reload the widget. More...

virtual 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
void	attachTheme (std::shared_ptr< BaseTheme > theme)
	Attach a theme to the widget. More...

Detailed Description

Progress bar widget.

Signals:

ValueChanged (The value of the progress bar has changed)
- Optional parameter int: New value
- Uses Callback member 'value'
Full (The new value equals the maximum value)
- Optional parameter int: The maximum value
- Uses Callback member 'value'
Inherited signals from ClickableWidget

Member Enumeration Documentation

◆ FillDirection

enum class tgui::ProgressBar::FillDirection

strong

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()

virtual 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

progressBar The 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

◆ getFillDirection()

FillDirection tgui::ProgressBar::getFillDirection ( )

inline

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.

◆ getFullSize()

virtual sf::Vector2f tgui::ProgressBar::getFullSize ( ) const

overridevirtual

Returns the full size of the progress bar.

The size returned by this function includes the borders.

Returns: Full size of the progress bar

Reimplemented from tgui::Transformable.

◆ getMaximum()

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

inline

Returns the maximum value.

Returns: The current maximum value

◆ getMinimum()

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

inline

Returns the minimum value.

Returns: The current minimum value

◆ getRenderer()

std::shared_ptr< ProgressBarRenderer > tgui::ProgressBar::getRenderer ( ) const

inline

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

Returns: Reference to the renderer

◆ getText()

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

inline

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

inline

Returns the character size of the text.

Returns: The current text size.

◆ getValue()

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

inline

Returns the current value.

Returns: The current value

◆ getWidgetOffset()

virtual sf::Vector2f tgui::ProgressBar::getWidgetOffset ( ) const

overridevirtual

Returns the distance between the position where the widget is drawn and where the widget is placed.

This is basically the width and height of the optional borders drawn around widgets.

Returns: Offset of the widget

Reimplemented from tgui::Widget.

◆ incrementValue()

unsigned int tgui::ProgressBar::incrementValue ( )

Increment the value.

Returns: the new value

The value can never exceed the maximum.

◆ reload()

virtual void tgui::ProgressBar::reload	(	const std::string &	primary = `""`,
		const std::string &	secondary = `""`,
		bool	force = `false`
	)

overrideprotectedvirtual

Reload the widget.

Parameters

primary	Primary parameter for the loader
secondary	Secondary parameter for the loader
force	Try to only change the looks of the widget and not alter the widget itself when false

Exceptions

Exception when the connected theme could not create the widget

When primary is an empty string the built-in white theme will be used.

Reimplemented from tgui::Widget.

◆ setFillDirection()

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

Changes the fill direction of the progress bar.

Parameters

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.

◆ setFont()

virtual void tgui::ProgressBar::setFont ( const Font & font )

overridevirtual

Changes the font of the text in the widget.

Parameters

font	The new font.

When you don't call this function then the font from the parent widget will be used.

Reimplemented from tgui::Widget.

◆ setMaximum()

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

Sets a maximum value.

Parameters

maximum The 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

minimum The new minimum value

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

◆ setOpacity()

virtual void tgui::ProgressBar::setOpacity ( float opacity )

overridevirtual

Changes the opacity of the widget.

Parameters

opacity The opacity of the widget. 0 means completely transparent, while 1 (default) means fully opaque.

Reimplemented from tgui::Widget.

◆ setPosition() [1/3]

void tgui::Transformable::setPosition	(	const Layout &	x,
		const Layout &	y
	)

inline

set the position of the widget

This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable widget is (0, 0).

Parameters

x	New x coordinate
y	New y coordinate

See also: move, getPosition

Usage examples:

// Place the widget on an exact position
widget->setPosition(40, 30);
 
// Place the widget 50 pixels below another widget
widget->setPosition(otherWidget->getPosition().x, otherWidget->getPosition().y + otherWidget->getSize().y + 50);
 
// Place the widget 50 pixels below another widget and automatically move it when the other widget moves
widget->setPosition(tgui::bindLeft(otherWidget), tgui::bindBottom(otherWidget) + 50);

◆ setPosition() [2/3]

virtual void tgui::Transformable::setPosition ( const Layout2d & position )

virtual

set the position of the widget

This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable widget is (0, 0).

Parameters

position New position

See also: move, getPosition

Usage examples:

// Place the widget on an exact position
widget->setPosition({40, 30});
 
// Place the widget 50 pixels below another widget
widget->setPosition(otherWidget->getPosition() + sf::Vector2f{0, otherWidget->getSize().y + 50});
 
// Place the widget 50 pixels below another widget and automatically move it when the other widget moves
widget->setPosition({tgui::bindLeft(otherWidget), tgui::bindBottom(otherWidget) + 50});

Reimplemented from tgui::Widget.

◆ setPosition() [3/3]

virtual void tgui::ProgressBar::setPosition ( const Layout2d & position )

overridevirtual

Set the position of the widget.

This function completely overwrites the previous position. See the move function to apply an offset based on the previous position instead. The default position of a transformable widget is (0, 0).

Parameters

position New position

See also: move, getPosition

Reimplemented from tgui::Widget.

◆ setSize() [1/3]

void tgui::Transformable::setSize	(	const Layout &	width,
		const Layout &	height
	)

inline

Changes the size of the widget.

Parameters

width	Width of the widget
height	Height of the widget

Usage examples:

// Give the widget an exact size
widget->setSize(40, 30);
 
// Make the widget 50 pixels higher than some other widget
widget->setSize(otherWidget->getSize().x, otherWidget->getSize().y + 50);
 
// Make the widget 50 pixels higher than some other widget and automatically resize it when the other widget resizes
widget->setSize(tgui::bindWidth(otherWidget), tgui::bindHeight(otherWidget) + 50);

◆ setSize() [2/3]

virtual void tgui::Transformable::setSize ( const Layout2d & size )

virtual

Changes the size of the widget.

Parameters

size	Size of the widget

Usage examples:

// Give the widget an exact size
widget->setSize({40, 30});
 
// Make the widget 50 pixels higher than some other widget
widget->setSize(otherWidget->getSize() + sf::Vector2f{0, 50});
 
// Make the widget 50 pixels higher than some other widget and automatically resize it when the other widget resizes
widget->setSize(tgui::bindSize(otherWidget) + sf::Vector2f{0, 50});

Reimplemented from tgui::Widget.

◆ setSize() [3/3]

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

overridevirtual

Changes the size of the progress bar.

Parameters

size	The new size of the progress bar

Reimplemented from tgui::Widget.

◆ setText()

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

Changes the caption of the progress bar.

Parameters

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.

◆ setTextSize()

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

Changes the character size of the text.

Parameters

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

◆ setValue()

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

Changes the current value.

Parameters

value The 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:

include/TGUI/Widgets/ProgressBar.hpp

TGUI

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Enumeration Documentation

◆ FillDirection

Member Function Documentation

◆ clone()

◆ copy()

◆ create()

◆ getFillDirection()

◆ getFullSize()

◆ getMaximum()

◆ getMinimum()

◆ getRenderer()

◆ getText()

◆ getTextSize()

◆ getValue()

◆ getWidgetOffset()

◆ incrementValue()

◆ reload()

◆ setFillDirection()

◆ setFont()

◆ setMaximum()

◆ setMinimum()

◆ setOpacity()

◆ setPosition() [1/3]

◆ setPosition() [2/3]

◆ setPosition() [3/3]

◆ setSize() [1/3]

◆ setSize() [2/3]

◆ setSize() [3/3]

◆ setText()

◆ setTextSize()

◆ setValue()