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

#include <gui.h>

List of all members.

---

Detailed Description

Main GUI class.

Definition at line 48 of file gui.h.

Public Types
enum	{   CURSOR_POINTER = 0, CURSOR_RESIZE_ACROSS, CURSOR_RESIZE_DOWN, CURSOR_RESIZE_DOWN_LEFT,   CURSOR_RESIZE_DOWN_RIGHT, CURSOR_TOTAL }
	Cursors are in graphic order from left to right. More...
Public Member Functions
	Gui (Graphics *screen)
	Constructor.
	~Gui ()
	Destructor.
void	logic ()
	Performs logic of the GUI.
void	draw ()
	Draws the whole Gui by calling draw functions down in the Gui hierarchy.
gcn::Font *	getFont () const
	Return game font.
gcn::Font *	getInfoParticleFont () const
	Return the Font used for "Info Particles", i.e.
void	setUseCustomCursor (bool customCursor)
	Sets whether a custom cursor should be rendered.
void	setCursorType (int index)
	Sets which cursor should be used.
Protected Member Functions
void	handleMouseMoved (const gcn::MouseInput &mouseInput)
Private Attributes
GuiConfigListener *	mConfigListener
gcn::Font *	mGuiFont
	The global GUI font.
gcn::Font *	mInfoParticleFont
	Font for Info Particles.
bool	mCustomCursor
	Show custom cursor.
ImageSet *	mMouseCursors
	Mouse cursor images.
float	mMouseCursorAlpha
int	mMouseInactivityTimer
int	mCursorType

---

Member Enumeration Documentation

anonymous enum

Cursors are in graphic order from left to right.

CURSOR_POINTER should be left untouched. CURSOR_TOTAL should always be last.

Enumerator:

CURSOR_POINTER
CURSOR_RESIZE_ACROSS
CURSOR_RESIZE_DOWN
CURSOR_RESIZE_DOWN_LEFT
CURSOR_RESIZE_DOWN_RIGHT
CURSOR_TOTAL

Definition at line 102 of file gui.h.

---

Constructor & Destructor Documentation

Gui::Gui

(

Graphics *

screen

)

Constructor.

Definition at line 74 of file gui.cpp.

Gui::~Gui

(

)

Destructor.

Definition at line 149 of file gui.cpp.

---

Member Function Documentation

void Gui::logic

(

)

Performs logic of the GUI.

Overridden to track mouse pointer activity.

Definition at line 168 of file gui.cpp.

void Gui::draw

(

)

Draws the whole Gui by calling draw functions down in the Gui hierarchy.

It also draws the mouse pointer.

Definition at line 184 of file gui.cpp.

gcn::Font* Gui::getFont

(

)

const [inline]

Return game font.

Definition at line 76 of file gui.h.

gcn::Font* Gui::getInfoParticleFont

(

)

const [inline]

Return the Font used for "Info Particles", i.e.

ones showing, what you picked up, etc.

Definition at line 83 of file gui.h.

void Gui::setUseCustomCursor

(

bool

customCursor

)

Sets whether a custom cursor should be rendered.

Definition at line 208 of file gui.cpp.

void Gui::setCursorType

(

int

index

)

[inline]

Sets which cursor should be used.

Definition at line 94 of file gui.h.

void Gui::handleMouseMoved

(

const gcn::MouseInput &

mouseInput

)

[protected]

Definition at line 242 of file gui.cpp.

---

Member Data Documentation

GuiConfigListener* Gui::mConfigListener [private]

Definition at line 115 of file gui.h.

gcn::Font* Gui::mGuiFont [private]

The global GUI font.

Definition at line 116 of file gui.h.

gcn::Font* Gui::mInfoParticleFont [private]

Font for Info Particles.

Definition at line 117 of file gui.h.

bool Gui::mCustomCursor [private]

Show custom cursor.

Definition at line 118 of file gui.h.

ImageSet* Gui::mMouseCursors [private]

Mouse cursor images.

Definition at line 119 of file gui.h.

float Gui::mMouseCursorAlpha [private]

Definition at line 120 of file gui.h.

int Gui::mMouseInactivityTimer [private]

Definition at line 121 of file gui.h.

int Gui::mCursorType [private]

Definition at line 122 of file gui.h.

---

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

• tmw/src/gui/gui.h
• tmw/src/gui/gui.cpp