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

« back to all changes in this revision

Viewing changes to man/XChangePointerDevice.man

  • 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
 
.\"
2
 
.\" $XFree86: xc/doc/man/Xi/XChgPtr.man,v 1.2 2001/01/27 18:20:21 dawes Exp $
3
 
.\"
4
 
.\"
5
 
.\" Copyright ([\d,\s]*) by Hewlett-Packard Company, Ardent Computer, 
6
 
.\" 
7
 
.\" Permission to use, copy, modify, distribute, and sell this documentation 
8
 
.\" for any purpose and without fee is hereby granted, provided that the above
9
 
.\" copyright notice and this permission notice appear in all copies.
10
 
.\" Ardent, and Hewlett-Packard make no representations about the 
11
 
.\" suitability for any purpose of the information in this document.  It is 
12
 
.\" provided \`\`as is'' without express or implied warranty.
13
 
.\" 
14
 
.\" $Xorg: XChgPtr.man,v 1.3 2000/08/17 19:41:56 cpqbld Exp $
15
 
.ds xL Programming With Xlib
16
 
.TH XChangePointerDevice __LIB_MAN_SUFFIX__ __xorgversion__ "X FUNCTIONS"
17
 
.SH NAME
 
1
'\" t
 
2
.\"     Title: xchangepointerdevice
 
3
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 
4
.\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
 
5
.\"      Date: 10/02/2009
 
6
.\"    Manual: [FIXME: manual]
 
7
.\"    Source: [FIXME: source]
 
8
.\"  Language: English
 
9
.\"
 
10
.TH "XCHANGEPOINTERDEVICE" "libmansuffix" "10/02/2009" "[FIXME: source]" "[FIXME: manual]"
 
11
.\" -----------------------------------------------------------------
 
12
.\" * set default formatting
 
13
.\" -----------------------------------------------------------------
 
14
.\" disable hyphenation
 
15
.nh
 
16
.\" disable justification (adjust text to left margin only)
 
17
.ad l
 
18
.\" -----------------------------------------------------------------
 
19
.\" * MAIN CONTENT STARTS HERE *
 
20
.\" -----------------------------------------------------------------
 
21
.SH "NAME"
18
22
XChangePointerDevice \- change which device is the X pointer
19
 
.SH SYNTAX
20
 
.HP
21
 
Status XChangePointerDevice\^(\^Display *\fIdisplay\fP\^, XDevice
22
 
*\fIdevice\fP\^, int \fIxaxis\fP\^, int \fIyaxis\fP\^); 
23
 
.br
24
 
.SH ARGUMENTS
25
 
.TP 12
26
 
.I display
27
 
Specifies the connection to the X server.
28
 
.TP 12
29
 
.I device
30
 
Specifies the device to be used as the X pointer.
31
 
.TP 12
32
 
.I xaxis
33
 
Specifies the axis of the device to be used as the X pointer x-axis.
34
 
.TP 12
35
 
.I yaxis
36
 
Specifies the axis of the device to be used as the X pointer y-axis.
37
 
.SH DESCRIPTION
38
 
The \fIXChangePointerDevice\fP request causes the server to use the specified
39
 
device as the X pointer.  The device must have been opened by the client via
40
 
\fIXOpenDevice\fP or a \fIBadDevice\fP error will result.  The device must
41
 
support input class \fIValuators\fP or a \fIBadMatch\fP error will result.
42
 
If the implementation does not support use of the specified device as the
43
 
X pointer, a \fIBadDevice\fP error will result.
44
 
.LP
45
 
If the specified device is grabbed by another client, \fIAlreadyGrabbed\fP
46
 
is returned.  If the specified device is frozen by a grab on another device,
47
 
\fIGrabFrozen\fP is returned.
48
 
If the request is successful, \fISuccess\fP is returned.
49
 
.LP
50
 
If the request succeeds,
51
 
a \fIChangeDeviceNotify\fP event is sent to all clients that have selected that
52
 
event.  A \fIMappingNotify\fP event with request = \fIMappingPointer\fP is
53
 
sent to all clients.
54
 
The specified device becomes the X pointer, and
55
 
the old X pointer becomes accessible through the input extension
56
 
protocol requests.
57
 
.LP
58
 
\fIXChangePointerDevice\fP can generate a \fIBadDevice\fP or a \fIBadMatch\fP
59
 
error.
60
 
.SH DIAGNOSTICS
61
 
.TP 12
62
 
\fIBadDevice\fP
63
 
An invalid device was specified.  The specified device does not exist, has 
64
 
not been opened by this client via \fIXOpenInputDevice\fP, or is already
65
 
one of the core X input devices (pointer or keyboard).  This error may also
66
 
occur if the server implementation does not support using the specified
67
 
device as the X pointer.
68
 
.TP 12
69
 
\fIBadMatch\fP
70
 
This error may occur if an \fIXChangePointerDevice\fP request was made 
71
 
specifying a device that has less than two valuators, or specifying a 
72
 
valuator index beyond the range supported by the device.
 
23
.SH "SYNOPSIS"
 
24
.sp
 
25
.nf
 
26
#include <X11/extensions/XInput\&.h>
 
27
.fi
 
28
.sp
 
29
.nf
 
30
Status XChangePointerDevice( Display *display,
 
31
                             XDevice *device,
 
32
                             int xaxis,
 
33
                             int yaxis);
 
34
.fi
 
35
.sp
 
36
.nf
 
37
display
 
38
       Specifies the connection to the X server\&.
 
39
.fi
 
40
.sp
 
41
.nf
 
42
device
 
43
       Specifies the device to be used as the X pointer\&.
 
44
.fi
 
45
.sp
 
46
.nf
 
47
xaxis
 
48
       Specifies the axis of the device to be used as the X
 
49
       pointer x\-axis\&.
 
50
.fi
 
51
.sp
 
52
.nf
 
53
yaxis
 
54
       Specifies the axis of the device to be used as the X
 
55
       pointer y\-axis\&.
 
56
.fi
 
57
.SH "DESCRIPTION"
 
58
.sp
 
59
.if n \{\
 
60
.RS 4
 
61
.\}
 
62
.nf
 
63
The XChangePointerDevice request causes the server to use the
 
64
specified device as the X pointer\&. The device must have been
 
65
opened by the client via XOpenDevice or a BadDevice error will
 
66
result\&. The device must support input class Valuators or a
 
67
BadMatch error will result\&. If the implementation does not
 
68
support use of the specified device as the X pointer, a
 
69
BadDevice error will result\&.
 
70
.fi
 
71
.if n \{\
 
72
.RE
 
73
.\}
 
74
.sp
 
75
.if n \{\
 
76
.RS 4
 
77
.\}
 
78
.nf
 
79
If the specified device is grabbed by another client,
 
80
AlreadyGrabbed is returned\&. If the specified device is frozen
 
81
by a grab on another device, GrabFrozen is returned\&. If the
 
82
request is successful, Success is returned\&.
 
83
.fi
 
84
.if n \{\
 
85
.RE
 
86
.\}
 
87
.sp
 
88
.if n \{\
 
89
.RS 4
 
90
.\}
 
91
.nf
 
92
If the request succeeds, a ChangeDeviceNotify event is sent to
 
93
all clients that have selected that event\&. A MappingNotify
 
94
event with request = MappingPointer is sent to all clients\&. The
 
95
specified device becomes the X pointer, and the old X pointer
 
96
becomes accessible through the input extension protocol
 
97
requests\&.
 
98
.fi
 
99
.if n \{\
 
100
.RE
 
101
.\}
 
102
.sp
 
103
.if n \{\
 
104
.RS 4
 
105
.\}
 
106
.nf
 
107
XChangePointerDevice can generate a BadDevice or a BadMatch
 
108
error\&.
 
109
.fi
 
110
.if n \{\
 
111
.RE
 
112
.\}
 
113
.SH "DIAGNOSTICS"
 
114
.sp
 
115
.if n \{\
 
116
.RS 4
 
117
.\}
 
118
.nf
 
119
BadDevice
 
120
       An invalid device was specified\&. The specified device
 
121
       does not exist, has not been opened by this client via
 
122
       XOpenInputDevice, or is already one of the core X input
 
123
       devices (pointer or keyboard)\&. This error may also occur
 
124
       if the server implementation does not support using the
 
125
       specified device as the X pointer\&.
 
126
.fi
 
127
.if n \{\
 
128
.RE
 
129
.\}
 
130
.sp
 
131
.if n \{\
 
132
.RS 4
 
133
.\}
 
134
.nf
 
135
BadMatch
 
136
       This error may occur if an XChangePointerDevice request
 
137
       was made specifying a device that has less than two
 
138
       valuators, or specifying a valuator index beyond the
 
139
       range supported by the device\&.
 
140
.fi
 
141
.if n \{\
 
142
.RE
 
143
.\}
73
144
.SH "SEE ALSO"
74
 
XChangeKeyboardDevice
75
 
.br
76
 
\fI\*(xL\fP
 
145
.sp
 
146
.if n \{\
 
147
.RS 4
 
148
.\}
 
149
.nf
 
150
XChangeKeyboardDevice(libmansuffix)
 
151
.fi
 
152
.if n \{\
 
153
.RE
 
154
.\}