Linderdaum Engine: iProperty Class Reference
Updated: Mon May 14 2012 05:02:37
iProperty Class Reference

#include <Property.h>

List of all members.

Public Member Functions

 iProperty ()
virtual ~iProperty ()
virtual bool Load (iObject *TheObject, mlNode *Node) const =0
 Load the property from internal tree representation.
virtual noexport bool Save (iObject *TheObject, mlNode **Node) const =0
 Serialize the property to some internal representation.
scriptmethod bool SetValue (iObject *Obj, const LString &Value) const
 Try to set property value using the value's string representation.
scriptmethod LString GetValue (iObject *Obj) const
 Try to get property value in a string representation.
virtual bool IsArray () const
 Return 'true' if this property is an array.
scriptmethod bool IsDefaultValue (iObject *Obj) const
 Return 'true' if current value of the property was not changed from the initial value.
scriptmethod void SetName (const LString &NName)
 Set property name.
scriptmethod LString GetName () const
 Get property name.
virtual bool Serialized () const
 Is it serialized (default is true)

Protected Attributes

LString FName
 Property name.

Detailed Description

Generic property interface

Allows abstract serialization/deserialization and (a little later) value-to-CVar binding


Constructor & Destructor Documentation

iProperty::iProperty ( ) [inline]
virtual iProperty::~iProperty ( ) [inline, virtual]

Member Function Documentation

scriptmethod LString iProperty::GetName ( ) const [inline]

Get property name.

LString iProperty::GetValue ( iObject Obj) const

Try to get property value in a string representation.

virtual bool iProperty::IsArray ( ) const [inline, virtual]

Return 'true' if this property is an array.

Reimplemented in clArrayProperty.

bool iProperty::IsDefaultValue ( iObject Obj) const

Return 'true' if current value of the property was not changed from the initial value.

Reimplemented in clArrayProperty.

virtual bool iProperty::Load ( iObject TheObject,
mlNode Node 
) const [pure virtual]

Load the property from internal tree representation.

Implemented in clFieldProperty, and clArrayProperty.

virtual noexport bool iProperty::Save ( iObject TheObject,
mlNode **  Node 
) const [pure virtual]

Serialize the property to some internal representation.

Implemented in clFieldProperty, and clArrayProperty.

virtual bool iProperty::Serialized ( ) const [inline, virtual]

Is it serialized (default is true)

scriptmethod void iProperty::SetName ( const LString &  NName) [inline]

Set property name.

bool iProperty::SetValue ( iObject Obj,
const LString &  Value 
) const

Try to set property value using the value's string representation.


Member Data Documentation

LString iProperty::FName [protected]

Property name.


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