Public Member Functions | Protected Attributes

gcn::PercentageBar Class Reference

#include <percentagebar.h>

List of all members.

Public Member Functions

 PercentageBar ()
void setOrientation (Orientation orientation)
Orientation getOrientation () const
int32_t getValue () const
void setValue (int32_t value)

Protected Attributes

double mValue
Orientation mOrientation

Detailed Description

A simple percentage bar.

Definition at line 45 of file percentagebar.h.


Constructor & Destructor Documentation

gcn::PercentageBar::PercentageBar (  ) 

Constructor.

Definition at line 39 of file percentagebar.cpp.

References getOrientation(), mValue, setOrientation(), and setValue().


Member Function Documentation

PercentageBar::Orientation gcn::PercentageBar::getOrientation (  )  const

Gets the orientation of the percentage bar..

Returns:
The orientation of the percentage bar.
See also:
setOrientation

Definition at line 102 of file percentagebar.cpp.

Referenced by PercentageBar().

Here is the caller graph for this function:

int32_t gcn::PercentageBar::getValue (  )  const

Gets the value of the percentage bar

Returns:
The value of the percentage bar.

Definition at line 92 of file percentagebar.cpp.

void gcn::PercentageBar::setOrientation ( PercentageBar::Orientation  orientation  ) 

Sets the orientation of the percentage bar.

Parameters:
orientation The orientation of the percentage bar.
See also:
getOrientation

Definition at line 97 of file percentagebar.cpp.

Referenced by PercentageBar().

Here is the caller graph for this function:

void gcn::PercentageBar::setValue ( int32_t  value  ) 

Sets the value of the percentage bar

Parameters:
value In the range of 0-100.

Definition at line 75 of file percentagebar.cpp.

Referenced by PercentageBar().

Here is the caller graph for this function:


Member Data Documentation

Orientation gcn::PercentageBar::mOrientation [protected]

Holds the orientation of the percentage bar. A percentage bar can be drawn vertically or horizontally.

Definition at line 117 of file percentagebar.h.

double gcn::PercentageBar::mValue [protected]

Holds the current value of the percentage bar.

Definition at line 111 of file percentagebar.h.

Referenced by PercentageBar().


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