Public Types | Public Member Functions

fl7::faces::ProgressBar Class Reference

#include <ProgressBar.h>

Inheritance diagram for fl7::faces::ProgressBar:
fl7::faces::Static fl7::faces::Face

List of all members.

Public Types

enum  Orientation { horizontal, vertical }

Public Member Functions

 ProgressBar (Shell *const shell)
virtual ~ProgressBar (void)
Orientation GetOrientation () const
float GetPosition () const
float GetMinimum () const
float GetMaximum () const
float GetStep () const
void SetOrientation (const Orientation orientation)
void SetPosition (float position)
void SetMinimum (float minimum)
void SetMaximum (float maximum)
void SetStep (float step)
void PerformStep ()

Detailed Description

The (base) class for progress bars.


Member Enumeration Documentation

Possible orientation values (horizontal or vertical).

Enumerator:
horizontal 
vertical 

Constructor & Destructor Documentation

fl7::faces::ProgressBar::ProgressBar ( Shell *const   shell  ) 

Explicit constructor.

Default constructor.

fl7::faces::ProgressBar::~ProgressBar ( void   )  [virtual]

Destructor.


Member Function Documentation

float fl7::faces::ProgressBar::GetMaximum (  )  const [inline]

Returns the maximum value for the (current) position.

float fl7::faces::ProgressBar::GetMinimum (  )  const [inline]

Returns the minimum value for the (current) position.

Orientation fl7::faces::ProgressBar::GetOrientation (  )  const [inline]

Returns the orientation of this progress bar (horizontal or vertical).

float fl7::faces::ProgressBar::GetPosition (  )  const [inline]

Returns the current position (should be between the minimum and the maximum value).

Reimplemented from fl7::faces::Face.

float fl7::faces::ProgressBar::GetStep (  )  const [inline]

Returns the amount the current position will be increased by performing a step.

void fl7::faces::ProgressBar::PerformStep (  ) 

Performs a step (increases the current position by the step amount).

void fl7::faces::ProgressBar::SetMaximum ( float  maximum  ) 

Sets the maximum value for the (current) position.

void fl7::faces::ProgressBar::SetMinimum ( float  minimum  ) 

Sets the minimum value for the (current) position.

void fl7::faces::ProgressBar::SetOrientation ( const Orientation  orientation  )  [inline]

Sets the orientation of this progress bar (horizontal or vertical).

void fl7::faces::ProgressBar::SetPosition ( float  position  ) 

Sets the current position (should be between the minimum and the maximum value).

void fl7::faces::ProgressBar::SetStep ( float  step  ) 

Sets the amount the current position will be increased by performing a step.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines