XmID Class Reference

Inheritance diagram for XmID:

List of all members.

Detailed Description

Base class to identify objects, member data and functions.

ID's are used to identifiy objects, member data and member functions. XmID provide type safe ID handling, when dealing with them. ID are ecspecially used as items within a XmPath to identify objects or members within a complex object hierarchy. There exist three different ID classes derived from XmID:

XmObjID for objects
XmAtmID fot atoms
XmFcnID for funtions

All ID's have to be members within their enclosing XmNamespace. Each member have to be initialized via a call to XmNamespace::SetAtm(), XmNamespace::SetObj() or XmNamespace::SetFcn() in constructor of their namespace.

More information in section Namespace / IDs.

Public Member Functions

const XmString & GetNameID () const

Supply the Name of the ID as a string.

const XmString * GetXmlName () const

Supply the XML name of the ID as a string.

XmID * GetNextID () const

Return the next ID in the enclosing XmNamespace.

XmNamespace & GetNamespace () const

Return the enclosing XmNamespace.

bool operator== (XMID id) const

Compare two ID's on equality.

bool operator!= (XMID id) const

Compare two ID's on inequality.

const XmString * GetLabel (LABEL_TYPE label) const

Return a reference to a XmString containing the specified label of the ID.

const XmString & GetSaveLabel (LABEL_TYPE label) const

Return a reference to a XmString containing the specified label of the ID.

Member Function Documentation

const XmString& GetNameID ( ) const [inline]

Supply the Name of the ID as a string.
All ID names within a XmNamepsace are unique. It is recommended, to set the name euqal to the name of the C++ identifier. This name is dedicated to LABEL_ID.

const XmString* GetXmlName ( ) const [inline]

Supply the XML name of the ID as a string.
The XML Name is dedicated to LABEL_XML.

bool operator== ( XMID id ) const [inline]

Compare two ID's on equality.

Returns:
true, if ID's are equal.

bool operator!= ( XMID id ) const [inline]

Compare two ID's on inequality.

Returns:
true, if ID's are not equal.

const XmString* GetLabel ( LABEL_TYPE label ) const

Return a reference to a XmString containing the specified label of the ID.

Returns:
NULL, if no label exist.

const XmString& GetSaveLabel ( LABEL_TYPE label ) const

Return a reference to a XmString containing the specified label of the ID.

Returns:
a XmString reference in any case. If specified label doesnt exist, GetNameID() will be returned.