


XmProcessTraversal(3X)				       XmProcessTraversal(3X)
OSF/Motif							    OSF/Motif



NAME
  XXmmPPrroocceessssTTrraavveerrssaall - A function that determines which	component receives
  keyboard events when a widget	has the	focus

SYNOPSIS


  ##iinncclluuddee <<XXmm//XXmm..hh>>
  BBoooolleeaann XXmmPPrroocceessssTTrraavveerrssaall ((_w_i_d_g_e_t, _d_i_r_e_c_t_i_o_n))
       WWiiddggeett	      _w_i_d_g_e_t;;
       XXmmTTrraavveerrssaallDDiirreeccttiioonn_d_i_r_e_c_t_i_o_n;;

DESCRIPTION
  XXmmPPrroocceessssTTrraavveerrssaall determines	which component	of a hierarchy receives	key-
  board	events when the	hierarchy that contains	the given widget has keyboard
  focus.  Using	XXmmPPrroocceessssTTrraavveerrssaall to traverse to MenuBars, Pulldown Menu-
  Panes, or Popup MenuPanes is not supported.

  _w_i_d_g_e_t      Specifies	the widget ID of the widget whose hierarchy is to be
	      traversed.  The hierarchy	is only	traversed up to	the top	of
	      the shell.  If that shell	does not currently have	the focus,
	      any changes to the element with focus within that	shell will
	      not occur	until the next time the	shell recieves focus.

  _d_i_r_e_c_t_i_o_n   Specifies	the direction of traversal

  The _d_i_r_e_c_t_i_o_n	parameter can have the following values, which cause the rou-
  tine to take the corresponding actions:

    oo++  XXmmTTRRAAVVEERRSSEE__CCUURRRREENNTT-Finds	the hierarchy and the tab group	that contain
       _w_i_d_g_e_t.	If this	tab group is not the active tab	group, makes it	the
       active tab group.  If _w_i_d_g_e_t is an item in the active tab group,	makes
       it the active item.  If _w_i_d_g_e_t is the active tab	group, makes the
       first traversable item in the tab group the active item.

    oo++  XXmmTTRRAAVVEERRSSEE__DDOOWWNN-Finds the hierarchy that	contains _w_i_d_g_e_t.  Finds	the
       active item in the active tab group and makes the item below it the
       active item.  If	there is no item below,	wraps.

    oo++  XXmmTTRRAAVVEERRSSEE__HHOOMMEE-Finds the hierarchy that	contains _w_i_d_g_e_t.  Finds	the
       active item in the active tab group and makes the first traversable
       item in the tab group the active	item.

    oo++  XXmmTTRRAAVVEERRSSEE__LLEEFFTT-Finds the hierarchy that	contains _w_i_d_g_e_t.  Finds	the
       active item in the active tab group and makes the item to the left the
       active item.  If	there is no item to the	left, wraps.

    oo++  XXmmTTRRAAVVEERRSSEE__NNEEXXTT-Finds the hierarchy that	contains _w_i_d_g_e_t.  Finds	the
       active item in the active tab group and makes the next item in child
       order the active	item.

    oo++  XXmmTTRRAAVVEERRSSEE__NNEEXXTT__TTAABB__GGRROOUUPP-Finds the hierarchy that contains _w_i_d_g_e_t.
       Finds the active	tab group (if any) and makes the next tab group	the
       active tab group	in the hierarchy.

    oo++  XXmmTTRRAAVVEERRSSEE__PPRREEVV-Finds the hierarchy that	contains _w_i_d_g_e_t.  Finds	the
       active item in the active tab group and makes the previous item in
       child order the active item.

    oo++  XXmmTTRRAAVVEERRSSEE__PPRREEVV__TTAABB__GGRROOUUPP-Finds the hierarchy that contains _w_i_d_g_e_t.
       Finds the active	tab group (if any) and makes the previous tab group
       the active tab group in the hierarchy.

    oo++  XXmmTTRRAAVVEERRSSEE__RRIIGGHHTT-Finds the hierarchy that contains _w_i_d_g_e_t. Finds	the
       active item in the active tab group and makes the item to the right
       the active item.	 If there is no	item to	the right, wraps.

    oo++  XXmmTTRRAAVVEERRSSEE__UUPP-Finds the hierarchy that contains _w_i_d_g_e_t.	Finds the
       active item in the active tab group and makes the item above it the
       active item.  If	there is no item above,	wraps.

  CAUTIONS


    oo++  XXmmPPrroocceessssTTrraavveerrssaall will not allow traversal to a	widget in a different
       shell.

    oo++  XXmmPPrroocceessssTTrraavveerrssaall will only allow traversal to widgets that are
       currently mapped.

    oo++  You cannot call XXmmPPrroocceessssTTrraavveerrssaall from inside a	focusCallback routine
       (or you will get	a segmentation fault).

RETURN VALUE
  Returns True if the setting succeeded.  Returns False	if the keyboard	focus
  policy is not	XXmmEEXXPPLLIICCIITT, if there are no traversable	items, or if the call
  to the routine has invalid parameters.

RELATED	INFORMATION
  XXmmGGeettVViissiibbiilliittyy((33XX)) and XXmmIIssTTrraavveerrssaabbllee((33XX)).


































