Name

XtGrabPointer — actively grab the pointer. 

Synopsis

int XtGrabPointer(widget, owner_events, event_mask, pointer_mode, keyboard_mode, confine_to, cursor, time)

      Widget widget;
      Boolean owner_events;
      unsigned int event_mask;
      int pointer_mode, keyboard_mode;
      Window confine_to;
      Cursor cursor;
      Time time;

Arguments

widgetSpecifies the widget for whose window the pointer is to be grabbed. 

owner_events
Specifies if the pointer events are to be reported normally within this application (pass True) or only to the grab window (pass False). 

event_mask
Specifies the event mask symbols that can be ORed together.  Only events selected by this mask, plus ButtonPress and ButtonRelease, will be delivered during the grab.  See XSelectInput for a complete list of event masks. 

pointer_mode
Controls further processing of pointer events. Pass either GrabModeSync or GrabModeAsync. 

keyboard_mode
Controls further processing of keyboard events. Pass either GrabModeSync or GrabModeAsync. 

confine_to
Specifies the ID of the window to confine the pointer. One option is None, in which case the pointer is not confined to any window. 

cursorSpecifies the ID of the cursor that is displayed with the pointer during the grab.  One option is None, which causes the cursor to keep its current pattern. 

timeSpecifies the time when the grab request took place.  Pass either a timestamp, expressed in milliseconds (from an event), or the constant CurrentTime. 

Description

If the specified widget is realized, XtGrabPointer calls XGrabPointer specifying the widget’s window as the grab window.  The remaining arguments and return value are exactly as for XGrabPointer.  If the widget is not realized, XGrabPointer immediately returns GrabNotViewable.  No future automatic ungrab is implied by XtGrabPointer. 

See Also

XtAddGrab(1), XtGrabButton(1), XtGrabKey(1), XtGrabKeyboard(1), XtRegisterGrabAction(1), XtUngrabButton(1), XtUngrabKey(1), XtUngrabKeyboard(1), XtUngrabPointer(1).