man/xkb/XkbTranslateKeySym.man

   1 .\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
   2 .\"
   3 .\" Permission is hereby granted, free of charge, to any person obtaining a
   4 .\" copy of this software and associated documentation files (the "Software"),
   5 .\" to deal in the Software without restriction, including without limitation
   6 .\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
   7 .\" and/or sell copies of the Software, and to permit persons to whom the
   8 .\" Software is furnished to do so, subject to the following conditions:
   9 .\"
  10 .\" The above copyright notice and this permission notice (including the next
  11 .\" paragraph) shall be included in all copies or substantial portions of the
  12 .\" Software.
  13 .\"
  14 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15 .\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16 .\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  17 .\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18 .\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  19 .\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  20 .\" DEALINGS IN THE SOFTWARE.
  21 .\"
  22 .TH XkbTranslateKeySym __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
  23 .SH NAME
  24 XkbTranslateKeySym \- Find the string and symbol associated with a keysym for a
  25 given keyboard state
  26 .SH SYNOPSIS
  27 .HP
  28 .B int XkbTranslateKeySym
  29 .BI "(\^Display *" "dpy" "\^,"
  30 .BI "KeySym *" "sym_inout" "\^,"
  31 .BI "unsigned int " "mods" "\^,"
  32 .BI "char *" "buf" "\^,"
  33 .BI "int " "nbytes" "\^,"
  34 .BI "int *" "extra_rtrn" "\^);"
  35 .if n .ti +5n
  36 .if t .ti +.5i
  37 .SH ARGUMENTS
  38 .TP
  39 .I \- dpy
  40 connection to X server
  41 .TP
  42 .I \- sym_inout
  43 symbol to be translated; result of translation
  44 .TP
  45 .I \- mods
  46 modifiers to apply to sym_inout
  47 .TP
  48 .I \- buf
  49 buffer into which returned string is written
  50 .TP
  51 .I \- nbytes
  52 size of buffer in bytes
  53 .TP
  54 .I \- extra_rtrn
  55 number of bytes overflow
  56 .SH DESCRIPTION
  57 .LP
  58 .I XkbTranslateKeySym
  59 applies the transformations specified in
  60 .I mods
  61 to the symbol specified by
  62 .I sym_inout.
  63 It returns in
  64 .I buf
  65 the string, if any, associated with the keysym for the current locale. If the
  66 transformations in
  67 .I mods
  68 changes the keysym,
  69 .I sym_inout
  70 is updated accordingly. If the string returned is larger than
  71 .I nbytes,
  72 a count of bytes that does not fit into the buffer is returned in
  73 .I extra_rtrn. XkbTranslateKeySym
  74 returns the number of bytes it placed into
  75 .I buf.
  76 .SH "RETURN VALUES"
  77 .TP 15
  78 buf
  79 Returns the string, if any, associated with the keysym for the current locale.
  80
  81