Merge branch 'master' of ssh://tz.otcshare.org/profile/base/libXi
[platform/upstream/libXi.git] / man / XChangeDeviceDontPropagateList.txt
1 XCHANGEDEVICEDONTPROPAGATELIST(libmansuffix)
2 ============================================
3
4 NAME
5 ----
6
7    XChangeDeviceDontPropagateList, XGetDeviceDontPropagateList -
8    query or change the dont-propagate-list for extension devices
9
10 SYNOPSIS
11 --------
12
13    #include <X11/extensions/XInput.h>
14
15    int XChangeDeviceDontPropagateList( Display *display,
16                                        Window window,
17                                        int count,
18                                        XEventClass *event_list,
19                                        int mode);
20
21    XEventClass* XGetDeviceDontPropagateList( Display *display,
22                                              Window window,
23                                              int *count);
24
25    display
26           Specifies the connection to the X server.
27
28    window
29           Specifies the window whose dont-propagate-list is to be
30           queried or modified.
31
32    event_list
33           Specifies a pointer to a list of event classes.
34
35    mode
36           Specifies the mode.You can pass AddToList, or
37           DeleteFromList.
38
39    count
40           Specifies the number of event classes in the list.
41
42 DESCRIPTION
43 -----------
44
45    The XChangeDeviceDontPropagateList request modifies the list of
46    events that should not be propagated to ancestors of the event
47    window. This request allows extension events to be added to or
48    deleted from that list. By default, all events are propagated
49    to ancestor windows. Once modified, the list remains modified
50    for the life of the window. Events are not removed from the
51    list because the client that added them has terminated.
52
53    Suppression of event propagation is not allowed for all input
54    extension events. If a specified event class is one that cannot
55    be suppressed, a BadClass error will result. Events that can be
56    suppressed include DeviceKeyPress, DeviceKeyRelease,
57    DeviceButtonPress, DeviceButtonRelease, DeviceMotionNotify,
58    ProximityIn, and ProximityOut.
59
60    XChangeDeviceDontPropagateList can generate a BadDevice,
61    BadClass, or BadValue error.
62
63    The XGetDeviceDontPropagateList request queries the list of
64    events that should not be propagated to ancestors of the event
65    window.
66
67    XGetDeviceDontPropagateList can generate a BadClass or
68    BadWindow error.
69
70 DIAGNOSTICS
71 -----------
72
73    BadDevice
74           An invalid device was specified. The specified device
75           does not exist or has not been opened by this client via
76           XOpenInputDevice. This error may also occur if some
77           other client has caused the specified device to become
78           the X keyboard or X pointer device via the
79           XChangeKeyboardDevice or XChangePointerDevice requests.
80
81    BadValue
82           Some numeric value falls outside the range of values
83           accepted by the request. Unless a specific range is
84           specified for an argument, the full range defined by the
85           argument's type is accepted. Any argument defined as a
86           set of alternatives can generate this error.
87
88    BadWindow
89           An invalid window id was specified.
90
91    BadClass
92           An invalid event class was specified.