XChangePointerDevice.txt revision c27c18e8
1c27c18e8SmrgXCHANGEPOINTERDEVICE(libmansuffix)
2c27c18e8Smrg==================================
3c27c18e8Smrg
4c27c18e8SmrgNAME
5c27c18e8Smrg----
6c27c18e8Smrg
7c27c18e8Smrg   XChangePointerDevice - change which device is the X pointer
8c27c18e8Smrg
9c27c18e8SmrgSYNOPSIS
10c27c18e8Smrg--------
11c27c18e8Smrg
12c27c18e8Smrg   #include <X11/extensions/XInput.h>
13c27c18e8Smrg
14c27c18e8Smrg   Status XChangePointerDevice( Display *display,
15c27c18e8Smrg                                XDevice *device,
16c27c18e8Smrg                                int xaxis,
17c27c18e8Smrg                                int yaxis);
18c27c18e8Smrg
19c27c18e8Smrg   display
20c27c18e8Smrg          Specifies the connection to the X server.
21c27c18e8Smrg
22c27c18e8Smrg   device
23c27c18e8Smrg          Specifies the device to be used as the X pointer.
24c27c18e8Smrg
25c27c18e8Smrg   xaxis
26c27c18e8Smrg          Specifies the axis of the device to be used as the X
27c27c18e8Smrg          pointer x-axis.
28c27c18e8Smrg
29c27c18e8Smrg   yaxis
30c27c18e8Smrg          Specifies the axis of the device to be used as the X
31c27c18e8Smrg          pointer y-axis.
32c27c18e8Smrg
33c27c18e8SmrgDESCRIPTION
34c27c18e8Smrg-----------
35c27c18e8Smrg
36c27c18e8Smrg   The XChangePointerDevice request causes the server to use the
37c27c18e8Smrg   specified device as the X pointer. The device must have been
38c27c18e8Smrg   opened by the client via XOpenDevice or a BadDevice error will
39c27c18e8Smrg   result. The device must support input class Valuators or a
40c27c18e8Smrg   BadMatch error will result. If the implementation does not
41c27c18e8Smrg   support use of the specified device as the X pointer, a
42c27c18e8Smrg   BadDevice error will result.
43c27c18e8Smrg
44c27c18e8Smrg   If the specified device is grabbed by another client,
45c27c18e8Smrg   AlreadyGrabbed is returned. If the specified device is frozen
46c27c18e8Smrg   by a grab on another device, GrabFrozen is returned. If the
47c27c18e8Smrg   request is successful, Success is returned.
48c27c18e8Smrg
49c27c18e8Smrg   If the request succeeds, a ChangeDeviceNotify event is sent to
50c27c18e8Smrg   all clients that have selected that event. A MappingNotify
51c27c18e8Smrg   event with request = MappingPointer is sent to all clients. The
52c27c18e8Smrg   specified device becomes the X pointer, and the old X pointer
53c27c18e8Smrg   becomes accessible through the input extension protocol
54c27c18e8Smrg   requests.
55c27c18e8Smrg
56c27c18e8Smrg   XChangePointerDevice can generate a BadDevice or a BadMatch
57c27c18e8Smrg   error.
58c27c18e8Smrg
59c27c18e8SmrgDIAGNOSTICS
60c27c18e8Smrg-----------
61c27c18e8Smrg
62c27c18e8Smrg   BadDevice
63c27c18e8Smrg          An invalid device was specified. The specified device
64c27c18e8Smrg          does not exist, has not been opened by this client via
65c27c18e8Smrg          XOpenInputDevice, or is already one of the core X input
66c27c18e8Smrg          devices (pointer or keyboard). This error may also occur
67c27c18e8Smrg          if the server implementation does not support using the
68c27c18e8Smrg          specified device as the X pointer.
69c27c18e8Smrg
70c27c18e8Smrg   BadMatch
71c27c18e8Smrg          This error may occur if an XChangePointerDevice request
72c27c18e8Smrg          was made specifying a device that has less than two
73c27c18e8Smrg          valuators, or specifying a valuator index beyond the
74c27c18e8Smrg          range supported by the device.
75c27c18e8Smrg
76c27c18e8SmrgSEE ALSO
77c27c18e8Smrg--------
78c27c18e8Smrg
79c27c18e8Smrg   XChangeKeyboardDevice(libmansuffix)
80