1XWarpPointer(3)                 XLIB FUNCTIONS                 XWarpPointer(3)
2
3
4

NAME

6       XWarpPointer - move pointer
7

SYNTAX

9       int  XWarpPointer(Display  *display,  Window  src_w, Window dest_w, int
10              src_x,  int  src_y,  unsigned  int   src_width,   unsigned   int
11              src_height, int dest_x, int dest_y);
12

ARGUMENTS

14       dest_w    Specifies the destination window or None.
15
16       dest_x
17       dest_y    Specify  the  x and y coordinates within the destination win‐
18                 dow.
19
20       display   Specifies the connection to the X server.
21
22       src_x
23       src_y
24       src_width
25       src_height
26                 Specify a rectangle in the source window.
27
28       src_w     Specifies the source window or None.
29

DESCRIPTION

31       If dest_w is None,  XWarpPointer  moves  the  pointer  by  the  offsets
32       (dest_x,  dest_y)  relative to the current position of the pointer.  If
33       dest_w is a window, XWarpPointer  moves  the  pointer  to  the  offsets
34       (dest_x,  dest_y)  relative to the origin of dest_w.  However, if src_w
35       is a window, the move only takes place if the window src_w contains the
36       pointer and if the specified rectangle of src_w contains the pointer.
37
38       The  src_x  and  src_y coordinates are relative to the origin of src_w.
39       If src_height is zero, it is replaced with the current height of  src_w
40       minus  src_y.   If  src_width  is zero, it is replaced with the current
41       width of src_w minus src_x.
42
43       There is seldom any reason for  calling  this  function.   The  pointer
44       should normally be left to the user.  If you do use this function, how‐
45       ever, it generates events just as if the user had instantaneously moved
46       the  pointer  from  one  position to another.  Note that you cannot use
47       XWarpPointer to move the pointer outside the confine_to  window  of  an
48       active pointer grab.  An attempt to do so will only move the pointer as
49       far as the closest edge of the confine_to window.
50
51       XWarpPointer can generate a BadWindow error.
52

DIAGNOSTICS

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

SEE ALSO

57       XSetInputFocus(3)
58       Xlib - C Language X Interface
59
60
61
62X Version 11                     libX11 1.8.1                  XWarpPointer(3)
Impressum