1c27c18e8SmrgXISETCLIENTPOINTER(libmansuffix)
2c27c18e8Smrg================================
3c27c18e8Smrg
4c27c18e8SmrgNAME
5c27c18e8Smrg----
6c27c18e8Smrg
7c27c18e8Smrg   XISetClientPointer, XIGetClientPointer - set or get the
8c27c18e8Smrg   ClientPointer device.
9c27c18e8Smrg
10c27c18e8SmrgSYNOPSIS
11c27c18e8Smrg--------
12c27c18e8Smrg
13c27c18e8Smrg   #include <X11/extensions/XInput2.h>
14c27c18e8Smrg
15c27c18e8Smrg   XISetClientPointer( Display *display,
16c27c18e8Smrg                       Window win,
17c27c18e8Smrg                       int deviceid);
18c27c18e8Smrg   
19c27c18e8Smrg   Bool XIGetClientPointer( Display *display,
20c27c18e8Smrg                            Window win,
21c27c18e8Smrg                            int *device);
22c27c18e8Smrg
23c27c18e8Smrg   display
24c27c18e8Smrg          Specifies the connection to the X server.
25c27c18e8Smrg
26c27c18e8Smrg   win
27c27c18e8Smrg          Specifies a window belonging to the client. May be None.
28c27c18e8Smrg
29c27c18e8Smrg   deviceid
30c27c18e8Smrg          Specifies the ClientPointer device.
31c27c18e8Smrg
32c27c18e8SmrgDESCRIPTION
33c27c18e8Smrg-----------
34c27c18e8Smrg
3587404ef7Smrg   The ClientPointer is the device that is perceived to be the
36c27c18e8Smrg   core pointer for non-XI protocol requests and replies. Each
37c27c18e8Smrg   time a protocol message needs device-dependent data and the
38c27c18e8Smrg   device is not explicitly given, the ClientPointer device is
39c27c18e8Smrg   used to obtain the data. For example, a XQueryPointer request
40c27c18e8Smrg   will return the coordinates of the ClientPointer.
41c27c18e8Smrg
42c27c18e8Smrg   XISetClientPointer request sets the ClientPointer device for
43c27c18e8Smrg   the client that owns the given window. If win is None, the
44c27c18e8Smrg   requesting client's ClientPointer is set to the device
45c27c18e8Smrg   specified with deviceid. Only master pointer devices can be set
46c27c18e8Smrg   as ClientPointer.
47c27c18e8Smrg
48c27c18e8Smrg   XISetClientPointer and can generate a BadDevice and a BadWindow
49c27c18e8Smrg   error.
50c27c18e8Smrg
51c27c18e8Smrg   The XIGetClientPointer request returns the ClientPointer's
52c27c18e8Smrg   device ID for the client that owns the given window. If win is
53c27c18e8Smrg   None, the requesting client's ClientPointer is returned.
54c27c18e8Smrg
55c27c18e8Smrg   win may be a client ID instead of a window.
56c27c18e8Smrg
57c27c18e8Smrg   XIGetClientPointer can generate a BadWindow error.
58c27c18e8Smrg
59c27c18e8SmrgDIAGNOSTICS
60c27c18e8Smrg-----------
61c27c18e8Smrg
62c27c18e8Smrg   BadDevice
63c27c18e8Smrg          An invalid device was specified. The device does not
64c27c18e8Smrg          exist or is not a master pointer device.
65c27c18e8Smrg
66c27c18e8Smrg   BadWindow
67c27c18e8Smrg          A value for a Window argument does not name a defined
68c27c18e8Smrg          window.
69c27c18e8Smrg
70