ClanSoft logo
ClanSoft logo
Entire Class Index Main Class Index Cross Index Global Index

Class CL_ProgressBar

ProgressBar component
Contained in: global
Derived from: CL_Component
Derived by: none
Group: GUI (Controls)

#include <ClanLib/gui.h>


public function member index:

Construction:

CL_ProgressBar(CL_Component* parent, CL_StyleManager* style = NULL);
CL_ProgressBar(int steps, CL_Component* parent, CL_StyleManager* style = NULL);
CL_ProgressBar(const CL_Rect& pos, int steps, CL_Component* parent, CL_StyleManager* style = NULL);
virtual ~CL_ProgressBar();

Attributes:

int get_steps() const;
int get_progress() const;
float get_percentage() const;

Operations:

void set_steps(int total_steps);
void set_progress(int progress);
void increase(int steps = 1);
void reset();
 

private function member index:

Implementation:

CL_ProgressBar(const CL_ProgressBar& copy);
 

Description:


Function Member Descriptions:

CL_ProgressBar::CL_ProgressBar - ProgressBar Constructor
CL_ProgressBar(CL_Component* parent, CL_StyleManager* style = NULL);


CL_ProgressBar::CL_ProgressBar - ProgressBar Constructor
CL_ProgressBar(int steps, CL_Component* parent, CL_StyleManager* style = NULL);


CL_ProgressBar::CL_ProgressBar - ProgressBar Constructor
CL_ProgressBar(const CL_Rect& pos, int steps, CL_Component* parent, CL_StyleManager* style = NULL);


CL_ProgressBar::get_percentage - Returns the current amount of progress in percentage.
float get_percentage() const;


CL_ProgressBar::get_progress - Returns the current amount of progress.
int get_progress() const;


CL_ProgressBar::get_steps - Returns the total number of steps.
int get_steps() const;


CL_ProgressBar::increase - Progresses the bar with steps.
void increase(int steps = 1);


CL_ProgressBar::reset - Reset the progress bar. The progress bar `rewinds'.
void reset();


CL_ProgressBar::set_progress - Sets the current amount of progress of the total number of steps.
void set_progress(int progress);


CL_ProgressBar::set_steps - Sets the total number of steps to total_steps.
void set_steps(int total_steps);


CL_ProgressBar::~CL_ProgressBar - ProgressBar Destructor
virtual ~CL_ProgressBar();



Variable Member Descriptions: