XmObjLookCx Class Reference

List of all members.

Detailed Description

Context used in XmObject::ObjLook() to set the appearance and behaviour of an object.

The context class is a parameter in XmObject::ObjLook() to handle the appeareance and behaviour of an object in the user interface. By default an object will be represented by its assigned ID string. You can change this behaviour, by making one of the object member datas representing the object in user interface. Alternatively you can use a C string, which will represent the object. Additionally you can specify an icon id, which should be used for an object in a GUI.

Public Types

enum OBJNAME {
  OBJNAME_NONE,
  OBJNAME_PATH,
  OBJNAME_STATIC
}

Specify the way, how the name of an object should determinated. More...

Public Member Functions

OBJNAME GetObjNameType () const

Return type of object name.

const XmPath & GetNamePath () const

Return path, if OBJNAME_PATH ist set.

const char * GetStaticName () const

Return C string pointer, if OBJNAME_STATIC is set.

XmPath & SetNamePath ()

Enable object represantation by referencing a member (see OBJNAME_PATH).

void SetStaticName (const char *name)

Enable object represantation by a given C string (see OBJNAME_STATIC).

Public Attributes

int IconId

Id to an Icon which should be used for the object in a GUI.

Member Enumeration Documentation

enum OBJNAME

Specify the way, how the name of an object should determinated.

Enumeration values:

OBJNAME_NONE No special object name is specified (Object ID will be used).

OBJNAME_PATH Object name will be set by a given path - determine with GetNamePath().

OBJNAME_STATIC Object name name is set by a static C string - determine with GetStaticName().

Member Function Documentation

XmPath& SetNamePath ( ) [inline]

Enable object represantation by referencing a member (see OBJNAME_PATH).
return a path, which could be expanded, by appending the ID of a object member.
// --- XmObject --- void ObjLook (XmObjLookCx& ol) const { ol.SetNamePath () << myns.ATM_MY_INT; }