FIFE  2008.0
 All Classes Namespaces Functions Variables Enumerations Enumerator Pages
gcn::PercentageBar Class Reference

#include <percentagebar.hpp>

Collaboration diagram for gcn::PercentageBar:
Collaboration graph

List of all members.

Public Member Functions

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

Protected Attributes

double mValue
Orientation mOrientation

Detailed Description

A simple percentage bar.

Definition at line 44 of file percentagebar.hpp.


Constructor & Destructor Documentation

gcn::PercentageBar::PercentageBar ( )

Constructor.

Definition at line 41 of file percentagebar.cpp.

References 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 104 of file percentagebar.cpp.

References mOrientation.

int gcn::PercentageBar::getValue ( ) const

Gets the value of the percentage bar

Returns:
The value of the percentage bar.

Definition at line 94 of file percentagebar.cpp.

References mValue.

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

Sets the orientation of the percentage bar.

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

Definition at line 99 of file percentagebar.cpp.

References mOrientation.

Referenced by PercentageBar().

Here is the caller graph for this function:

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

Sets the value of the percentage bar

Parameters:
valueIn the range of 0-100.

Definition at line 77 of file percentagebar.cpp.

References mValue.

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 116 of file percentagebar.hpp.

Referenced by getOrientation(), and setOrientation().

double gcn::PercentageBar::mValue
protected

Holds the current value of the percentage bar.

Definition at line 110 of file percentagebar.hpp.

Referenced by getValue(), and setValue().


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