XmReferenceList Class Reference

Inheritance diagram for XmReferenceList:

List of all members.

Detailed Description

Container for paths to objects or object members and additional data.

Additional to the path, each item include the following members:

A string for textual path (exmn.ATM_REFLIST_ITEM_PARAM)
The value of a search result (exmn.ATM_REFLIST_ITEM_VALUE)
The position of a result (exmn.ATM_REFLIST_ITEM_POS)
A flag allow the user to set a marker (exmn.ATM_REFLIST_ITEM_MARK)
A function which trigger the navigation to the destination indicated by the path.

Public Member Functions

void ClearRefList ()

Clear the reference list.

void AddReference (const XmPath &ref, const XmString &path, const char *param, const XmString &rem)

Clear a new reference to the list.

void RefNavigateToPath (const XmPath &p)

Initiate the navigation to the given path.

void SetRefNavigator (XmPathNavigator *navigator)

Set a path navigator, which have to perform the navigation to an item of the reference list.

Overridables - XmObject

XMOBJ ObjectID () const

Return the ID of an object.

void manage (XmMan &m)

Provide the possibility to connect member data and sub objects.

XmArray * GetArray ()

Return an interface pointer to XmArray, if class have container property.

Member Function Documentation

XMOBJ ObjectID ( ) const [inline, virtual]

Return the ID of an object.
The ID give the exom framework the possibility to identify a class derived from XmObject. So all classes derived from XmObject should have their own ID.
Implements XmObject.

void manage ( XmMan & m ) [virtual]

Provide the possibility to connect member data and sub objects.
Member data and sub objects can be connected, by calling the corresponding manXxx functions of XmMan.
Implements XmObject.

XmArray* GetArray ( ) [virtual]

Return an interface pointer to XmArray, if class have container property.
To show the exom framework that a class derived from XmObject is able to act like a container, GetArray() has to return the interface pointer to the conatiner.
Reimplemented from XmObject.