summaryrefslogtreecommitdiff
path: root/man/XISelectEvents.txt
diff options
context:
space:
mode:
Diffstat (limited to 'man/XISelectEvents.txt')
-rw-r--r--man/XISelectEvents.txt75
1 files changed, 75 insertions, 0 deletions
diff --git a/man/XISelectEvents.txt b/man/XISelectEvents.txt
new file mode 100644
index 0000000..a822fb3
--- /dev/null
+++ b/man/XISelectEvents.txt
@@ -0,0 +1,75 @@
+XISELECTEVENTS(libmansuffix)
+============================
+
+NAME
+----
+
+ XISelectEvents - select for XI2 events on the window.
+
+SYNOPSIS
+--------
+
+ #include <X11/extensions/XInput2.h>
+
+ Status XISelectEvents( Display *display,
+ Window win,
+ XIEventMask *masks,
+ int num_masks);
+
+ display
+ Specifies the connection to the X server.
+
+ masks
+ Device event mask.
+
+ num_masks
+ Number of masks in masks.
+
+ win
+ Specifies the window.
+
+DESCRIPTION
+-----------
+
+ XI2 events must be selected using XISelectEvents.
+
+ XISelectEvents sets the event mask for this client on win.
+ Further events are only reported to this client if the event
+ type matches the selected event mask. The masks overrides the
+ previously selected event mask for the given device.
+
+ If deviceid is a valid device, the event mask is selected only
+ for this device. If deviceid is XIAllDevices or
+ XIAllMasterDevices, the event mask is selected for all devices
+ or all master devices, respectively. The effective event mask
+ is the bit-wise OR of the XIAllDevices, XIAllMasterDevices and
+ the respective device's event mask.
+
+ typedef struct {
+ int deviceid;
+ int mask_len;
+ unsigned char* mask;
+ } XIEventMask;
+
+ The mask_len specifies the length of mask in bytes. mask is a
+ binary mask in the form of (1 << event type). deviceid must be
+ either a device or XIAllDevices or XIAllMasterDevices. A client
+ may submit several masks with the same deviceid in one request
+ but only the last mask will be effective.
+
+ XISelectEvents can generate a BadValue, a BadDevice, and a
+ BadWindow error.
+
+DIAGNOSTICS
+-----------
+
+ BadValue
+ A value is outside of the permitted range.
+
+ BadWindow
+ A value for a Window argument does not name a defined
+ window.
+
+ BadDevice
+ An invalid device was specified. The device does not
+ exist.