GUIProgressBar Class Reference

Class that represents a progress bar. More...

#include <GUI/GUIProgressBar.h>

Public Member Functions
	GUIProgressBar ()
	Constructor.
virtual	~GUIProgressBar ()
	Deconstructor.
void	SetBackgroundColor (const Color4f &c)
	Sets the background color of the progress bar.
void	SetBorderColor (const Color4f &c)
	Sets the color of the progress bar border.
void	SetBarColor (const Color4f &c)
	Sets the color of the progress bar.
void	IncrementProgress (float amt)
	Increments the progress bar.
void	SetProgress (float val)
	Sets the progress.
float	GetProgress () const
	Gets the current progress of the progress bar in the range [0, 1].
void	ResetProgress ()
	Resets the progress of the progress bar.
void	SetInnerText (const char *str)
	Sets the inner text to draw.
void	SetInnerTextFont (FontRef font)
	Sets the inner text font.
Protected Member Functions
virtual void	Paint ()
	Draws the progress bar.

Detailed Description

Class that represents a progress bar.

float GUIProgressBar::GetProgress ( ) const [inline]

Gets the current progress of the progress bar in the range [0, 1].

void GUIProgressBar::IncrementProgress ( float amt )

Increments the progress bar.

Parameters:

[in] amt the amount to increment the progress bar. Clamped to the range [0,1].

void GUIProgressBar::SetBackgroundColor ( const Color4f & c ) [inline]

Sets the background color of the progress bar.

Parameters:

[in] c the color.

void GUIProgressBar::SetBarColor ( const Color4f & c ) [inline]

Sets the color of the progress bar.

Parameters:

[in] c the color.

void GUIProgressBar::SetBorderColor ( const Color4f & c ) [inline]

Sets the color of the progress bar border.

Parameters:

[in] c the color.

void GUIProgressBar::SetProgress ( float val )

Sets the progress.

Parameters:

[in] val the new progress clamped to the range [0, 1].

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