interreality.org [VOS]
[Home] [About]
[Screenshots]
 [Download]
[News]
 [Community]
[Documentation] [Manual]
[Bugs & Requests] [Wiki]
VOS::PropertyEvent

VOS::PropertyEvent Class Reference
[libmetaobject_property]

#include <vos/metaobjects/property/propertylistener.hh>

Inheritance diagram for VOS::PropertyEvent:

VUtil::RefCounted List of all members.

Detailed Description

PropertyEvents are passed to PropertyListener objectss to notify them of changes to the properties they are listening to.

Definition at line 61 of file propertylistener.hh.

Public Types

Public Member Functions

Member Enumeration Documentation

enum VOS::PropertyEvent::EventType

Enumerator:
PropertyWrite 
PropertyReplace 
PropertyRead 

Definition at line 64 of file propertylistener.hh.

Constructor & Destructor Documentation

VOS::PropertyEvent::PropertyEvent ( EventType  et,
Vobject *  init,
Property &  property,
const std::string &  value,
const std::string &  datatype,
bool  isACcheck 
)

VOS::PropertyEvent::PropertyEvent ( EventType  et,
Vobject *  init,
Property &  property,
const std::string &  value,
const std::string &  datatype,
const std::string &  oldvalue,
const std::string &  olddatatype,
bool  isACcheck 
)

VOS::PropertyEvent::PropertyEvent ( EventType  et,
Vobject *  init,
Property &  property,
int  offset,
int  length,
const std::string &  value,
const std::string &  datatype,
bool  isACcheck 
)

VOS::PropertyEvent::PropertyEvent ( EventType  et,
Vobject *  init,
Property &  property,
int  offset,
int  length,
const std::string &  value,
const std::string &  datatype,
const std::string &  oldvalue,
const std::string &  olddatatype,
bool  isACcheck 
)

virtual VOS::PropertyEvent::~PropertyEvent (  )  [virtual]

Member Function Documentation

void VOS::PropertyEvent::deliverTo ( PropertyListener *  pl  )  [inline]

Definition at line 175 of file propertylistener.hh.

const std::string& VOS::PropertyEvent::getDataType (  )  const [inline]

Returns:
For an access control check, this is the old property datatype (the change has not been commited yet). For a notify event it is the current datatype of the property.

Definition at line 167 of file propertylistener.hh.

EventType VOS::PropertyEvent::getEvent (  )  const [inline]

Returns:
What type of event this is.

Definition at line 107 of file propertylistener.hh.

VUtil::vRef<Vobject> VOS::PropertyEvent::getInitiator (  )  const [inline]

Returns:
The object which requested or initiated this event. Always valid. For access control checks, this is the object which is requesting access.

Definition at line 113 of file propertylistener.hh.

unsigned int VOS::PropertyEvent::getLength (  )  const [inline]

Returns:
The size of the changed section.

Definition at line 131 of file propertylistener.hh.

const std::string& VOS::PropertyEvent::getNewDataType (  )  const [inline]

Returns:
For an access control check, this is the proposed new datatype (it has not been commited yet). For a notify event, the new datatype for this property.

Definition at line 162 of file propertylistener.hh.

const std::string& VOS::PropertyEvent::getNewValue (  )  const [inline]

Returns:
For an access control check, this is the proposed new value (it has not been commited yet). For a notify event, the new value for this property.

Definition at line 141 of file propertylistener.hh.

unsigned int VOS::PropertyEvent::getOffset (  )  const [inline]

Returns:
The beginning of the changed section.
Note:
If you want to know what exactly section of the property changed on a write event, use 
string section = e.getNewValue().substr(e.getOffset(), e.getLength());

Definition at line 128 of file propertylistener.hh.

const std::string& VOS::PropertyEvent::getOldDataType (  )  const [inline]

Returns:
The previous datatype of this property, prior to a proposed change (for access control checks) or prior to the most recent change (for notify events).

Definition at line 157 of file propertylistener.hh.

const std::string& VOS::PropertyEvent::getOldValue (  )  const [inline]

Returns:
The previous value of this property, prior to a proposed change (for access control checks) or prior to the most recent change (for notify events).

Definition at line 136 of file propertylistener.hh.

VUtil::vRef<Property> VOS::PropertyEvent::getProperty (  )  const

Returns:
The property which is being accessed or changed. Always valid. For access control checks, this is the object which is requesting access.

const std::string& VOS::PropertyEvent::getValue (  )  const [inline]

Returns:
For an access control check, this is the old property value (the change has not been commited yet). For a notify event it is the current value of the property.

Definition at line 146 of file propertylistener.hh.

void VOS::PropertyEvent::setNewDataType ( const std::string &  dt  )  [inline]

Only to be used for access control checks.

This allows you to modify the proposed new datatype for this property.

Parameters:
dt the new datatype to use

Definition at line 173 of file propertylistener.hh.

void VOS::PropertyEvent::setNewValue ( const std::string &  v  )  [inline]

Only to be used for access control checks.

This allows you to modify the proposed new value for this property.

Parameters:
v the new value to use

Definition at line 152 of file propertylistener.hh.

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