XmPathInfo Class Reference

Inheritance diagram for XmPathInfo:

List of all members.

Detailed Description

Supply simple access to a path used in some context classes.

Provide simple access to a referenced instance of XmPath, used within a context class. This is an easy way to determine the current, the parent or the child ID relative to the current path position, which is useful in context classes like XmActionCx or XmMemberStateCx.

Public Member Functions

const XmPath & GetPath () const

Return the referenced Path.

int GetCurMemberPos () const

Return the current position within the referenced Path.

XMID CurID () const

Return the current ID.

int CurIDVal (const XmNamespace &ns) const

Return the integer value of an ID.

const XmPathItem * ChildPathItem (int level=1) const

Supply the child XmPathItem relative to the current path position.

XMID ChildID (int level=1) const

Supply the child ID relative to the current path position.

const XmPathItem * MotherPathItem (int level=1) const

Supply the parent XmPathItem relative to the current path position.

XmObject * MotherObj (int level=1) const

Supply the parent object relative to the current path position.

XmObject * FindMother (XMOBJ objID, XmPath &p) const

Search mother object with specified objID.

XmObject * FindMother (XMOBJ objID) const

Search mother object with specified objID.

void GetAbsPath (XmPath &p) const

Create a full path of the referenced path.

Member Function Documentation

int CurIDVal ( const XmNamespace & ns ) const

Return the integer value of an ID.

Parameters:

ns The enclosing namespace to search the current ID.

Returns:
The dedicated int value of an ID. Otherwise -1. Even if the current ID is not in the specified namespace.

const XmPathItem* ChildPathItem ( int level = 1 ) const

Supply the child XmPathItem relative to the current path position.

Parameters:

level Depth relative to the current path position.

Returns:
Pointer to path item, if available. Otherwise NULL.

XMID ChildID ( int level = 1 ) const

Supply the child ID relative to the current path position.

Parameters:

level Depth relative to the current path position.

Returns:
ID of the path item, if available. Otherwise xmn.MA_NULL.

const XmPathItem* MotherPathItem ( int level = 1 ) const

Supply the parent XmPathItem relative to the current path position.

Parameters:

level Level of anchstor relative to the current path position.

Returns:
Pointer to path item, if available. Otherwise NULL.

XmObject* MotherObj ( int level = 1 ) const

Supply the parent object relative to the current path position.

Parameters:

level Level of anchstor relative to the current path position.

Returns:
Pointer to path item, if available. Otherwise NULL.

XmObject* FindMother ( XMOBJ objID,

XmPath & p

) const

Search mother object with specified objID.

Parameters:

objID ID of the mother object to search of current path.

p The path to the mother object, if found.

Returns:
Pointer to mother object if found. Otherwise NULL.

XmObject* FindMother ( XMOBJ objID ) const

Search mother object with specified objID.

Parameters:

objID ID of the mother object to search of current path.

Returns:
Pointer to mother object if found. Otherwise NULL.

void GetAbsPath ( XmPath & p ) const

Create a full path of the referenced path.