XGrabDeviceButton, XUngrabDeviceButton − grab/ungrab extension input device buttons


#include <X11/extensions/XInput.h>

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

int XUngrabDeviceButton( Display *display,
XDevice *device,
unsigned int button,
unsigned int modifiers,
XDevice* modifier_device,
Window grab_window);

Specifies the connection to the X server.

Specifies the device that is to be grabbed or released

Specifies the device button that is to be grabbed or
released or AnyButton.

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

specifies the device whose modifiers are to be used. If
the modifier_devicespecified is NULL, the X keyboard
will be used as the modifier_device.

Specifies the grab window.

Specifies a Boolean value that indicates whether the
deviceevents are to be reported as usual or reported
with respect to the grab windowif selected by the event

Specifies the number of event classes in the event list.

Specifies which events are reported to the client.

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

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


The XGrabDeviceButton request establishes a passive grab. In
the future, the device is actively grabbed (as for XGrabDevice,
the last−grab time is set to the time at which the button was
pressed (as transmitted in the DeviceButtonPress event), and
the DeviceButtonPress event is reported if all of the following
conditions are true:
* The device is not grabbed, and the specified button is
logically pressed when the specified modifier keys are
logically down on the specified modifier device and no
other buttons or modifier keys are logically down.
* 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 contains the device.
* A passive grab on the same button/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 all buttons 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.

This request overrides all previous grabs by the same client on
the same button/modifier combinations on the same window. A
modifiers of AnyModifier is equivalent to issuing the grab
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 button
of AnyButton is equivalent to issuing the request for all
possible buttons. Otherwise, it is not required that the
specified button currently be assigned to a physical button.

A modifier_device of NULL indicates that the X keyboard is to
be used as the modifier_device.

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

XGrabDeviceButton can generate BadClass, BadDevice, BadMatch,
BadValue, and BadWindow errors..P The XUngrabDeviceButton
request releases the passive grab for a button/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 button of
AnyButton is equivalent to issuing the request for all possible
buttons. XUngrabDeviceButton has no effect on an active grab.

A modifier_device of NULL indicates that the X keyboard should
be used as the modifier_device.

XUngrabDeviceButton can generate BadDevice, BadMatch, BadValue
and BadWindow errors.


An invalid device was specified. The specified 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.

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

Some numeric value falls outside the range of values
accepted by the request. Unless a specific 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.

A value for a Window argument does not name a defined


XAllowDeviceEvents(3), XGrabDevice(3), XGrabDeviceKey(3)

More Linux Commands

udisks-tcp-bridge(1) - udisks TCP/IP bridge - Linux man page
This program is used by remote clients to connect to the org.freedesktop.UDisks D-Bus service on the system bus. Users or administrators never needs to start th

snmp_sess_async_send(3) - session functions - Linux man page
These functions define a subset of the API that can be used to manage single SNMP sessions in a multi-threaded application. Except for snmp_sess_session(), thes

pngtopnm(1) - convert a PNG image into a PNM image (ManPage)
This program is part of Netpbm(1) pngtopnm was obsoleted by pngtopam(1) , introduced with Netpbm 10.44 (September 2008). pngtopam is backward compatible with pn

Tk_GetNumMainWindows(3) - functions for querying main window
A main window is a special kind of toplevel window used as the outermost window in an application. If interp is associated with a Tk application then Tk_MainWin

XSelectExtensionEvent(3) - select extension events, get the
The XSelectExtensionEvent request causes the X server to report the events associated with the specified list of event classes. Initially, X will not report any

XISetFocus(3) - set or get the device's focus (Man Page)....
XISetFocus changes the focus of the specified device ans its last-focus-change time. It has no effect if the specified time is earlier than the current last-foc

stap-merge(1) - systemtap per-cpu binary merger (Man Page)
The stap-merge executable applies when the -b option has been used while running a stap script. The -b option will generate files per-cpu, based on the timestam

ncurses6-config(1) - helper script for ncurses libraries....
ncurses6-config.1 - This is a shell script which simplifies configuring applications against a particular set of ncurses libraries. OPTIONS --prefix echos the p

assume_default_colors_sp(3ncurses) - curses screen-pointer e
This implementation can be configured to provide a set of functions which improve the ability to manage multiple screens. This feature can be added to any of th

experimental(3pm) Experimental features made easy (ManPage)
This pragma provides an easy and convenient way to enable or disable experimental features. Every version of perl has some number of features present but consid

ldap_memfree(3) - LDAP memory allocation routines (ManPage)
These routines are used to allocate/deallocate memory used/returned by the LDAP library. ldap_memalloc(), ldap_memcalloc(), ldap_memrealloc(), and ldap_memfree(

mincore(2) - determine whether pages are resident in memory
mincore() returns a vector that indicates whether pages of the calling processs virtual memory are resident in core (RAM), and so will not cause a disk access (

We can't live, work or learn in freedom unless the software we use is free.