summaryrefslogtreecommitdiff
path: root/man/XChangeDeviceDontPropagateList.txt
diff options
context:
space:
mode:
authorPeter Hutterer <peter.hutterer@who-t.net>2009-05-15 14:16:31 +1000
committerPeter Hutterer <peter.hutterer@who-t.net>2009-05-18 10:53:35 +1000
commit615545f9cba36ab7732d2325970a7c84b2fa6e8c (patch)
tree925b1d6ee89ae892c1f5ccc3d73cd86c39dd64ed /man/XChangeDeviceDontPropagateList.txt
parent9966ab40b850c780e439f86e165188919f884b64 (diff)
downloadxorg-lib-libXi-615545f9cba36ab7732d2325970a7c84b2fa6e8c.tar.gz
Switch man pages to asciidoc.
The docbook xml is unreadable and unwritable. Switch everything to asciidoc, at least thay we we can write man pages without losing sanity. asciidoc seems to have some issues with __libmansuffix__, so instead we just use libmansuffix (without underscores). The current asciidoc version is buggy for multiple man targets (more than one man page in a single file), so stick a big warning into configure that a patch is required to the the right asciidoc->docbook conversion. Many thanks to Dan Nicholson for the Makefile.am. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Diffstat (limited to 'man/XChangeDeviceDontPropagateList.txt')
-rw-r--r--man/XChangeDeviceDontPropagateList.txt92
1 files changed, 92 insertions, 0 deletions
diff --git a/man/XChangeDeviceDontPropagateList.txt b/man/XChangeDeviceDontPropagateList.txt
new file mode 100644
index 0000000..398ded2
--- /dev/null
+++ b/man/XChangeDeviceDontPropagateList.txt
@@ -0,0 +1,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.