DOC HOME SITE MAP MAN PAGES GNU INFO SEARCH PRINT BOOK
 

XmTrackingEvent(Xm)


XmTrackingEvent -- a Toolkit function that provides a modal interaction

Syntax

#include <Xm/Xm.h>

Widget XmTrackingEvent (widget, cursor, confine_to, event_return) Widget widget; Cursor cursor; Boolean confine_to; XEvent *event_return;

Description

XmTrackingEvent provides a modal interface for selection of a component. It is intended to support context help. The function grabs the pointer and discards succeeding events until BSelect is released or a key is pressed and then released. The function then returns the widget or gadget that contains the pointer when BSelect is released or a key is released.

widget
Specifies the widget ID of a widget to use as the basis of the modal interaction. That is, the widget within which the interaction must occur, usually a top level shell.

cursor
Specifies the cursor to be used for the pointer during the interaction. This is a standard X cursor name.

confine_to
Specifies whether or not the cursor should be confined to widget.

event_return
Returns the ButtonRelease or KeyRelease event that causes the function to return.

Return value

Returns the widget or gadget that contains the pointer when BSelect is released or a key is released. If no widget or gadget contains the pointer, the function returns NULL.

See also

XmTrackingLocate(Xm)
© 2005 The SCO Group, Inc. All rights reserved.
SCO OpenServer Release 6.0.0 -- 26 May 2005