GuiPageControl Class Reference
[2D graphical user interface]

A class for page controls. More...

#include <guibackground.h>

Inheritance diagram for GuiPageControl:

[legend]Collaboration diagram for GuiPageControl:

[legend]List of all members.

Public Types
enum	SIDE { top, bottom, left, right }
typedef list< GuiElement * >	page_list
typedef page_list::iterator	page_iter
Public Member Functions
DECLSPEC	GuiPageControl (const SDL_Rect &r, GuiElement *el, const char *name, Uint32 c=CLR_INVALID, SdlSurfaceContainer *res=0)
DECLSPEC	GuiPageControl (TiXmlElement *el, GuiElement *p)
virtual const char *	getClassName ()
DECLSPEC page_iter	addPage (GuiElement *pg, const char *t=0, SdlSurfaceContainer *res=0, Uint32 w=0)
DECLSPEC void	setButton (Uint32 w, Uint32 h, SdlSurfaceContainer *res=0)
DECLSPEC void	setSide (SIDE s)
DECLSPEC bool	removePage (page_iter i)
DECLSPEC bool	removePage (GuiElement *el)
Static Public Member Functions
static void	newguiobject (void *presult, BasicObject *o, void *xmldata)
Protected Member Functions
virtual DECLSPEC Uint32	onResize ()
virtual DECLSPEC void	onChange (GuiRadioContainer *sender)
virtual DECLSPEC void	onInit ()
virtual DECLSPEC Uint32	onThemeChanged (UiTheme *t)

---

Detailed Description

A class for page controls.

---

Constructor & Destructor Documentation

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

Constructor. Uses XML data.

Parameters:

	el	the XML data for initialisation, the following attributes are read: ButtonBmps
	p	parent element (or NULL, to take GuiManager::the as parent)

See also:

GuiElement(TiXmlElement*,GuiElement*)

---

Member Function Documentation

virtual const char* GuiPageControl::getClassName

(

)

[inline, virtual]

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

Returns:

the name of the class.

Reimplemented from GuiPictureBg.

Uint32 GuiPageControl::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 GuiPageControl::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 GuiPictureBg.

Uint32 GuiPageControl::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 GuiPictureBg.

---

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

• guibackground.h
• guibackground.cpp

---