diff options
author | Peter Hutterer <peter.hutterer@who-t.net> | 2009-05-15 14:16:31 +1000 |
---|---|---|
committer | Peter Hutterer <peter.hutterer@who-t.net> | 2009-05-18 10:53:35 +1000 |
commit | 615545f9cba36ab7732d2325970a7c84b2fa6e8c (patch) | |
tree | 925b1d6ee89ae892c1f5ccc3d73cd86c39dd64ed /man/XQueryDeviceState.txt | |
parent | 9966ab40b850c780e439f86e165188919f884b64 (diff) |
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/XQueryDeviceState.txt')
-rw-r--r-- | man/XQueryDeviceState.txt | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/man/XQueryDeviceState.txt b/man/XQueryDeviceState.txt new file mode 100644 index 0000000..cd9f982 --- /dev/null +++ b/man/XQueryDeviceState.txt @@ -0,0 +1,84 @@ +XQUERYDEVICESTATE(libmansuffix) +=============================== + +NAME +---- + + XQueryDeviceState - query the state of an extension input + device. + +SYNOPSIS +-------- + + #include <X11/extensions/XInput.h> + + int XQueryDeviceState( Display *display, + XDevice *device); + + display + Specifies the connection to the X server. + + device + Specifies the device whose state is to be queried. + +DESCRIPTION +----------- + + The XQueryDeviceState request queries the state of an input + device. The current state of keys and buttons (up or down), and + valuators (current value) on the device is reported by this + request. Each key or button is represented by a bit in the + XDeviceState structure that is returned. Valuators on the + device report 0 if they are reporting relative information, and + the current value if they are reporting absolute information. + + XQueryDeviceState can generate a BadDevice error. + +Structures + + The XDeviceState structure contains: + + typedef struct { + XID device_id; + int num_classes; + XInputClass *data; + } XDeviceState; + + The XValuatorState structure contains: + + typedef struct { + unsigned char class; + unsigned char length; + unsigned char num_valuators; + unsigned char mode; + int *valuators; + } XValuatorState; + + The XKeyState structure contains: + + typedef struct { + unsigned char class; + unsigned char length; + short num_keys; + char keys[32]; + } XKeyState; + + The XButtonState structure contains: + + typedef struct { + unsigned char class; + unsigned char length; + short num_buttons; + char buttons[32]; + } XButtonState; + +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. |