Merge branch 'master' of ssh://tz.otcshare.org/profile/base/libXi
[platform/upstream/libXi.git] / man / XChangeDeviceDontPropagateList.man
1 '\" t
2 .\"     Title: xchangedevicedontpropagatelist
3 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
5 .\"      Date: 09/23/2011
6 .\"    Manual: [FIXME: manual]
7 .\"    Source: [FIXME: source]
8 .\"  Language: English
9 .\"
10 .TH "XCHANGEDEVICEDONTPRO" "libmansuffix" "09/23/2011" "[FIXME: source]" "[FIXME: manual]"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el       .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 XChangeDeviceDontPropagateList, XGetDeviceDontPropagateList \- query or change the dont\-propagate\-list for extension devices
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 #include <X11/extensions/XInput\&.h>
36 .fi
37 .sp
38 .nf
39 int XChangeDeviceDontPropagateList( Display *display,
40                                     Window window,
41                                     int count,
42                                     XEventClass *event_list,
43                                     int mode);
44 .fi
45 .sp
46 .nf
47 XEventClass* XGetDeviceDontPropagateList( Display *display,
48                                           Window window,
49                                           int *count);
50 .fi
51 .sp
52 .nf
53 display
54        Specifies the connection to the X server\&.
55 .fi
56 .sp
57 .nf
58 window
59        Specifies the window whose dont\-propagate\-list is to be
60        queried or modified\&.
61 .fi
62 .sp
63 .nf
64 event_list
65        Specifies a pointer to a list of event classes\&.
66 .fi
67 .sp
68 .nf
69 mode
70        Specifies the mode\&.You can pass AddToList, or
71        DeleteFromList\&.
72 .fi
73 .sp
74 .nf
75 count
76        Specifies the number of event classes in the list\&.
77 .fi
78 .SH "DESCRIPTION"
79 .sp
80 .if n \{\
81 .RS 4
82 .\}
83 .nf
84 The XChangeDeviceDontPropagateList request modifies the list of
85 events that should not be propagated to ancestors of the event
86 window\&. This request allows extension events to be added to or
87 deleted from that list\&. By default, all events are propagated
88 to ancestor windows\&. Once modified, the list remains modified
89 for the life of the window\&. Events are not removed from the
90 list because the client that added them has terminated\&.
91 .fi
92 .if n \{\
93 .RE
94 .\}
95 .sp
96 .if n \{\
97 .RS 4
98 .\}
99 .nf
100 Suppression of event propagation is not allowed for all input
101 extension events\&. If a specified event class is one that cannot
102 be suppressed, a BadClass error will result\&. Events that can be
103 suppressed include DeviceKeyPress, DeviceKeyRelease,
104 DeviceButtonPress, DeviceButtonRelease, DeviceMotionNotify,
105 ProximityIn, and ProximityOut\&.
106 .fi
107 .if n \{\
108 .RE
109 .\}
110 .sp
111 .if n \{\
112 .RS 4
113 .\}
114 .nf
115 XChangeDeviceDontPropagateList can generate a BadDevice,
116 BadClass, or BadValue error\&.
117 .fi
118 .if n \{\
119 .RE
120 .\}
121 .sp
122 .if n \{\
123 .RS 4
124 .\}
125 .nf
126 The XGetDeviceDontPropagateList request queries the list of
127 events that should not be propagated to ancestors of the event
128 window\&.
129 .fi
130 .if n \{\
131 .RE
132 .\}
133 .sp
134 .if n \{\
135 .RS 4
136 .\}
137 .nf
138 XGetDeviceDontPropagateList can generate a BadClass or
139 BadWindow error\&.
140 .fi
141 .if n \{\
142 .RE
143 .\}
144 .SH "DIAGNOSTICS"
145 .sp
146 .if n \{\
147 .RS 4
148 .\}
149 .nf
150 BadDevice
151        An invalid device was specified\&. The specified device
152        does not exist or has not been opened by this client via
153        XOpenInputDevice\&. This error may also occur if some
154        other client has caused the specified device to become
155        the X keyboard or X pointer device via the
156        XChangeKeyboardDevice or XChangePointerDevice requests\&.
157 .fi
158 .if n \{\
159 .RE
160 .\}
161 .sp
162 .if n \{\
163 .RS 4
164 .\}
165 .nf
166 BadValue
167        Some numeric value falls outside the range of values
168        accepted by the request\&. Unless a specific range is
169        specified for an argument, the full range defined by the
170        argument\*(Aqs type is accepted\&. Any argument defined as a
171        set of alternatives can generate this error\&.
172 .fi
173 .if n \{\
174 .RE
175 .\}
176 .sp
177 .if n \{\
178 .RS 4
179 .\}
180 .nf
181 BadWindow
182        An invalid window id was specified\&.
183 .fi
184 .if n \{\
185 .RE
186 .\}
187 .sp
188 .if n \{\
189 .RS 4
190 .\}
191 .nf
192 BadClass
193        An invalid event class was specified\&.
194 .fi
195 .if n \{\
196 .RE
197 .\}