PlayerBox Class Reference
[Core GUI related classes (widgets)]

#include <playerbox.h>

Detailed Description

A box showing a player character.

Definition at line 35 of file playerbox.h.


Public Member Functions
	PlayerBox (const Player *player=NULL)
	Constructor.
	~PlayerBox ()
	Destructor.
void	setPlayer (const Player *player)
	Sets a new player character to be displayed by this box.
void	draw (gcn::Graphics *graphics)
	Draws the scroll area.
void	drawFrame (gcn::Graphics *graphics)
	Draws the background and border of the scroll area.
Private Attributes
const Player *	mPlayer
	The character used for display.
Static Private Attributes
static float	mAlpha = 1.0
static int	instances = 0
static ImageRect	background

PlayerBox::PlayerBox ( const Player * player = NULL )

Constructor.

Takes the initial player character that this box should display, which defaults to NULL.

Definition at line 38 of file playerbox.cpp.

PlayerBox::~PlayerBox ( )

Destructor.

Definition at line 69 of file playerbox.cpp.

void PlayerBox::setPlayer ( const Player * player ) [inline]

Sets a new player character to be displayed by this box.

Setting the player to NULL causes the box not to draw any character.

Definition at line 54 of file playerbox.h.

void PlayerBox::draw ( gcn::Graphics * graphics )

Draws the scroll area.

Definition at line 79 of file playerbox.cpp.

void PlayerBox::drawFrame ( gcn::Graphics * graphics )

Draws the background and border of the scroll area.

Definition at line 111 of file playerbox.cpp.

const Player* PlayerBox::mPlayer [private]

The character used for display.

Definition at line 67 of file playerbox.h.

float PlayerBox::mAlpha = 1.0 [static, private]

Definition at line 69 of file playerbox.h.

int PlayerBox::instances = 0 [static, private]

Definition at line 70 of file playerbox.h.

ImageRect PlayerBox::background [static, private]

Definition at line 71 of file playerbox.h.

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