Dummy object used primarily for the root object or objects of type 'empty'. More...

#include <IGUIObject.h>

Inheritance diagram for CGUIDummyObject:

Public Member Functions
virtual void	Draw ()
	Draws the object. More...

virtual bool	MouseOver ()
	Checks if mouse is hovering this object. More...

Public Member Functions inherited from IGUIObject
	IGUIObject ()

virtual	~IGUIObject ()

virtual bool	MouseOverIcon ()
	Test if mouse position is over an icon. More...

const CStr &	GetName () const
	Get object name, name is unique. More...

void	SetName (const CStr &Name)
	Get object name. More...

CStr	GetPresentableName () const

void	AddToPointersMap (map_pObjects &ObjectMap)
	Adds object and its children to the map, it's name being the first part, and the second being itself. More...

void	AddChild (IGUIObject *pChild)
	Notice nothing will be returned or thrown if the child hasn't been inputted into the GUI yet. More...

vector_pObjects::iterator	ChildrenItBegin ()

vector_pObjects::iterator	ChildrenItEnd ()

bool	SettingExists (const CStr &Setting) const
	Checks if settings exists, only available for derived classes that has this set up, that's why the base class just returns false. More...

virtual void	UpdateCachedSize ()
	All sizes are relative to resolution, and the calculation is not wanted in real time, therefore it is cached, update the cached size with this function. More...

PSRETURN	SetSetting (const CStr &Setting, const CStrW &Value, const bool &SkipMessage=false)
	Set a setting by string, regardless of what type it is. More...

PSRETURN	GetSettingType (const CStr &Setting, EGUISettingType &Type) const
	Retrieves the type of a named setting. More...

void	RegisterScriptHandler (const CStr &Action, const CStr &Code, CGUI *pGUI)
	Set the script handler for a particular object-specific action. More...

JSObject *	GetJSObject ()
	Retrieves the JSObject representing this GUI object. More...

virtual void	HandleMessage (SGUIMessage &Message)
	This function is called with different messages for instance when the mouse enters the object. More...

CGUI *	GetGUI ()

const CGUI *	GetGUI () const

void	SetFocus ()
	Take focus! More...

Detailed Description

Dummy object used primarily for the root object or objects of type 'empty'.

Definition at line 568 of file IGUIObject.h.

Member Function Documentation

virtual void CGUIDummyObject::Draw ( )

inlinevirtual

Draws the object.

Exceptions

PSERROR if any. But this will mostlikely be very rare since if an object is drawn unsuccessfully it'll probably only output in the Error log, and not disrupt the whole GUI drawing.

Implements IGUIObject.

Definition at line 574 of file IGUIObject.h.

virtual bool CGUIDummyObject::MouseOver ( )

inlinevirtual

Checks if mouse is hovering this object.

The mouse position is cached in CGUI.

This function checks if the mouse is hovering the rectangle that the base setting "size" makes. Although it is virtual, so one could derive an object from CButton, which changes only this to checking the circle that "size" makes.

Returns: true if mouse is hovering

Reimplemented from IGUIObject.

Definition at line 576 of file IGUIObject.h.

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

/home/sathyam/0ad.svn/source/gui/IGUIObject.h

Public Member Functions

Detailed Description

Member Function Documentation