XmParamAccess Class Reference

Inheritance diagram for XmParamAccess:

List of all members.

Detailed Description

Provide access to parameters delivered along with user interface functions.

It is possible to deliver optional parameters to a user interface function. To determine the number and the values of these parameters, this class provide the following member functions.

The parameters accessible by this class will be made available by using XmFcnParams in user interface specific code.

Public Member Functions

int GetParamNum () const

Supply the number of optional attributes.

bool GetParamAsAtom (int pos, XmAtom &value) const

Supply the value of the parameter pos as an atom.

bool GetParamAsInt (int pos, int &value) const

Supply the value of the parameter pos as an integer.

bool GetParamAsStr (int pos, XmString &value) const

Supply the value of the parameter pos as a string.

const XmID * GetParamAsID (int pos) const

Supply the ID, if the requested parameter is an ID.

Member Function Documentation

bool GetParamAsAtom ( int pos,

XmAtom & value

) const

Supply the value of the parameter pos as an atom.
This is a fast and typesafe way to get the value of an attribute.
Parameters:

pos position of the requested parameter.

value value of the requested attribute.

Returns:
true, if parameter available.

bool GetParamAsInt ( int pos,

int & value

) const

Supply the value of the parameter pos as an integer.
This is a fast and typesafe way to get the value of an attribute.
Parameters:

pos position of the requested parameter.

value value of the requested attribute.

Returns:
true, if parameter available.

bool GetParamAsStr ( int pos,

XmString & value

) const

Supply the value of the parameter pos as a string.

Parameters:

pos position of the requested parameter.

value of the requested attribute.

Returns:
true, if parameter available.

const XmID* GetParamAsID ( int pos ) const

Supply the ID, if the requested parameter is an ID.

Parameters:

pos position of the requested parameter.

Returns:
Pointer to XmID, if parameter available. Otherwise NULL