OSF

NAME

XmProcessTraversal — a function that determines which component receives keyboard events when a widget has the focus.

SYNOPSIS

#include <Xm/Xm.h> Boolean XmProcessTraversal (widget, direction)
Widgetwidget;
intdirection;

DESCRIPTION

XmProcessTraversal determines which component of a hierarchy receives keyboard events when the hierarchy that contains the given widget has keyboard focus. 

widgetSpecifies the widget ID of the widget whose hierarchy is to be traversed

directionSpecifies the direction of traversal

The direction parameter can have the following values, which cause the routine to take the corresponding actions:

•XmTRAVERSE_CURRENT — Find the hierarchy that contains widget and the tab group that contains widget.  If this tab group is not the active tab group, make it the active tab group.  If widget is an item in the active tab group, make it the active item.  If widget is the active tab group, make the first traversable item in the tab group the active item. 

•XmTRAVERSE_DOWN — Find the hierarchy that contains widget.  Find the active item in the active tab group and set the item below to be the active item.  If there is no item, wrap. 

•XmTRAVERSE_HOME — Find the hierarchy that contains widget.  Find the active item in the active tab group and set the first traversable item in the tab group to be the active item. 

•XmTRAVERSE_LEFT — Find the hierarchy that contains widget.  Find the active item in the active tab group and set the item to the left to be the active item.  If there is no item, wrap. 

•XmTRAVERSE_NEXT — Find the hierarchy that contains widget.  Find the active item in the active tab group and set the next item to be the active item. 

•XmTRAVERSE_NEXT_TAB_GROUP — Find the hierarchy that contains widget.  Find the active tab group (if any) and set the next tab group to be the active tab group in the hierarchy. 

•XmTRAVERSE_PREV — Find the hierarchy that contains widget.  Find the active item in the active tab group and set the previous item to be the active item. 

•XmTRAVERSE_PREV_TAB_GROUP — Find the hierarchy that contains widget.  Find the active tab group (if any) and set the previous tab group to be the active tab group in the hierarchy. 

•XmTRAVERSE_RIGHT — Find the hierarchy that contains widget.  Find the active item in the active tab group and set the item to the right to be the active item.  If there is no item, wrap. 

•XmTRAVERSE_UP — Find the hierarchy that contains widget.  Find the active item in the active tab group and set the item above to be the active item.  If there is no item, wrap. 

RETURN VALUE

Returns True if the setting succeeded.  Returns False if the keyboard focus policy is not XmEXPLICIT, if there are no traversable items, or if the call to the routine has invalid parameters.