File: XQueryDeviceState.txt

package info (click to toggle)
libxi 2:1.3-8
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 2,476 kB
  • ctags: 906
  • sloc: sh: 10,500; ansic: 6,600; makefile: 454
file content (84 lines) | stat: -rw-r--r-- 2,481 bytes parent folder | download | duplicates (6)
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
XQUERYDEVICESTATE(libmansuffix)
===============================

NAME
----

   XQueryDeviceState - query the state of an extension input
   device.

SYNOPSIS
--------

   #include <X11/extensions/XInput.h>

   XDeviceState* 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.