423 lines
8.1 KiB
HTML
423 lines
8.1 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of XGRABDEVICEBUTTON</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>XGRABDEVICEBUTTON</H1>
|
|
Section: (3)<BR>Updated: 06/19/2019<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
XGrabDeviceButton, XUngrabDeviceButton - grab/ungrab extension input device buttons
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<P>
|
|
<PRE>
|
|
#include <<A HREF="file:///usr/include/X11/extensions/XInput.h">X11/extensions/XInput.h</A>>
|
|
</PRE>
|
|
|
|
<P>
|
|
<PRE>
|
|
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);
|
|
</PRE>
|
|
|
|
<P>
|
|
<PRE>
|
|
int XUngrabDeviceButton( Display *display,
|
|
XDevice *device,
|
|
unsigned int button,
|
|
unsigned int modifiers,
|
|
XDevice* modifier_device,
|
|
Window grab_window);
|
|
</PRE>
|
|
|
|
<P>
|
|
<PRE>
|
|
display
|
|
Specifies the connection to the X server.
|
|
</PRE>
|
|
|
|
<P>
|
|
<PRE>
|
|
device
|
|
Specifies the device that is to be grabbed or released
|
|
</PRE>
|
|
|
|
<P>
|
|
<PRE>
|
|
button
|
|
Specifies the device button that is to be grabbed or
|
|
released or AnyButton.
|
|
</PRE>
|
|
|
|
<P>
|
|
<PRE>
|
|
modifiers
|
|
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.
|
|
</PRE>
|
|
|
|
<P>
|
|
<PRE>
|
|
modifier_device
|
|
specifies the device whose modifiers are to be used. If
|
|
the modifier_device specified is NULL, the X keyboard
|
|
will be used as the modifier_device.
|
|
</PRE>
|
|
|
|
<P>
|
|
<PRE>
|
|
grab_window
|
|
Specifies the grab window.
|
|
</PRE>
|
|
|
|
<P>
|
|
<PRE>
|
|
owner_events
|
|
Specifies a Boolean value that indicates whether the
|
|
device events are to be reported as usual or reported
|
|
with respect to the grab window if selected by the event
|
|
list.
|
|
</PRE>
|
|
|
|
<P>
|
|
<PRE>
|
|
event_count
|
|
Specifies the number of event classes in the event list.
|
|
</PRE>
|
|
|
|
<P>
|
|
<PRE>
|
|
event_list
|
|
Specifies which events are reported to the client.
|
|
</PRE>
|
|
|
|
<P>
|
|
<PRE>
|
|
this_device_mode
|
|
Specifies further processing of events from this
|
|
device. You can pass GrabModeSync or GrabModeAsync.
|
|
</PRE>
|
|
|
|
<P>
|
|
<PRE>
|
|
other_devices_mode
|
|
Specifies further processing of events from all other
|
|
devices. You can pass GrabModeSync or GrabModeAsync.
|
|
</PRE>
|
|
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
<P>
|
|
<DL COMPACT><DT id="1"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
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.
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
<DL COMPACT><DT id="2"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
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).
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
<DL COMPACT><DT id="3"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
Note that the logical state of a device (as seen by client
|
|
applications) may lag the physical state if device event
|
|
processing is frozen.
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
<DL COMPACT><DT id="4"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
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.
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
<DL COMPACT><DT id="5"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
A modifier_device of NULL indicates that the X keyboard is to
|
|
be used as the modifier_device.
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
<DL COMPACT><DT id="6"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
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.
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
<DL COMPACT><DT id="7"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
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.
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
<DL COMPACT><DT id="8"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
A modifier_device of NULL indicates that the X keyboard should
|
|
be used as the modifier_device.
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
<DL COMPACT><DT id="9"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
XUngrabDeviceButton can generate BadDevice, BadMatch, BadValue
|
|
and BadWindow errors.
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<A NAME="lbAE"> </A>
|
|
<H2>DIAGNOSTICS</H2>
|
|
|
|
<P>
|
|
<DL COMPACT><DT id="10"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
BadDevice
|
|
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.
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
<DL COMPACT><DT id="11"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
BadMatch
|
|
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.
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
<DL COMPACT><DT id="12"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
BadValue
|
|
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.
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
<DL COMPACT><DT id="13"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
BadWindow
|
|
A value for a Window argument does not name a defined
|
|
Window.
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<A NAME="lbAF"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<P>
|
|
<DL COMPACT><DT id="14"><DD>
|
|
|
|
|
|
|
|
<PRE>
|
|
<A HREF="/cgi-bin/man/man2html?3+XAllowDeviceEvents">XAllowDeviceEvents</A>(3), <A HREF="/cgi-bin/man/man2html?3+XGrabDevice">XGrabDevice</A>(3), <A HREF="/cgi-bin/man/man2html?3+XGrabDeviceKey">XGrabDeviceKey</A>(3)
|
|
</PRE>
|
|
|
|
</DL>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="15"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="16"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="17"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="18"><A HREF="#lbAE">DIAGNOSTICS</A><DD>
|
|
<DT id="19"><A HREF="#lbAF">SEE ALSO</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:06:01 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|