File: XISetClientPointer.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 (69 lines) | stat: -rw-r--r-- 1,955 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
XISETCLIENTPOINTER(libmansuffix)
================================

NAME
----

   XISetClientPointer, XIGetClientPointer - set or get the
   ClientPointer device.

SYNOPSIS
--------

   #include <X11/extensions/XInput2.h>

   XISetClientPointer( Display *display,
                       Window win,
                       int deviceid);
   
   Bool XIGetClientPointer( Display *display,
                            Window win,
                            int *device);

   display
          Specifies the connection to the X server.

   win
          Specifies a window belonging to the client. May be None.

   deviceid
          Specifies the ClientPointer device.

DESCRIPTION
-----------

   The ClientPointer is the device that is percieved to be the
   core pointer for non-XI protocol requests and replies. Each
   time a protocol message needs device-dependent data and the
   device is not explicitly given, the ClientPointer device is
   used to obtain the data. For example, a XQueryPointer request
   will return the coordinates of the ClientPointer.

   XISetClientPointer request sets the ClientPointer device for
   the client that owns the given window. If win is None, the
   requesting client's ClientPointer is set to the device
   specified with deviceid. Only master pointer devices can be set
   as ClientPointer.

   XISetClientPointer and can generate a BadDevice and a BadWindow
   error.

   The XIGetClientPointer request returns the ClientPointer's
   device ID for the client that owns the given window. If win is
   None, the requesting client's ClientPointer is returned.

   win may be a client ID instead of a window.

   XIGetClientPointer can generate a BadWindow error.

DIAGNOSTICS
-----------

   BadDevice
          An invalid device was specified. The device does not
          exist or is not a master pointer device.

   BadWindow
          A value for a Window argument does not name a defined
          window.