man/XSetPointerMapping.man

   1 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
   2 .\"
   3 .\" Permission is hereby granted, free of charge, to any person obtaining
   4 .\" a copy of this software and associated documentation files (the
   5 .\" "Software"), to deal in the Software without restriction, including
   6 .\" without limitation the rights to use, copy, modify, merge, publish,
   7 .\" distribute, sublicense, and/or sell copies of the Software, and to
   8 .\" permit persons to whom the Software is furnished to do so, subject to
   9 .\" the following conditions:
  10 .\"
  11 .\" The above copyright notice and this permission notice shall be included
  12 .\" in all copies or substantial portions of the Software.
  13 .\"
  14 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  15 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  16 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  17 .\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
  18 .\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  19 .\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  20 .\" OTHER DEALINGS IN THE SOFTWARE.
  21 .\"
  22 .\" Except as contained in this notice, the name of the X Consortium shall
  23 .\" not be used in advertising or otherwise to promote the sale, use or
  24 .\" other dealings in this Software without prior written authorization
  25 .\" from the X Consortium.
  26 .\"
  27 .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
  28 .\" Digital Equipment Corporation
  29 .\"
  30 .\" Portions Copyright \(co 1990, 1991 by
  31 .\" Tektronix, Inc.
  32 .\"
  33 .\" Permission to use, copy, modify and distribute this documentation for
  34 .\" any purpose and without fee is hereby granted, provided that the above
  35 .\" copyright notice appears in all copies and that both that copyright notice
  36 .\" and this permission notice appear in all copies, and that the names of
  37 .\" Digital and Tektronix not be used in in advertising or publicity pertaining
  38 .\" to this documentation without specific, written prior permission.
  39 .\" Digital and Tektronix makes no representations about the suitability
  40 .\" of this documentation for any purpose.
  41 .\" It is provided ``as is'' without express or implied warranty.
  42 .\"
  43 .\"
  44 .ds xT X Toolkit Intrinsics \- C Language Interface
  45 .ds xW Athena X Widgets \- C Language X Toolkit Interface
  46 .ds xL Xlib \- C Language X Interface
  47 .ds xC Inter-Client Communication Conventions Manual
  48 .na
  49 .de Ds
  50 .nf
  51 .\\$1D \\$2 \\$1
  52 .ft 1
  53 .\".ps \\n(PS
  54 .\".if \\n(VS>=40 .vs \\n(VSu
  55 .\".if \\n(VS<=39 .vs \\n(VSp
  56 ..
  57 .de De
  58 .ce 0
  59 .if \\n(BD .DF
  60 .nr BD 0
  61 .in \\n(OIu
  62 .if \\n(TM .ls 2
  63 .sp \\n(DDu
  64 .fi
  65 ..
  66 .de FD
  67 .LP
  68 .KS
  69 .TA .5i 3i
  70 .ta .5i 3i
  71 .nf
  72 ..
  73 .de FN
  74 .fi
  75 .KE
  76 .LP
  77 ..
  78 .de IN          \" send an index entry to the stderr
  79 ..
  80 .de C{
  81 .KS
  82 .nf
  83 .D
  84 .\"
  85 .\"     choose appropriate monospace font
  86 .\"     the imagen conditional, 480,
  87 .\"     may be changed to L if LB is too
  88 .\"     heavy for your eyes...
  89 .\"
  90 .ie "\\*(.T"480" .ft L
  91 .el .ie "\\*(.T"300" .ft L
  92 .el .ie "\\*(.T"202" .ft PO
  93 .el .ie "\\*(.T"aps" .ft CW
  94 .el .ft R
  95 .ps \\n(PS
  96 .ie \\n(VS>40 .vs \\n(VSu
  97 .el .vs \\n(VSp
  98 ..
  99 .de C}
 100 .DE
 101 .R
 102 ..
 103 .de Pn
 104 .ie t \\$1\fB\^\\$2\^\fR\\$3
 105 .el \\$1\fI\^\\$2\^\fP\\$3
 106 ..
 107 .de ZN
 108 .ie t \fB\^\\$1\^\fR\\$2
 109 .el \fI\^\\$1\^\fP\\$2
 110 ..
 111 .de hN
 112 .ie t <\fB\\$1\fR>\\$2
 113 .el <\fI\\$1\fP>\\$2
 114 ..
 115 .de NT
 116 .ne 7
 117 .ds NO Note
 118 .if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
 119 .if \\n(.$ .if !'\\$1'C' .ds NO \\$1
 120 .ie n .sp
 121 .el .sp 10p
 122 .TB
 123 .ce
 124 \\*(NO
 125 .ie n .sp
 126 .el .sp 5p
 127 .if '\\$1'C' .ce 99
 128 .if '\\$2'C' .ce 99
 129 .in +5n
 130 .ll -5n
 131 .R
 132 ..
 133 .               \" Note End -- doug kraft 3/85
 134 .de NE
 135 .ce 0
 136 .in -5n
 137 .ll +5n
 138 .ie n .sp
 139 .el .sp 10p
 140 ..
 141 .ny0
 142 .TH XSetPointerMapping __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
 143 .SH NAME
 144 XSetPointerMapping, XGetPointerMapping \- manipulate pointer settings
 145 .SH SYNTAX
 146 .HP
 147 int XSetPointerMapping\^(\^Display *\fIdisplay\fP\^, unsigned char
 148 \fImap\fP\^[]\^, int \fInmap\fP\^);
 149 .HP
 150 int XGetPointerMapping\^(\^Display *\fIdisplay\fP\^, unsigned char
 151 \fImap_return\fP\^[]\^, int \fInmap\fP\^);
 152 .SH ARGUMENTS
 153 .IP \fIdisplay\fP 1i
 154 Specifies the connection to the X server.
 155 .IP \fImap\fP 1i
 156 Specifies the mapping list.
 157 .IP \fImap_return\fP 1i
 158 Returns the mapping list.
 159 .IP \fInmap\fP 1i
 160 Specifies the number of items in the mapping list.
 161 .SH DESCRIPTION
 162 The
 163 .ZN XSetPointerMapping
 164 function sets the mapping of the pointer.
 165 If it succeeds, the X server generates a
 166 .ZN MappingNotify
 167 event, and
 168 .ZN XSetPointerMapping
 169 returns
 170 .ZN MappingSuccess .
 171 Element map[i] defines the logical button number for the physical button
 172 i+1.
 173 The length of the list must be the same as
 174 .ZN XGetPointerMapping
 175 would return,
 176 or a
 177 .ZN BadValue
 178 error results.
 179 A zero element disables a button, and elements are not restricted in
 180 value by the number of physical buttons.
 181 However, no two elements can have the same nonzero value,
 182 or a
 183 .ZN BadValue
 184 error results.
 185 If any of the buttons to be altered are logically in the down state,
 186 .ZN XSetPointerMapping
 187 returns
 188 .ZN MappingBusy ,
 189 and the mapping is not changed.
 190 .LP
 191 .ZN XSetPointerMapping
 192 can generate a
 193 .ZN BadValue
 194 error.
 195 .LP
 196 The
 197 .ZN XGetPointerMapping
 198 function returns the current mapping of the pointer.
 199 Pointer buttons are numbered starting from one.
 200 .ZN XGetPointerMapping
 201 returns the number of physical buttons actually on the pointer.
 202 The nominal mapping for a pointer is map[i]=i+1.
 203 The nmap argument specifies the length of the array where the pointer
 204 mapping is returned, and only the first nmap elements are returned
 205 in map_return.
 206 .SH DIAGNOSTICS
 207 .TP 1i
 208 .ZN BadValue
 209 Some numeric value falls outside the range of values accepted by the request.
 210 Unless a specific range is specified for an argument, the full range defined
 211 by the argument's type is accepted.  Any argument defined as a set of
 212 alternatives can generate this error.
 213 .SH "SEE ALSO"
 214 XChangeKeyboardControl(__libmansuffix__),
 215 XChangeKeyboardMapping(__libmansuffix__)
 216 .br
 217 \fI\*(xL\fP