man/XStringToKeysym.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 XStringToKeysym __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
 143 .SH NAME
 144 XStringToKeysym, XKeysymToString, XKeycodeToKeysym, XKeysymToKeycode, XConvertCase \- convert keysyms
 145 .SH SYNTAX
 146 .HP
 147 KeySym XStringToKeysym\^(\^char *\fIstring\fP\^);
 148 .HP
 149 char *XKeysymToString\^(\^KeySym \fIkeysym\fP\^);
 150 .HP
 151 KeySym XKeycodeToKeysym\^(\^Display *\fIdisplay\fP\^, KeyCode \fIkeycode\fP\^,
 152 int \fIindex\fP\^);
 153 .HP
 154 KeyCode XKeysymToKeycode\^(\^Display *\fIdisplay\fP\^, KeySym \fIkeysym\fP\^);
 155 .HP
 156 void XConvertCase(\^KeySym \fIkeysym\fP\^, KeySym *\fIlower_return\fP\^,
 157 KeySym *\fIupper_return\fP\^);
 158 .SH ARGUMENTS
 159 .IP \fIdisplay\fP 1i
 160 Specifies the connection to the X server.
 161 .IP \fIindex\fP 1i
 162 Specifies the element of KeyCode vector.
 163 .IP \fIkeycode\fP 1i
 164 Specifies the KeyCode.
 165 .ds Fn searched for or converted
 166 .IP \fIkeysym\fP 1i
 167 Specifies the KeySym that is to be \*(Fn.
 168 .IP \fIlower_return\fP 1i
 169 Returns the lowercase form of keysym, or keysym.
 170 .IP \fIstring\fP 1i
 171 Specifies the name of the KeySym that is to be converted.
 172 .IP \fIupper_return\fP 1i
 173 Returns the uppercase form of keysym, or keysym.
 174 .SH DESCRIPTION
 175 Standard KeySym names are obtained from
 176 .hN X11/keysymdef.h
 177 by removing the XK_ prefix from each name.
 178 KeySyms that are not part of the Xlib standard also may be obtained
 179 with this function.
 180 The set of KeySyms that are available in this manner
 181 and the mechanisms by which Xlib obtains them is implementation-dependent.
 182 .LP
 183 If the KeySym name is not in the Host Portable Character Encoding,
 184 the result is implementation-dependent.
 185 If the specified string does not match a valid KeySym,
 186 .ZN XStringToKeysym
 187 returns
 188 .ZN NoSymbol .
 189 .LP
 190 The returned string is in a static area and must not be modified.
 191 The returned string is in the Host Portable Character Encoding.
 192 If the specified KeySym is not defined,
 193 .ZN XKeysymToString
 194 returns a NULL.
 195 .LP
 196 The
 197 .ZN XKeycodeToKeysym
 198 function uses internal Xlib tables
 199 and returns the KeySym defined for the specified KeyCode and
 200 the element of the KeyCode vector.
 201 If no symbol is defined,
 202 .ZN XKeycodeToKeysym
 203 returns
 204 .ZN NoSymbol .
 205 .ZN XKeycodeToKeysym
 206 predates the XKB extension. If you want to lookup a KeySym while
 207 using XKB you have to use
 208 .ZN XkbKeycodeToKeysym .
 209 .LP
 210 If the specified KeySym is not defined for any KeyCode,
 211 .ZN XKeysymToKeycode
 212 returns zero.
 213 .LP
 214 The
 215 .ZN XConvertCase
 216 function returns the uppercase and lowercase forms of the specified Keysym,
 217 if the KeySym is subject to case conversion;
 218 otherwise, the specified KeySym is returned to both lower_return and
 219 upper_return.
 220 Support for conversion of other than Latin and Cyrillic KeySyms is
 221 implementation-dependent.
 222 .SH "SEE ALSO"
 223 XLookupKeysym(__libmansuffix__)
 224 .br
 225 \fI\*(xL\fP