summaryrefslogtreecommitdiff
path: root/man/XChangeDeviceDontPropagateList.txt
blob: 398ded214036e7319ad140efcfb8855f8252d68a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
XCHANGEDEVICEDONTPROPAGATELIST(libmansuffix)
============================================

NAME
----

   XChangeDeviceDontPropagateList, XGetDeviceDontPropagateList -
   query or change the dont-propagate-list for extension devices

SYNOPSIS
--------

   #include <X11/extensions/XInput.h>

   int XChangeDeviceDontPropagateList( Display *display,
                                       Window window,
                                       int count,
                                       XEventClass *event_list,
                                       int mode);

   XEventClass* XGetDeviceDontPropagateList( Display *display,
                                             Window window,
                                             int *count);

   display
          Specifies the connection to the X server.

   window
          Specifies the window whose dont-propagate-list is to be
          queried or modified.

   event_list
          Specifies a pointer to a list of event classes.

   mode
          Specifies the mode.You can pass AddToList, or
          DeleteFromList.

   count
          Specifies the number of event classes in the list.

DESCRIPTION
-----------

   The XChangeDeviceDontPropagateList request modifies the list of
   events that should not be propagated to ancestors of the event
   window. This request allows extension events to be added to or
   deleted from that list. By default, all events are propagated
   to ancestor windows. Once modified, the list remains modified
   for the life of the window. Events are not removed from the
   list because the client that added them has terminated.

   Suppression of event propagation is not allowed for all input
   extension events. If a specified event class is one that cannot
   be suppressed, a BadClass error will result. Events that can be
   suppressed include DeviceKeyPress, DeviceKeyRelease,
   DeviceButtonPress, DeviceButtonRelease, DeviceMotionNotify,
   ProximityIn, and ProximityOut.

   XChangeDeviceDontPropagateList can generate a BadDevice,
   BadClass, or BadValue error.

   The XGetDeviceDontPropagateList request queries the list of
   events that should not be propagated to ancestors of the event
   window.

   XGetDeviceDontPropagateList can generate a BadClass or
   BadWindow error.

DIAGNOSTICS
-----------

   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 some
          other client has caused the specified device to become
          the X keyboard or X pointer device via the
          XChangeKeyboardDevice or XChangePointerDevice requests.

   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.

   BadWindow
          An invalid window id was specified.

   BadClass
          An invalid event class was specified.