File: XSetDeviceButtonMapping.txt

package info (click to toggle)
libxi 2:1.3-8
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 2,476 kB
  • ctags: 906
  • sloc: sh: 10,500; ansic: 6,600; makefile: 454
file content (97 lines) | stat: -rw-r--r-- 3,317 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
XSETDEVICEBUTTONMAPPING(libmansuffix)
=====================================

NAME
----

   XSetDeviceButtonMapping, XGetDeviceButtonMapping - query or
   change device button mappings

SYNOPSIS
--------

   #include <X11/extensions/XInput.h>

   int XSetDeviceButtonMapping( Display *display,
                                XDevice *device,
                                unsigned char map[],
                                int nmap);

   int XGetDeviceButtonMapping( Display *display,
                                XDevice *device,
                                unsigned char map_return[],
                                int nmap);

   display
          Specifies the connection to the X server.

   device
          Specifies the device whose button mapping is to be
          queried or changed.

   map
          Specifies the mapping list.

   map_return
          Returns the mapping list.

   nmap
          Specifies the number of items in the mapping list.

DESCRIPTION
-----------

   The XSetDeviceButtonMapping request sets the mapping of the
   specified device. If it succeeds, the X server generates a
   DeviceMappingNotify event, and XSetDeviceButtonMapping returns
   MappingSuccess. Element map[i] defines the logical button
   number for the physical button i+1. The length of the list must
   be the same as XGetDeviceButtonMapping would return, or a
   BadValue error results. A zero element disables a button, and
   elements are not restricted in value by the number of physical
   buttons. However, no two elements can have the same nonzero
   value, or a BadValue error results. If any of the buttons to be
   altered are logically in the down state,
   XSetDeviceButtonMapping returns MappingBusy, and the mapping is
   not changed.

   XSetDeviceButtonMapping can generate BadDevice, BadMatch, and
   BadValue errors.

   The XGetDeviceButtonMapping request returns the current mapping
   of the specified device. Buttons are numbered starting from
   one.XGetDeviceButtonMapping returns the number of physical
   buttons actually on the device. The nominal mapping for a
   device is map[i]=i+1. The nmap argument specifies the length of
   the array where the device mapping is returned, and only the
   first nmap elements are returned in map_return.

   XGetDeviceButtonMapping can generate BadDevice or BadMatch
   errors.

DIAGNOSTICS
-----------

   BadDevice
          An invalid device was specified. The specified device
          does not exist or has not been opened by this client via
          XOpenInputDevice. This error may also occur if the
          specified device is the X keyboard or X pointer device.

   BadMatch
          This error may occur if an XGetDeviceButtonMapping or
          XSetDeviceButtonMapping request was made specifying a
          device that has no buttons.

   BadValue
          Some numeric value falls outside the range of values
          accepted by the request. Unless a specific range is
          specified for an argument, the full range defined by the
          argument's type is accepted. Any argument defined as a
          set of alternatives can generate this error.

SEE ALSO
--------

   XChangeDeviceKeyboardControl(libmansuffix), XChangeDeviceKeyMapping(libmansuffix),
   XChangeDeviceModifierMapping(libmansuffix)