GuiHint Class Reference
[2D graphical user interface]

A class to display hints. More...

#include <guihint.h>

Inheritance diagram for GuiHint:

[legend]Collaboration diagram for GuiHint:

[legend]List of all members.

Public Member Functions
DECLSPEC	GuiHint (const SDL_Rect &r, GuiElement *el, const char *name)
DECLSPEC	GuiHint (TiXmlElement *el, GuiElement *p)
virtual const char *	getClassName ()
DECLSPEC void	show (int time)
void	setText (const char *t)
void	setTextfont (bool l, GuiText::FontSize s, bool std=false)
DECLSPEC void	showHint (const char *txt, int time=0, SDL_Rect *r=0)
Static Public Member Functions
static void	newguiobject (void *presult, BasicObject *o, void *xmldata)
Protected Member Functions
virtual DECLSPEC Uint32	onResize ()
virtual DECLSPEC void	onInit ()
virtual DECLSPEC Uint32	onThemeChanged (UiTheme *t)
Friends
class	UiManager

---

Detailed Description

A class to display hints.

---

Constructor & Destructor Documentation

GuiHint::GuiHint	(	TiXmlElement *	el,
		GuiElement *	p
	)

Constructor. Uses XML data.

Parameters:

	el	the XML data for initialisation
	p	parent element (or NULL, to take GuiManager::the as parent)

See also:

GuiElement(TiXmlElement*,GuiElement*)

---

Member Function Documentation

virtual const char* GuiHint::getClassName

(

)

[inline, virtual]

This function should be overriden in every sub-class of BasicObject!

Returns:

the name of the class.

Reimplemented from GuiFlowWindow.

Uint32 GuiHint::onResize

(

)

[protected, virtual]

This event is called, when the element changed its place or size.

Returns:

currently the result is not used; may be zero, if no error...

Reimplemented from GuiElement.

void GuiHint::onInit

(

)

[protected, virtual]

Initializes the object's variables by reading data from the XML element. If there were no XML data used for creation, nothing is done. This function calls onInit() of its children recursively (after it has inited itself). It is highly recommended to call BasicObject::onInit(), usually at the end of the onInit() method, when overwriting it in a derived class.

Reimplemented from GuiFlowWindow.

Uint32 GuiHint::onThemeChanged

(

UiTheme *

t

)

[protected, virtual]

This event is called, when the theme changes. Perform here the changes of the object's look and feel.

Parameters:

t

pointer to the new used theme

Returns:

currently the result is not used; may be zero, if no error...

Reimplemented from GuiFlowWindow.

---

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

• guihint.h
• guihint.cpp

---