OpenGUI::Object Class Reference

#include <OpenGUI_Object.h>

Inheritance diagram for OpenGUI::Object:

List of all members.

---

Detailed Description

Base class for all GUI objects. Provides an exposed interface to the Accessor and Event systems.

Public Types
	OT_UNKNOWN = 0
	should never happen
	OT_SCREEN = 1
	Object is a Screen.
	OT_CURSOR = 2
	Object is a Cursor.
	OT_WIDGET = 5
	Object is a Widget.
	OT_CONTROL = 6
	Object is a Control.
	OT_CONTAINERCONTROL = 7
	Object is a ContainerControl.
	OT_WINDOW = 8
	Object is a Window.
enum	Object_Type {   OT_UNKNOWN = 0,   OT_SCREEN = 1,   OT_CURSOR = 2,   OT_WIDGET = 5,   OT_CONTROL = 6,   OT_CONTAINERCONTROL = 7,   OT_WINDOW = 8 }
	These are the possible return values for getObjectType(). More...
Public Member Functions
void	getProperty (const std::string &propertyName, Value &valueOut)
	returns the value of propertyName via valueOut
void	setProperty (const std::string &propertyName, Value &valueIn)
	sets the value of propertyName to the contents of valueIn
void	callMethod (const std::string &methodName, ValueList &paramIn, ValueList &returnOut)
	invokes methodName, sending paramIn as arguments, and catching return values in returnOut
void	triggerEvent (const std::string &eventName, EventArgs &evtArgs)
	triggers the event of the given eventName, sending the given evtArgs
virtual ObjectAccessorList *	getAccessors ()
	returns this object's ObjectAccessorList head
EventReceiver &	getEvents ()
	Returns the Event::EventReceiver for this Object instance.
virtual unsigned int	getObjectType () const =0
	Returns an integer identifying the type of object.

---

Member Enumeration Documentation

enum OpenGUI::Object::Object_Type

These are the possible return values for getObjectType().

Enumerator:

OT_UNKNOWN	should never happen
OT_SCREEN	Object is a Screen.
OT_CURSOR	Object is a Cursor.
OT_WIDGET	Object is a Widget.
OT_CONTROL	Object is a Control.
OT_CONTAINERCONTROL	Object is a ContainerControl.
OT_WINDOW	Object is a Window.

---

Member Function Documentation

void OpenGUI::Object::callMethod	(	const std::string &	methodName,
		ValueList &	paramIn,
		ValueList &	returnOut
	)

invokes methodName, sending paramIn as arguments, and catching return values in returnOut

ObjectAccessorList * OpenGUI::Object::getAccessors

(

)

[virtual]

returns this object's ObjectAccessorList head

Reimplemented in OpenGUI::ContainerControl, OpenGUI::Control, OpenGUI::Cursor, OpenGUI::GenericCursor, OpenGUI::Screen, OpenGUI::Widget, and OpenGUI::Window.

EventReceiver & OpenGUI::Object::getEvents

(

)

Returns the Event::EventReceiver for this Object instance.

virtual unsigned int OpenGUI::Object::getObjectType

(

)

const [pure virtual]

Returns an integer identifying the type of object.

See also:

Object_Type

Implemented in OpenGUI::ContainerControl, OpenGUI::Control, OpenGUI::Cursor, OpenGUI::Screen, OpenGUI::Widget, and OpenGUI::Window.

void OpenGUI::Object::getProperty	(	const std::string &	propertyName,
		Value &	valueOut
	)

returns the value of propertyName via valueOut

void OpenGUI::Object::setProperty	(	const std::string &	propertyName,
		Value &	valueIn
	)

sets the value of propertyName to the contents of valueIn

void OpenGUI::Object::triggerEvent	(	const std::string &	eventName,
		EventArgs &	evtArgs
	)			[inline]

triggers the event of the given eventName, sending the given evtArgs

Parameters:

	eventName	The name of the event to trigger
	evtArgs	The EventArgs based event data, by reference

---

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

• OpenGUI_Object.h
• OpenGUI_Object.cpp

---

Copyright © 2006 OpenGUI | OpenGUI.SF.net
Generated: Fri Jan 5 23:05:25 2007