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

« back to all changes in this revision

Viewing changes to man/XSetDeviceValuators.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$
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: XSetDVal.man,v 1.3 2000/08/17 19:41:57 cpqbld Exp $
15
 
.ds xL Programming with Xlib
16
 
.TH XSetDeviceValuators __LIB_MAN_SUFFIX__ __xorgversion__ "X FUNCTIONS"
17
 
.SH NAME
 
1
'\" t
 
2
.\"     Title: xsetdevicevaluators
 
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 "XSETDEVICEVALUATORS" "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
XSetDeviceValuators \- initialize the valuators on an extension input device
19
 
.SH SYNTAX
20
 
XSetDeviceValuators\^(\^\fIdisplay\fP, \fIdevice\fP\^, \fIvaluators\fP\^, \fIfirst_valuator\fP\^, \fInum_valuators\fP\^)
21
 
.br
22
 
      Display *\fIdisplay\fP\^;
23
 
.br
24
 
      XDevice *\fIdevice\fP\^; 
25
 
.br
26
 
      int *\fIvaluators\fP\^; 
27
 
.br
28
 
      int \fIfirst_valuator\fP\^; 
29
 
.br
30
 
      int \fInum_valuators\fP\^; 
31
 
.SH ARGUMENTS
32
 
.TP 12
33
 
.I display
34
 
Specifies the connection to the X server.
35
 
.TP 12
36
 
.I device
37
 
Specifies the device whose valuators are to be initialized.
38
 
.TP 12
39
 
.I valuators
40
 
Specifies a pointer to an array of integer values to be used to initialize the
41
 
device valuators.
42
 
.TP 12
43
 
.I first_valuator
44
 
Specifies the first valuator to be set.  Valuators are numbered beginning with
45
 
zero.
46
 
.TP 12
47
 
.I num_valuators
48
 
Specifies the number of valuators to be set.
49
 
.SH DESCRIPTION
50
 
The
51
 
\fIXSetDeviceValuators\fP
52
 
request sets the current values of the valuators of an input device.
53
 
The valuators in the range
54
 
first_valuator to (first_valuator + num_valuators)
55
 
are set to the specified values.  Valuators are numbered beginning with 0.
56
 
Not all input devices support initialization of valuator values.  If this
57
 
request is made to a device that does not support valuators initialization,
58
 
a \fIBadMatch\fP error will occur.
59
 
.LP
60
 
If the request succeeds, a status of Success is returned.  If another
61
 
client has the device grabbed, a status of AlreadyGrabbed is returned.
62
 
.LP
63
 
\fIXSetDeviceValuators\fP
64
 
can generate a \fIBadLength\fP, \fIBadDevice\fP , \fIBadMatch\fP, or 
65
 
\fIBadValue\fP error.
66
 
.SH DIAGNOSTICS
67
 
.TP 12
68
 
\fIBadDevice\fP
69
 
An invalid device was specified.  The specified device does not exist or has 
70
 
not been opened by this client via \fIXOpenInputDevice\fP.
71
 
.TP 12
72
 
\fIBadMatch\fP
73
 
This error may occur if an \fIXSetDeviceValuators\fP request is made 
74
 
specifying a device that has no valuators and reports no axes of motion,
75
 
or if such a request is made specifying a device that does not support
76
 
valuator initialization.
77
 
.TP 12
78
 
\fIBadValue\fP
79
 
An invalid first_valuator or num_valuators values was specified.
80
 
.SH "SEE ALSO"
81
 
.br
82
 
\fI\*(xL\fP
 
23
.SH "SYNOPSIS"
 
24
.sp
 
25
.nf
 
26
#include <X11/extensions/XInput\&.h>
 
27
.fi
 
28
.sp
 
29
.nf
 
30
XSetDeviceValuators( Display *display,
 
31
                     XDevice *device,
 
32
                     int *valuators,
 
33
                     int first_valuator,
 
34
                     int num_valuators);
 
35
.fi
 
36
.sp
 
37
.nf
 
38
display
 
39
       Specifies the connection to the X server\&.
 
40
.fi
 
41
.sp
 
42
.nf
 
43
device
 
44
       Specifies the device whose valuators are to be
 
45
       initialized\&.
 
46
.fi
 
47
.sp
 
48
.nf
 
49
valuators
 
50
       Specifies a pointer to an array of integer values to be
 
51
       used to initialize thedevice valuators\&.
 
52
.fi
 
53
.sp
 
54
.nf
 
55
first_valuator
 
56
       Specifies the first valuator to be set\&. Valuators are
 
57
       numbered beginning withzero\&.
 
58
.fi
 
59
.sp
 
60
.nf
 
61
num_valuators
 
62
       Specifies the number of valuators to be set\&.
 
63
.fi
 
64
.SH "DESCRIPTION"
 
65
.sp
 
66
.if n \{\
 
67
.RS 4
 
68
.\}
 
69
.nf
 
70
The XSetDeviceValuators request sets the current values of the
 
71
valuators of an input device\&. The valuators in the range
 
72
first_valuator to (first_valuator + num_valuators) are set to
 
73
the specified values\&. Valuators are numbered beginning with 0\&.
 
74
Not all input devices support initialization of valuator
 
75
values\&. If this request is made to a device that does not
 
76
support valuators initialization, a BadMatch error will occur\&.
 
77
.fi
 
78
.if n \{\
 
79
.RE
 
80
.\}
 
81
.sp
 
82
.if n \{\
 
83
.RS 4
 
84
.\}
 
85
.nf
 
86
If the request succeeds, a status of Success is returned\&. If
 
87
another client has the device grabbed, a status of
 
88
AlreadyGrabbed is returned\&.
 
89
.fi
 
90
.if n \{\
 
91
.RE
 
92
.\}
 
93
.sp
 
94
.if n \{\
 
95
.RS 4
 
96
.\}
 
97
.nf
 
98
XSetDeviceValuators can generate a BadLength, BadDevice,
 
99
BadMatch, or BadValue error\&.
 
100
.fi
 
101
.if n \{\
 
102
.RE
 
103
.\}
 
104
.SH "DIAGNOSTICS"
 
105
.sp
 
106
.if n \{\
 
107
.RS 4
 
108
.\}
 
109
.nf
 
110
BadDevice
 
111
       An invalid device was specified\&. The specified device
 
112
       does not exist or has not been opened by this client via
 
113
       XOpenInputDevice\&.
 
114
.fi
 
115
.if n \{\
 
116
.RE
 
117
.\}
 
118
.sp
 
119
.if n \{\
 
120
.RS 4
 
121
.\}
 
122
.nf
 
123
BadMatch
 
124
       This error may occur if an XSetDeviceValuators request
 
125
       is made specifying a device that has no valuators and
 
126
       reports no axes of motion, or if such a request is made
 
127
       specifying a device that does not support valuator
 
128
       initialization\&.
 
129
.fi
 
130
.if n \{\
 
131
.RE
 
132
.\}
 
133
.sp
 
134
.if n \{\
 
135
.RS 4
 
136
.\}
 
137
.nf
 
138
BadValue
 
139
       An invalid first_valuator or num_valuators values was
 
140
       specified\&.
 
141
.fi
 
142
.if n \{\
 
143
.RE
 
144
.\}