XGrabServer(3) XLIB FUNCTIONS XGrabServer(3)NAME
XGrabServer, XUngrabServer - grab the server
SYNTAX
int XGrabServer(Display *display);
int XUngrabServer(Display *display);
ARGUMENTS
display Specifies the connection to the X server.
DESCRIPTION
The XGrabServer function disables processing of requests and close downs on all other connections than the one this request arrived on.
You should not grab the X server any more than is absolutely necessary.
The XUngrabServer function restarts processing of requests and close downs on other connections. You should avoid grabbing the X server as
much as possible.
SEE ALSO XGrabButton(3), XGrabKey(3), XGrabKeyboard(3), XGrabPointer(3)
Xlib - C Language X Interface
X Version 11 libX11 1.6.0 XGrabServer(3)
Check Out this Related Man Page
XGrabKeyboard() XGrabKeyboard()
Name
XGrabKeyboard - grab the keyboard.
Synopsis
int XGrabKeyboard(display, grab_window, owner_events, pointer_mode,
keyboard_mode, time)
Display *display;
Window grab_window;
Bool owner_events;
int pointer_mode, keyboard_mode;
Time time;
Arguments
display Specifies a connection to an X server; returned from XOpenDisplay().
grab_window
Specifies the ID of the window that requires continuous keyboard input.
owner_events
Specifies a boolean value of either True or False. See the "Description" section below.
pointer_mode
Controls processing of pointer events during the grab. Pass either GrabModeSync or GrabModeAsync.
keyboard_mode
Controls processing of keyboard events during the grab. Pass either GrabModeSync or GrabModeAsync.
time Specifies the time when the grab should take place. Pass either a timestamp, expressed in milliseconds, or the constant Current-
Time.
Returns
GrabSuccess on success. AlreadyGrabbed, GrabNotViewable, GrabInvalidTime, or GrabFrozen on failure.
Description
XGrabKeyboard() actively grabs control of the main keyboard. Further key events are reported only to the grabbing client. This request
generates FocusIn and FocusOut events.
XGrabKeyboard() processing is controlled by the value in the owner_events argument:
o If owner_events is False, all generated key events are reported to grab_window.
o If owner_events is True, then if a generated key event would normally be reported to this client, it is reported normally. Otherwise
the event is reported to grab_window.
Both KeyPress and KeyRelease events are always reported, independent of any event selection made by the client.
XGrabKeyboard() processing of pointer events and keyboard events are controlled by pointer_mode and keyboard_mode:
o If the pointer_mode or keyboard_mode is GrabModeAsync, event processing for the respective device continues normally.
o For keyboard_mode GrabModeAsync only: if the keyboard was currently frozen by this client, then processing of keyboard events is
resumed.
o If the pointer_mode or keyboard_mode is GrabModeSync, events for the respective device are queued by the server until a releasing XAl-
lowEvents() request occurs or until the keyboard grab is released as described above.
If the grab is successful, XGrabKeyboard() returns the constant GrabSuccess. XGrabKeyboard() fails under the following conditions and
returns the following:
o If the keyboard is actively grabbed by some other client, it returns AlreadyGrabbed.
o If grab_window is not viewable, it returns GrabNotViewable.
o If time is earlier than the last keyboard grab time or later than the current server time, it returns GrabInvalidTime.
o If the pointer is frozen by an active grab of another client, the request fails with a status GrabFrozen.
If the grab succeeds, the last keyboard grab time is set to the specified time, with CurrentTime replaced by the current X server time.
For more information on grabbing, see Volume One, Chapter 9, The Keyboard and Pointer.
Errors
BadValue
BadWindow
See Also
XChangeActivePointerGrab(), XGrabButton(), XGrabKey(), XGrabPointer(), XGrabServer(), XUngrabButton(), XUngrabKey(), XUngrabKeyboard(),
XUngrabPointer(), XUngrabServer().
Xlib - Grabbing XGrabKeyboard()