GuiScrollBg Class Reference
[2D graphical user interface]

A class to display a large object in a small area by using scrollbars. More...

#include <guiscroller.h>

Inheritance diagram for GuiScrollBg:

[legend]Collaboration diagram for GuiScrollBg:

[legend]List of all members.

Public Member Functions
DECLSPEC	GuiScrollBg (const SDL_Rect &r, GuiElement *el, const char *name, int minw, int minh, SdlSurface *bmp=NULL)
DECLSPEC	GuiScrollBg (TiXmlElement *el, GuiElement *p)
virtual const char *	getClassName ()
DECLSPEC void	setMinSize (int w, int h)
GuiFlowWindow *	getwnd ()
void	setCallback (Callback c)
void	setCallbackData (BasicObject *d)
Static Public Member Functions
static void	newguiobject (void *presult, BasicObject *o, void *xmldata)
Protected Member Functions
virtual DECLSPEC Uint32	onResize ()
virtual DECLSPEC void	onInit ()

---

Detailed Description

A class to display a large object in a small area by using scrollbars.

---

Constructor & Destructor Documentation

GuiScrollBg::GuiScrollBg	(	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* GuiScrollBg::getClassName

(

)

[inline, virtual]

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

Returns:

the name of the class.

Reimplemented from GuiElement.

Uint32 GuiScrollBg::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 GuiScrollBg::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 GuiElement.

---

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

• guiscroller.h
• guiscroller.cpp

---