OpenGUI::ObjectProperty Class Reference

#include <OpenGUI_ObjectAccessor.h>

Inheritance diagram for OpenGUI::ObjectProperty:

Detailed Description

Base class for Property Accessors.

Object Properties that applications wish to expose should inherit this class.

Public Member Functions

virtual void get (Object &objectRef, Value &valueOut)=0

Called to retrieve the current value.

virtual void set (Object &objectRef, Value &valueIn)=0

Called to set the current value.

virtual Value::ValueType getPropertyType ()=0

Needs to return the expected Value type.

virtual bool getPermSettable ()

Used by ObjectAccessorList to determine if this property is write protected. Default returns TRUE ( property can be get and set ).

Member Function Documentation

virtual void OpenGUI::ObjectProperty::get ( Object & objectRef,

Value & valueOut

) [pure virtual]

Called to retrieve the current value.

bool OpenGUI::ObjectProperty::getPermSettable ( ) [virtual]

Used by ObjectAccessorList to determine if this property is write protected. Default returns TRUE ( property can be get and set ).

virtual Value::ValueType OpenGUI::ObjectProperty::getPropertyType ( ) [pure virtual]

Needs to return the expected Value type.

virtual void OpenGUI::ObjectProperty::set ( Object & objectRef,

Value & valueIn

) [pure virtual]

Called to set the current value.

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

OpenGUI_ObjectAccessor.h
OpenGUI_ObjectAccessor.cpp


Public Member Functions
virtual void	get (Object &objectRef, Value &valueOut)=0
	Called to retrieve the current value.
virtual void	set (Object &objectRef, Value &valueIn)=0
	Called to set the current value.
virtual Value::ValueType	getPropertyType ()=0
	Needs to return the expected Value type.
virtual bool	getPermSettable ()
	Used by ObjectAccessorList to determine if this property is write protected. Default returns `TRUE` ( property can be `get` and `set` ).