~ubuntu-branches/ubuntu/natty/libxi/natty-201011191114

« back to all changes in this revision

Viewing changes to man/XIWarpPointer.txt

  • Committer: Bazaar Package Importer
  • Author(s): Julien Cristau
  • Date: 2009-11-21 18:39:28 UTC
  • mfrom: (1.1.10 upstream) (0.1.6 experimental)
  • Revision ID: james.westby@ubuntu.com-20091121183928-ek2jwqx3rmhv3zjz
Tags: 2:1.3-1
* Bump Standards-Version to 3.8.3.
* Add build-deps on xmlto and asciidoc to build the manpages.
* New upstream release.

Show diffs side-by-side

added added

removed removed

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