fcn::PercentageBar Class Reference

A simple percentage bar. More...

#include <percentagebar.h>

Inherits Widget.

Collaboration diagram for fcn::PercentageBar:

Public Types
enum	Orientation { HORIZONTAL = 0, VERTICAL }

Public Member Functions
	PercentageBar ()
	Constructor. More...
virtual	~PercentageBar ()
virtual void	draw (Graphics *graphics)
void	setForegroundImage (Image *image)
void	setOrientation (Orientation orientation)
	Sets the orientation of the percentage bar. More...
Orientation	getOrientation () const
	Gets the orientation of the percentage bar. More...
int32_t	getValue () const
	Gets the value of the percentage bar. More...
void	setValue (int32_t value)
	Sets the value of the percentage bar. More...

Protected Attributes
Image *	mImage
double	mValue
	Holds the current value of the percentage bar. More...
Orientation	mOrientation
	Holds the orientation of the percentage bar. More...

Detailed Description

A simple percentage bar.

Definition at line 45 of file percentagebar.h.

Member Enumeration Documentation

enum fcn::PercentageBar::Orientation

Enumerator
HORIZONTAL
VERTICAL

Definition at line 49 of file percentagebar.h.

Constructor & Destructor Documentation

fcn::PercentageBar::PercentageBar

(

)

Constructor.

Definition at line 41 of file percentagebar.cpp.

References HORIZONTAL, mImage, setOrientation(), and setValue().

virtual fcn::PercentageBar::~PercentageBar ( )

inlinevirtual

Definition at line 60 of file percentagebar.h.

Member Function Documentation

void fcn::PercentageBar::draw ( Graphics *  graphics )

virtual

Definition at line 49 of file percentagebar.cpp.

References getOrientation(), HORIZONTAL, mImage, and mValue.

PercentageBar::Orientation fcn::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.

Referenced by draw().

Here is the caller graph for this function:

int32_t fcn::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 fcn::PercentageBar::setForegroundImage

(

Image *

image

)

Definition at line 68 of file percentagebar.cpp.

References mImage.

void fcn::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 99 of file percentagebar.cpp.

References mOrientation.

Referenced by PercentageBar().

Here is the caller graph for this function:

void fcn::PercentageBar::setValue

(

int32_t

value

)

Sets the value of the percentage bar.

Parameters

value

In 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

Image* fcn::PercentageBar::mImage

protected

Definition at line 105 of file percentagebar.h.

Referenced by draw(), PercentageBar(), and setForegroundImage().

Orientation fcn::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.h.

Referenced by getOrientation(), and setOrientation().

double fcn::PercentageBar::mValue

protected

Holds the current value of the percentage bar.

Definition at line 110 of file percentagebar.h.

Referenced by draw(), getValue(), and setValue().

---

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

• engine/core/gui/fifechan/widgets/percentagebar.h
• engine/core/gui/fifechan/widgets/percentagebar.cpp