Merge branch 'master' of ssh://tz.otcshare.org/profile/base/libXi
[platform/upstream/libXi.git] / man / XSetDeviceMode.txt
1 XSETDEVICEMODE(libmansuffix)
2 ============================
3
4 NAME
5 ----
6
7    XSetDeviceMode - change the mode of a device
8
9 SYNOPSIS
10 --------
11
12    #include <X11/extensions/XInput.h>
13
14    XSetDeviceMode( Display *display,
15                    XDevice *device,
16                    int mode);
17
18    display
19           Specifies the connection to the X server.
20
21    device
22           Specifies the device whose mode is to be changed.
23
24    mode
25           Specifies the mode.You can pass Absolute,or Relative.
26
27 DESCRIPTION
28 -----------
29
30    The XSetDeviceMode request changes the mode of an input device
31    that is capable of reporting either absolute positional
32    information or relative motion information. Not all input
33    devices are capable of reporting motion data, and not all are
34    capable of changing modes from Absolute to Relative.
35
36    XSetDeviceMode can generate a BadDevice or BadMode error.
37
38 DIAGNOSTICS
39 -----------
40
41    BadDevice
42           An invalid device was specified. The specified device
43           does not exist or has not been opened by this client via
44           XOpenInputDevice. This error may also occur if some
45           other client has caused the specified device to become
46           the X keyboard or X pointer device via the
47           XChangeKeyboardDevice or XChangePointerDevice requests.
48
49    BadMatch
50           This error may occur if an XSetDeviceMode request is
51           made specifying a device that has no valuators and
52           reports no axes of motion.
53
54    BadMode
55           An invalid mode was specified. This error will also be
56           returned if the specified device is not capable of
57           supporting the XSetDeviceMode request.