Public Types | Public Member Functions | List of all members
iattr::CEnumAttributeMetaInfo Class Reference

Represents constraints of properties allowing values from enumerated set. More...

#include <CEnumAttributeMetaInfo.h>

Inheritance diagram for iattr::CEnumAttributeMetaInfo:
iattr::CAttributeMetaInfo iattr::IEnumAttributeMetaInfo iattr::IAttributeMetaInfo iattr::IAttributeMetaInfo istd::IChangeable istd::IChangeable istd::IPolymorphic istd::IPolymorphic

Public Types

typedef CAttributeMetaInfo BaseClass
 
- Public Types inherited from iattr::IAttributeMetaInfo
enum  AttributeFlags {
  AF_OBLIGATORY = 1 << 0, AF_NULLABLE = 1 << 1, AF_SINGLE = 1 << 2, AF_MULTIPLE = 1 << 3,
  AF_VALUE = 1 << 4, AF_READ_ONLY = 1 << 31
}
 Flags signalizing set of attribute properties. More...
 
- Public Types inherited from istd::IChangeable
enum  ChangeFlags {
  CF_ACF_INTERNAL = 0, CF_ALL_DATA, CF_ANY, CF_DESTROYING,
  CF_DELEGATED, CF_NO_UNDO
}
 Data model change notification flags. More...
 
enum  SupportedOperations {
  SO_NONE = 0, SO_OBSERVE = 1 << 0, SO_COPY = 1 << 1, SO_CLONE = 1 << 2,
  SO_COMPARE = 1 << 3, SO_RESET = 1 << 4
}
 Flags for supported operations. More...
 
enum  CompatibilityMode { CM_STRICT, CM_WITHOUT_REFS, CM_WITH_REFS, CM_CONVERT }
 Control how relationship betweeen objects are interpreted. More...
 

Public Member Functions

 CEnumAttributeMetaInfo (const QByteArray &typeId="")
 
void SetOtherValueAllowed (bool state)
 
const QString & GetUnknownDescription () const
 Get descrition of unknown value;. More...
 
void SetUnknownDescription (const QString &description)
 Set descrition of unknown value;. More...
 
bool InsertOption (const QString &description, const iser::IObject *valuePtr, bool releaseFlag)
 Insert new enumeration element. More...
 
virtual bool IsAnyValueAllowed () const
 Checks if other then enumerated values are allowed. More...
 
virtual int GetEnumsCount () const
 Gets number of enumerations. More...
 
virtual QString GetValueDescription (const iser::IObject &value) const
 Gets description of single enumeration. More...
 
virtual const iser::IObjectGetEnum (int index) const
 Gets single enumeration. More...
 
- Public Member Functions inherited from iattr::CAttributeMetaInfo
 CAttributeMetaInfo (const QByteArray &typeId="")
 
void SetAttributeTypeId (const QByteArray &typeId)
 
void SetAttributeDescription (const QString &description)
 
void SetAttributeFlags (int attributeFlags)
 
void SetAttributeDefaultValue (const iser::IObject *defaultValuePtr, bool releaseFlag)
 
virtual QString GetAttributeDescription () const
 Get description of this attribute. More...
 
virtual const iser::IObjectGetAttributeDefaultValue () const
 Get default attribute value. More...
 
virtual QByteArray GetAttributeTypeId () const
 Return attribute type ID. More...
 
virtual int GetAttributeFlags () const
 Get flags of this attribute. More...
 
- Public Member Functions inherited from istd::IChangeable
virtual int GetSupportedOperations () const
 Get set of flags for supported operations. More...
 
virtual bool CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
 Copy this object from another one. More...
 
virtual bool IsEqual (const IChangeable &object) const
 Compare this object with another object. More...
 
virtual IChangeableCloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
 Make a copy of this object. More...
 
virtual bool ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
 Reset data to its default state. More...
 
virtual void BeginChanges (const ChangeSet &changeSet)
 Starts the change transaction. More...
 
virtual void EndChanges (const ChangeSet &changeSet)
 Ends the change transaction. More...
 
virtual void BeginChangeGroup (const ChangeSet &changeSet)
 Starts group of changes. More...
 
virtual void EndChangeGroup (const ChangeSet &changeSet)
 Ends group of changes. More...
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 

Additional Inherited Members

- Static Public Member Functions inherited from istd::IChangeable
static const ChangeSetGetNoChanges ()
 Get empty set of changes. More...
 
static const ChangeSetGetAnyChange ()
 Get anonymous change set. More...
 
static const ChangeSetGetAllChanges ()
 Get anonymous change set. More...
 
static const ChangeSetGetDelegatedChanges ()
 Get delegated change set. More...
 
- Protected Member Functions inherited from istd::IChangeable
virtual void OnBeginChanges ()
 Callback function for begin change event. More...
 
virtual void OnEndChanges (const ChangeSet &changeSet)
 Callback function for end change event. More...
 

Detailed Description

Represents constraints of properties allowing values from enumerated set.

Definition at line 23 of file CEnumAttributeMetaInfo.h.

Member Typedef Documentation

Definition at line 28 of file CEnumAttributeMetaInfo.h.

Constructor & Destructor Documentation

iattr::CEnumAttributeMetaInfo::CEnumAttributeMetaInfo ( const QByteArray &  typeId = "")
explicit

Member Function Documentation

virtual const iser::IObject& iattr::CEnumAttributeMetaInfo::GetEnum ( int  index) const
virtual

Gets single enumeration.

Implements iattr::IEnumAttributeMetaInfo.

virtual int iattr::CEnumAttributeMetaInfo::GetEnumsCount ( ) const
virtual

Gets number of enumerations.

Implements iattr::IEnumAttributeMetaInfo.

const QString& iattr::CEnumAttributeMetaInfo::GetUnknownDescription ( ) const

Get descrition of unknown value;.

See Also
iattr::IEnumAttributeMetaInfo::GetValueDescription()
virtual QString iattr::CEnumAttributeMetaInfo::GetValueDescription ( const iser::IObject value) const
virtual

Gets description of single enumeration.

Parameters
indexindex of enumeration.

Implements iattr::IEnumAttributeMetaInfo.

bool iattr::CEnumAttributeMetaInfo::InsertOption ( const QString &  description,
const iser::IObject valuePtr,
bool  releaseFlag 
)

Insert new enumeration element.

Parameters
descriptionhuman readable description of this enumeration element.
valuePtrvalue of this enumeration element.
releaseFlagif true, the value object will be managed by this object, it means it will be deleted from memory during destruction.
virtual bool iattr::CEnumAttributeMetaInfo::IsAnyValueAllowed ( ) const
virtual

Checks if other then enumerated values are allowed.

If it is enabled option list represents presets only. In this case general constraints can be taken using GetOtherValueConstraints.

Implements iattr::IEnumAttributeMetaInfo.

void iattr::CEnumAttributeMetaInfo::SetOtherValueAllowed ( bool  state)
void iattr::CEnumAttributeMetaInfo::SetUnknownDescription ( const QString &  description)

Set descrition of unknown value;.

See Also
iattr::IEnumAttributeMetaInfo::GetValueDescription()

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

© 2007-2017 Witold Gantzke and Kirill Lepskiy