Merge branch 'master' of ssh://tz.otcshare.org/profile/base/libXi
[platform/upstream/libXi.git] / man / XChangePointerDevice.man
1 '\" t
2 .\"     Title: xchangepointerdevice
3 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
5 .\"      Date: 09/23/2011
6 .\"    Manual: [FIXME: manual]
7 .\"    Source: [FIXME: source]
8 .\"  Language: English
9 .\"
10 .TH "XCHANGEPOINTERDEVICE" "libmansuffix" "09/23/2011" "[FIXME: source]" "[FIXME: manual]"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el       .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 XChangePointerDevice \- change which device is the X pointer
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 #include <X11/extensions/XInput\&.h>
36 .fi
37 .sp
38 .nf
39 Status XChangePointerDevice( Display *display,
40                              XDevice *device,
41                              int xaxis,
42                              int yaxis);
43 .fi
44 .sp
45 .nf
46 display
47        Specifies the connection to the X server\&.
48 .fi
49 .sp
50 .nf
51 device
52        Specifies the device to be used as the X pointer\&.
53 .fi
54 .sp
55 .nf
56 xaxis
57        Specifies the axis of the device to be used as the X
58        pointer x\-axis\&.
59 .fi
60 .sp
61 .nf
62 yaxis
63        Specifies the axis of the device to be used as the X
64        pointer y\-axis\&.
65 .fi
66 .SH "DESCRIPTION"
67 .sp
68 .if n \{\
69 .RS 4
70 .\}
71 .nf
72 The XChangePointerDevice request causes the server to use the
73 specified device as the X pointer\&. The device must have been
74 opened by the client via XOpenDevice or a BadDevice error will
75 result\&. The device must support input class Valuators or a
76 BadMatch error will result\&. If the implementation does not
77 support use of the specified device as the X pointer, a
78 BadDevice error will result\&.
79 .fi
80 .if n \{\
81 .RE
82 .\}
83 .sp
84 .if n \{\
85 .RS 4
86 .\}
87 .nf
88 If the specified device is grabbed by another client,
89 AlreadyGrabbed is returned\&. If the specified device is frozen
90 by a grab on another device, GrabFrozen is returned\&. If the
91 request is successful, Success is returned\&.
92 .fi
93 .if n \{\
94 .RE
95 .\}
96 .sp
97 .if n \{\
98 .RS 4
99 .\}
100 .nf
101 If the request succeeds, a ChangeDeviceNotify event is sent to
102 all clients that have selected that event\&. A MappingNotify
103 event with request = MappingPointer is sent to all clients\&. The
104 specified device becomes the X pointer, and the old X pointer
105 becomes accessible through the input extension protocol
106 requests\&.
107 .fi
108 .if n \{\
109 .RE
110 .\}
111 .sp
112 .if n \{\
113 .RS 4
114 .\}
115 .nf
116 XChangePointerDevice can generate a BadDevice or a BadMatch
117 error\&.
118 .fi
119 .if n \{\
120 .RE
121 .\}
122 .SH "DIAGNOSTICS"
123 .sp
124 .if n \{\
125 .RS 4
126 .\}
127 .nf
128 BadDevice
129        An invalid device was specified\&. The specified device
130        does not exist, has not been opened by this client via
131        XOpenInputDevice, or is already one of the core X input
132        devices (pointer or keyboard)\&. This error may also occur
133        if the server implementation does not support using the
134        specified device as the X pointer\&.
135 .fi
136 .if n \{\
137 .RE
138 .\}
139 .sp
140 .if n \{\
141 .RS 4
142 .\}
143 .nf
144 BadMatch
145        This error may occur if an XChangePointerDevice request
146        was made specifying a device that has less than two
147        valuators, or specifying a valuator index beyond the
148        range supported by the device\&.
149 .fi
150 .if n \{\
151 .RE
152 .\}
153 .SH "SEE ALSO"
154 .sp
155 .if n \{\
156 .RS 4
157 .\}
158 .nf
159 XChangeKeyboardDevice(libmansuffix)
160 .fi
161 .if n \{\
162 .RE
163 .\}