NAME

XtGrabKeyboard — a function that actively grabs control of the main keyboard.

SYNOPSIS

#include <X11/PassivGrab.h> int XtGrabKeyboard (widget, owner_events, pointer_mode, keyboard_mode, time)
Widgetwidget;
Booleanowner_events;
intpointer_mode;
intkeyboard_mode;
Timetime;

DESCRIPTION

XtGrabKeyboard actively grabs control of the main keyboard.  If the grab is successful, it returns the constant GrabSuccess.  Further key events are reported to the grab widget. 

widgetSpecifies the root widget to the XtGrabKeyboard call.  All key events that would have been dispatched to other subwindows will get dispatched to it subject to owner_events. 

owner_eventsSpecifies if the pointer events are to be reported normally (pass True) or with respect to the grab window if selected by the event mask (pass False). 

pointer_modeSpecifies further processing of pointer events.  You can pass GrabModeSync or GrabModeAsync. 

keyboard_modeSpecifies further processing of keyboard events.  You can pass GrabModeSync or GrabModeAsync. 

timeSpecifies the time.  You can pass either a timestamp, expressed in milliseconds, or CurrentTime. 

RETURN VALUE

Returns the constant GrabSuccess. 

RELATED INFORMATION

XtUngrabKeyboard(3Xm). 

7th Edition