XGrabDeviceKey man page on BSDOS

Man page or keyword search:  
man Server   6284 pages
apropos Keyword Search (all sections)
Output format
BSDOS logo
[printable version]



XGrabDeviceKey(3X11)	X FUNCTIONS	XGrabDeviceKey(3X11)

NAME
       XGrabDeviceKey,	XUngrabDeviceKey  - grab/ungrab extension
       input device Keys

SYNTAX
       XGrabDeviceKey(display,	device,	    Key,     modifiers,
       modifier_device, grab_window, owner_events,
       event_count,	 event_list,		this_device_mode,
       other_devices_mode)
	     Display *display;
	     XDevice *device;
	     unsigned int Key;
	     unsigned int modifiers;
	     XDevice *modifier_device;
	     Window grab_window;
	     Bool owner_events;
	     unsigned int event_count;
	     XEventClass event_list;
	     int this_device_mode, other_devices_mode;

       XUngrabDeviceKey(display,    device,    Key,    modifiers,
       modifier_device, grab_window)
	     Display *display;
	     XDevice *device;
	     unsigned int Key;
	     unsigned int modifiers;
	     XDevice *modifier_device;
	     Window grab_window;

ARGUMENTS
       display	Specifies the connection to the X server.

       device	Specifies  the device that is to be grabbed or
		   released

       Key	 Specifies the device Key that is to be grabbed
		   or released or AnyKey.

       modifiers   Specifies  the set of keymasks or AnyModifier.
		   The mask is the bitwise inclusive  OR  of  the
		   valid  keymask  bits.   Valid bits are: Shift-
		   Mask,   LockMask,	ControlMask,	Mod1Mask,
		   Mod2Mask, Mod3Mask, Mod4Mask, Mod5Mask.

       modifier_device
		   Specifies the device whose modifiers are to be
		   used.  If a modifier_device of NULL is  speci-
		   fied, the X keyboard will be used as the modi-
		   fier_device.

       grab_window Specifies the grab window.

       owner_events
		   Specifies  a Boolean	 value	that	indicates

X Version 11		Release 6.4				1

XGrabDeviceKey(3X11)	X FUNCTIONS	XGrabDeviceKey(3X11)

		   whether  the device events are to be reported
		   as usual or reported with respect to the  grab
		   window if selected by the event list.

       event_count Specifies  the  number of event classes in the
		   event list.

       event_list  Specifies which device events are reported  to
		   the client.

       this_device_mode
		   Specifies  further  processing  of events from
		   this device. You  can  pass	GrabModeSync  or
		   GrabModeAsync.

       other_devices_mode
		   Specifies  further  processing  of events from
		   other devices.  You can pass GrabModeSync  or
		   GrabModeAsync.

DESCRIPTION
       The XGrabDeviceKey request establishes a passive grab.  In
       the future, the device is actively grabbed (as for  XGrab-
       Device,	the  last-device-grab  time is set to the time at
       which  the  Key	was  pressed  (as  transmitted	in   the
       DeviceKeyPress  event),	and  the  DeviceKeyPress event is
       reported if all of the following conditions are true:

       o    The device is not grabbed, and the specified  key  is
	    logically  pressed	when  the specified modifier keys
	    are logically down, and no	other  keys  or modifier
	    keys are logically down.

       o    The grab_window is an ancestor (or is) the focus win-
	    dow OR the grab window is a descendant of  the  focus
	    window and contains the device.

       o    The confine_to window (if any) is viewable.

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

       The interpretation of the remaining arguments  is  as  for
       XGrabDevice .  The active grab is terminated automatically
       when the logical state of the device has the specified key
       released.

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

       If  the	key is not AnyKey, it must be in the range speci-
       fied by min_keycode and max_keycode  as	returned  by  the
       XListInputDevices  request.   Otherwise, a BadValue error

X Version 11		Release 6.4				2

XGrabDeviceKey(3X11)	X FUNCTIONS	XGrabDeviceKey(3X11)

       results.

       This request overrides all  previous  grabs  by	the  same
       client  on  the same Key/modifier combinations on the same
       window.	A modifier of AnyModifier is equivalent to  issu-
       ing  the grab  request for all possible modifier combina-
       tions (including the combination of no modifiers).  It  is
       not  required  that all modifiers specified have currently
       assigned KeyCodes.  A key of AnyKey is equivalent to issu-
       ing  the request for all possible keys.	Otherwise, it is
       not required that the specified key currently be assigned
       to a physical Key.

       If  a modifier_device of NULL is specified, the X keyboard
       will be used as the modifier_device.

       If some other client has already issued	a  XGrabDeviceKey
       with the same Key/modifier combination on the same window,
       a BadAccess error  results.   When  using  AnyModifier  or
       AnyKey  ,  the  request	fails completely, and a BadAccess
       error results (no grabs are established) if  there  is	a
       conflicting  grab for any combination.  XGrabDeviceKey has
       no effect on an active grab.

       XGrabDeviceKey can generate  BadAccess,	BadClass,  BadDe-
       vice,   BadMatch,  BadValue,  and  BadWindow  errors.   It
       returns Success on successful completion of the request.

       The XUngrabDeviceKey request releases the passive grab for
       a  key/modifier	combination on the specified window if it
       was grabbed by this client.  A modifier of AnyModifier  is
       equivalent  to issuing the ungrab request for all possible
       modifier combinations, including the  combination  of  no
       modifiers.   A  Key of AnyKey is equivalent to issuing the
       request for all possible Keys.	XUngrabDeviceKey  has  no
       effect on an active grab.

       If  a modifier_device of NULL is specified, the X keyboard
       will be used as the modifier_device.

       XUngrabDeviceKey can generate  BadDevice,  BadMatch,  Bad-
       Value and BadWindow errors.

DIAGNOSTICS
       BadDevice   An  invalid	device was specified.  The speci-
		   fied device does not exist  or  has	not  been
		   opened  by  this  client via XOpenInputDevice.
		   This error may also	occur  if  the	specified
		   device  is the X keyboard or X pointer device.

       BadMatch This error  may	 occur	if  an	XGrabDeviceKey
		   request  was made specifying a device that has
		   no keys, or a  modifier  device  that  has  no
		   keys.

X Version 11		Release 6.4				3

XGrabDeviceKey(3X11)	X FUNCTIONS	XGrabDeviceKey(3X11)

       BadValue Some	numeric value falls outside the range of
		   values accepted by the request.  Unless a spe-
		   cific  range is specified for an argument, 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
       XAllowDeviceEvents(3X),
       XGrabDevice(3X),
       XGrabDeviceButton(3X),
       Programming with Xlib

X Version 11		Release 6.4				4

[top]
                             _         _         _ 
                            | |       | |       | |     
                            | |       | |       | |     
                         __ | | __ __ | | __ __ | | __  
                         \ \| |/ / \ \| |/ / \ \| |/ /  
                          \ \ / /   \ \ / /   \ \ / /   
                           \   /     \   /     \   /    
                            \_/       \_/       \_/ 
More information is available in HTML format for server BSDOS

List of man pages available for BSDOS

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net