VRS::ProgressBar Class Reference

! By deriving from this class one can build a GUI element for representing the progress of time consuming operations (which uses the VRS::Progress class to track the operation). More...

#include <vrs/progressbar.h>

Inheritance diagram for VRS::ProgressBar:

List of all members.

Static Public Member Functions
static void	push (ProgressBar *progressBar)
static ProgressBar *	top ()
static void	pop ()
Static Protected Member Functions
static void	showBar ()
static bool	updateBar (const std::vector< Progress * > &progresses, bool forceUpdate, bool forceShow)
static void	hideBar ()
static void	finishBar (const std::vector< Progress * > &progresses)
	allows the progress bar to display a "finished" message, e.g., for overall time elapsed
Friends
class	Progress

---

Detailed Description

! By deriving from this class one can build a GUI element for representing the progress of time consuming operations (which uses the VRS::Progress class to track the operation).

Note: the handling is done on a per thread basis.

---

Member Function Documentation

static void VRS::ProgressBar::push

(

ProgressBar *

progressBar

)

[static]

Only one ProgressBar object can be active at a time. By pushing a new ProgressBar object the previous ProgressBar object will be disabled and the pushed one becomes the active one. It is possible to pass a NULL pointer for disabling the progress display. NOTE: During an active progress tracking process the active ProgressBar object cannot be changed!

static ProgressBar* VRS::ProgressBar::top

(

)

[static]

Returns the currently active ProgressBar object (can be NULL).

static void VRS::ProgressBar::pop

(

)

[static]

Removes the currently active ProgressBar object again, thus activating the previously active ProgressBar object again.

static void VRS::ProgressBar::showBar

(

)

[static, protected]

static bool VRS::ProgressBar::updateBar	(	const std::vector< Progress * > &	progresses,
		bool	forceUpdate,
		bool	forceShow
	)			[static, protected]

static void VRS::ProgressBar::hideBar

(

)

[static, protected]

static void VRS::ProgressBar::finishBar

(

const std::vector< Progress * > &

progresses

)

[static, protected]

allows the progress bar to display a "finished" message, e.g., for overall time elapsed

---

Friends And Related Function Documentation

friend class Progress [friend]

---

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

• progressbar.h