1XIWARPPOINTER(3) XIWARPPOINTER(3)
2
3
4
6 XIWarpPointer - move a device's pointer.
7
9 #include <X11/extensions/XInput2.h>
10
11 Bool XIWarpPointer( Display *display,
12 int deviceid,
13 Window src_w,
14 Window dest_w,
15 double src_x,
16 double src_y,
17 int src_width,
18 int src_height,
19 double dest_x,
20 double dest_y);
21
22 dest_w
23 Specifies the destination window or None.
24
25 dest_x, dest_y
26 Specify the x and y coordinates within the destination
27 window.
28
29 deviceid
30 Specifies the master pointer device or floating slave
31 device to move.
32
33 display
34 Specifies the connection to the X server.
35
36 src_x, src_y, src_width, src_height
37 Specify a rectangle in the source window.
38
39 src_w
40 Specifies the source window or None.
41
43 If dest_w is None, XIWarpPointer moves the pointer by the
44 offsets (dest_x, dest_y) relative to the current position of
45 the pointer. If dest_w is a window, XIWarpPointer moves the
46 pointer to the offsets (dest_x, dest_y) relative to the origin
47 of dest_w. However, if src_w is a window, the move only takes
48 place if the window src_w contains the pointer and if the
49 specified rectangle of src_w contains the pointer.
50
51 The src_x and src_y coordinates are relative to the origin of
52 src_w. If src_height is zero, it is replaced with the current
53 height of src_w minus src_y. If src_width is zero, it is
54 replaced with the current width of src_w minus src_x.
55
56 There is seldom any reason for calling this function. The
57 pointer should normally be left to the user. If you do use this
58 function, however, it generates events just as if the user had
59 instantaneously moved the pointer from one position to another.
60 Note that you cannot use XIWarpPointer to move the pointer
61 outside the confine_to window of an active pointer grab. An
62 attempt to do so will only move the pointer as far as the
63 closest edge of the confine_to window.
64
65 XIWarpPointer is identical to XWarpPointer but specifies the
66 device explicitly.
67
68 XIWarpPointer can generate a BadDevice and a BadWindow error.
69
71 BadDevice
72 An invalid device was specified. The device does not
73 exist or is not a pointer device.
74
75 BadWindow
76 A value for a Window argument does not name a defined
77 window.
78
80 XWarpPointer(3)
81
82
83
84 03/09/2013 XIWARPPOINTER(3)