xgrabkey(3) [hpux man page]

XGrabKey()																XGrabKey()

Name
  XGrabKey - grab a key.

Synopsis
  XGrabKey(display, keycode, modifiers, grab_window, owner_events,
	    pointer_mode, keyboard_mode)
	Display *display;
	int keycode;
	unsigned int modifiers;
	Window grab_window;
	Bool owner_events;
	int pointer_mode, keyboard_mode;

Arguments
  display   Specifies a connection to an X server; returned from XOpenDisplay().

  keycode   Specifies  the  keycode to be grabbed.  It may be a modifier key.  Specifying AnyKey is equivalent to issuing the request for all
	    key codes.

  modifiers Specifies a set of keymasks. This is a bitwise OR of one or more of the  following	symbols:  ShiftMask,  LockMask,  ControlMask,
	    Mod1Mask,  Mod2Mask, Mod3Mask, Mod4Mask, Mod5Mask, or AnyModifier.	AnyModifier is equivalent to issuing the grab key request for
	    all possible modifier combinations (including no modifiers).  All specified modifiers do not need to have currently assigned key-
	    codes.

  grab_window
	    Specifies the window in which the specified key combination will initiate an active grab.

  owner_events
	    Specifies whether the grab window should receive all events (False) or whether the grabbing application should receive all events
	    normally (True).

  pointer_mode
	    Controls processing of pointer events during the grab.  Pass one of these constants:  GrabModeSync or GrabModeAsync.

  keyboard_mode
	    Controls processing of keyboard events during the grab.  Pass one of these constants:  GrabModeSync or GrabModeAsync.

Description
  XGrabKey() establishes a passive grab on the specified keys, such that when the specified key/modifier combination is pressed, the keyboard
  may  be  grabbed, and all keyboard events sent to this application.  More formally, once an XGrabKey() call has been issued on a particular
  key/button combination:

  o  IF the keyboard is not already actively grabbed,

  o  AND the specified key, which itself can be a modifier key, is logically pressed when the specified modifier keys are logically down,

  o  AND no other keys or modifier keys are logically down,

  o  AND EITHER the grab window is an ancestor of (or is) the focus window OR the grab window is a descendent of the focus  window  and  con-
     tains the pointer,

  o  AND a passive grab on the same key combination does not exist on any ancestor of the grab window,

  o  THEN  the	keyboard  is  actively	grabbed,  as for XGrabKeyboard(), the last keyboard grab time is set to the time at which the key was
     pressed (as transmitted in the KeyPress event), and the KeyPress event is reported.

  The active grab is terminated automatically when the specified key is released (independent of the state of the modifier keys).  The KeyRe-
  lease event which terminates the active grab is sent to the grabbing window.

  The pointer_mode and keyboard_mode control the processing of events during the grab.	If either is GrabModeSync, events for that device are
  not sent from the server to Xlib until XAllowEvents() is called to send the events.  If either is GrabModeAsync, events for that device are
  sent normally.

  For more information on grabbing, see Volume One, Chapter 9, The Keyboard and Pointer.

Errors
  BadAccess When  using AnyModifier or AnyKey and another client has grabbed any overlapping combinations.  In this case, no grabs are estab-
	    lished.
	    Another client has issued XGrabKey() for the same key combination in grab_window.

  BadValue  keycode	    is	       not	   in	      the	  range 	between 	min_keycode	    and 	 max_
	    keycode as returned by XDisplayKeycodes().

  BadWindow

See Also
  XChangeActivePointerGrab(),  XGrabButton(),  XGrabKeyboard(),  XGrabPointer(),  XGrabServer(),  XUngrabButton(),  XUngrabKey(), XUngrabKey-
  board(), XUngrabPointer(), XUngrabServer().

Xlib - Grabbing 															XGrabKey()

XGrabKey(3X11)							  XLIB FUNCTIONS						    XGrabKey(3X11)

NAME

       XGrabKey, XUngrabKey - grab keyboard keys

SYNTAX

       XGrabKey(display, keycode, modifiers, grab_window, owner_events, pointer_mode,
		    keyboard_mode)
	     Display *display;
	     int keycode;
	     unsigned int modifiers;
	     Window grab_window;
	     Bool owner_events;
	     int pointer_mode, keyboard_mode;

       XUngrabKey(display, keycode, modifiers, grab_window)
	     Display *display;
	     int keycode;
	     unsigned int modifiers;
	     Window grab_window;

ARGUMENTS

       display	 Specifies the connection to the X server.

       grab_window
		 Specifies the grab window.

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

       keycode	 Specifies the KeyCode or AnyKey.

       modifiers Specifies the set of keymasks or AnyModifier.	The mask is the bitwise inclusive OR of the valid keymask bits.

       owner_events
		 Specifies a Boolean value that indicates whether the keyboard events are to be reported as usual.

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

DESCRIPTION

       The XGrabKey function establishes a passive grab on the keyboard.  In the future, the keyboard is actively grabbed (as for XGrabKeyboard),
       the last-keyboard-grab time is set to the time at which the key was pressed (as transmitted in the KeyPress event), and the KeyPress event
       is reported if all of the following conditions are true:

       o    The keyboard is not grabbed and the specified key (which can itself be a modifier key) is logically pressed when the specified modi-
	    fier keys are logically down, and no other modifier keys are logically down.

       o    Either the grab_window is an ancestor of (or is) the focus window, or the grab_window is a descendant of the focus window and contains
	    the pointer.

       o    A passive grab on the same key combination does not exist on any ancestor of grab_window.

       The interpretation of the remaining arguments is as for XGrabKeyboard.  The active grab is terminated automatically when the logical state
       of the keyboard has the specified key released (independent of the logical state of the modifier keys).

       Note that the logical state of a device (as seen by client applications) may lag the physical state if device event processing is frozen.

       A modifiers argument of AnyModifier is equivalent to issuing the request for all possible modifier combinations (including the combination
       of no modifiers).  It is not required that all modifiers specified have currently assigned KeyCodes.  A keycode argument of AnyKey is
       equivalent to issuing the request for all possible KeyCodes.  Otherwise, the specified keycode must be in the range specified by min_key-
       code and max_keycode in the connection setup, or a BadValue error results.

       If some other client has issued a XGrabKey with the same key combination on the same window, a BadAccess error results.	When using AnyMod-
       ifier or AnyKey, the request fails completely, and a BadAccess error results (no grabs are established) if there is a conflicting grab for
       any combination.

       XGrabKey can generate BadAccess, BadValue, and BadWindow errors.

       The XUngrabKey function releases the key combination on the specified window if it was grabbed by this client.  It has no effect on an
       active grab.  A modifiers of AnyModifier is equivalent to issuing the request for all possible modifier combinations (including the combi-
       nation of no modifiers).  A keycode argument of AnyKey is equivalent to issuing the request for all possible key codes.

       XUngrabKey can generate BadValue and BadWindow error.

DIAGNOSTICS

       BadAccess A client attempted to grab a key/button combination already grabbed by another client.

       BadValue  Some numeric value falls outside the range of values accepted by the request.	Unless a specific range is specified for an argu-
		 ment, the full range defined by the argument's type is accepted.  Any argument defined as a set of alternatives can generate this
		 error.

       BadWindow A value for a Window argument does not name a defined Window.

SEE ALSO

       XAllowAccess(3X11), XGrabButton(3X11), XGrabKeyboard(3X11), XGrabPointer(3X11)
       Xlib - C Language X Interface

X Version 11							    Release 6.6 						    XGrabKey(3X11)