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