XmMan Class Reference

Inheritance diagram for XmMan:

List of all members.

Detailed Description

context class used in XmObject::manage() to connect member data and objects.

This is the base class context for managing various exom features. XmMan is the context parameter in XmObject::manage() to give the application the possibility to assign connections to all subobjects and member data. All connected members can be handled by the exom framework. Theses members have to be connected via calling the different manXxx() functions. within XmObject::manage(). Connected members provide the features described in XmObject.

All classes of the exom framework derived from XmMan are implemented without using global to ensure thread-safety.

More information in section Managing data.

Public Member Functions

void manTime (XmTime32 &time, XMATM ID, int admit=MAN_ATOM)

Connect a data member of type XmTime32 with ID to an object.

void manFlt (xmFlt32 &val, XMATM ID, int admit=MAN_ATOM)

Connect a data member of type xmFlt32 with ID to an object.

void manDbl (xmFlt64 &val, XMATM ID, int admit=MAN_ATOM)

Connect a data member of type xmFlt64 with ID to an object.

void manInt8 (xmInt8 &val, XMATM ID, int admit=MAN_ATOM)

Connect a data member of type xmInt8 with ID to an object.

void manInt16 (xmInt16 &val, XMATM ID, int admit=MAN_ATOM)

Connect a data member of type xmInt16 with ID to an object.

void manInt32 (xmInt32 &val, XMATM ID, int admit=MAN_ATOM)

Connect a data member of type xmInt32 with ID to an object.

void manUInt8 (xmUInt8 &val, XMATM ID, int admit=MAN_ATOM)

Connect a data member of type xmUInt8 with ID to an object.

void manUInt16 (xmUInt16 &val, XMATM ID, int admit=MAN_ATOM)

Connect a data member of type xmUInt16 with ID to an object.

void manUInt32 (xmUInt32 &val, XMATM ID, int admit=MAN_ATOM)

Connect a data member of type xmUInt32 with ID to an object.

void manBool (xmBool &b, XMATM ID, int admit=MAN_ATOM)

Connect a data member of type xmBool with ID to an object.

void manEnum (xmInt32 &e, XMATM ID, const XmEnumList &enumList, int admit=MAN_ATOM)

Connect a enumeration member with the specified ID and enumeration list to an object.

void manBit (xmFlags &flags, int bitNr, XMATM ID, int admit=MAN_ATOM)

Connect a bit from an integer member with ID to an object; use bfm() for bitNr.

void manStr (XmString &str, XMATM ID, int admit=MAN_ATOM)

Connect a data member of type XmString with ID to an object.

void manCStr (char *str, XMATM ID, int admit=MAN_ATOM)

Connect a data member of type char* with ID to an object.

void manByte (XmAByte &data, XMATM ID, int admit=MAN_ATOM)

Connect a data member of type XmAByte with ID to an object.

void manAtm (void *pt, int type, XMATM ID, int admit=MAN_ATOM)

Connect a user defined data member with type and ID to an object.

void manDynObj (XmDynObject &dynObj)

Connect the XmDynObject interface for dynamic member objects.

void manIndex (int admit=MAN_ATOM)

Enable the presentation of the index of array items in user interface.

void manObj (XmObject &o)

Connect a member object to an object.

Private Member Functions

Overridables

virtual void manObjCallback (XmObjectProp &op)

Enable object handling when deriving from XmMan.

virtual void manAtmCallback (XmAtomProp &atomProp)

Enable atom handling when deriving from XmMan.

Member Function Documentation

void manBit ( xmFlags & flags,

int bitNr,

XMATM ID,

int admit = MAN_ATOM

)

Connect a bit from an integer member with ID to an object; use bfm() for bitNr.
A usual implementation looks like:
#define MY_BIT_MASK 0x00080000 // --- XmObject --- void MyClass:: manage (XmMan& m) { m.manBit (MyInt, bfm (MY_BIT_MASK), myns.ATM_MYINT); }

void manStr ( XmString & str,

XMATM ID,

int admit = MAN_ATOM

)

Connect a data member of type XmString with ID to an object.
This function have to be called in XmObject::manage().

void manCStr ( char * str,

XMATM ID,

int admit = MAN_ATOM

)

Connect a data member of type char* with ID to an object.
This data members are read only.

void manAtm ( void * pt,

int type,

XMATM ID,

int admit = MAN_ATOM

)

Connect a user defined data member with type and ID to an object.
User defined Atoms have to be supported by an application specific XmAtomHandler.

void manDynObj ( XmDynObject & dynObj )

Connect the XmDynObject interface for dynamic member objects.
This give the possibility to create and destroy single member objects, which can be handled by simple class pointers.
Parameters:

dynObj Have to implement XmDynObject::CreateDynObj to create a dynamic member object.