0679271402fa56f68a86a278c9d7825ebc8b9bcc
[platform/upstream/libXi.git] / man / XSetDeviceMode.man
1 '\" t
2 .\"     Title: xsetdevicemode
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 "XSETDEVICEMODE" "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 XSetDeviceMode \- change the mode of a device
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 #include <X11/extensions/XInput\&.h>
36 .fi
37 .sp
38 .nf
39 XSetDeviceMode( Display *display,
40                 XDevice *device,
41                 int mode);
42 .fi
43 .sp
44 .nf
45 display
46        Specifies the connection to the X server\&.
47 .fi
48 .sp
49 .nf
50 device
51        Specifies the device whose mode is to be changed\&.
52 .fi
53 .sp
54 .nf
55 mode
56        Specifies the mode\&.You can pass Absolute,or Relative\&.
57 .fi
58 .SH "DESCRIPTION"
59 .sp
60 .if n \{\
61 .RS 4
62 .\}
63 .nf
64 The XSetDeviceMode request changes the mode of an input device
65 that is capable of reporting either absolute positional
66 information or relative motion information\&. Not all input
67 devices are capable of reporting motion data, and not all are
68 capable of changing modes from Absolute to Relative\&.
69 .fi
70 .if n \{\
71 .RE
72 .\}
73 .sp
74 .if n \{\
75 .RS 4
76 .\}
77 .nf
78 XSetDeviceMode can generate a BadDevice or BadMode error\&.
79 .fi
80 .if n \{\
81 .RE
82 .\}
83 .SH "DIAGNOSTICS"
84 .sp
85 .if n \{\
86 .RS 4
87 .\}
88 .nf
89 BadDevice
90        An invalid device was specified\&. The specified device
91        does not exist or has not been opened by this client via
92        XOpenInputDevice\&. This error may also occur if some
93        other client has caused the specified device to become
94        the X keyboard or X pointer device via the
95        XChangeKeyboardDevice or XChangePointerDevice requests\&.
96 .fi
97 .if n \{\
98 .RE
99 .\}
100 .sp
101 .if n \{\
102 .RS 4
103 .\}
104 .nf
105 BadMatch
106        This error may occur if an XSetDeviceMode request is
107        made specifying a device that has no valuators and
108        reports no axes of motion\&.
109 .fi
110 .if n \{\
111 .RE
112 .\}
113 .sp
114 .if n \{\
115 .RS 4
116 .\}
117 .nf
118 BadMode
119        An invalid mode was specified\&. This error will also be
120        returned if the specified device is not capable of
121        supporting the XSetDeviceMode request\&.
122 .fi
123 .if n \{\
124 .RE
125 .\}