man/xkb/XkbKeySymEntry.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 XkbKeySymEntry __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
  23 .SH NAME
  24 XkbKeySymEntry \-  Returns the keysym corresponding to shift level
  25 .I shift
  26 and group
  27 .I grp
  28 from the two-dimensional array of keysyms for the key corresponding to
  29 .I keycode
  30 .SH SYNOPSIS
  31 .HP
  32 .B KeySym XkbKeySymEntry
  33 .BI "(\^XkbDescPtr " "xkb" "\^,"
  34 .BI "KeyCode " "keycode" "\^,"
  35 .BI "int " "shift" "\^,"
  36 .BI "int " "grp" "\^);"
  37 .if n .ti +5n
  38 .if t .ti +.5i
  39 .SH ARGUMENTS
  40 .TP
  41 .I \- xkb
  42 Xkb description of interest
  43 .TP
  44 .I \- keycode
  45 keycode of interest
  46 .TP
  47 .I \- shift
  48 shift level of interest
  49 .TP
  50 .I \- grp
  51 group of interest
  52 .SH DESCRIPTION
  53 .LP
  54 The key width and number of groups associated with a key are used to form a
  55 small two-dimensional array of KeySyms for a key. This array may be different
  56 sizes for different keys. The array for a single key is stored as a linear list,
  57 in row-major order. The arrays for all of the keys are stored in the
  58 .I syms
  59 field of the client map. There is one row for each group associated with a key
  60 and one column for each level. The index corresponding to a given group and
  61 shift level is computed as:
  62 .nf
  63
  64      idx = group_index * key_width + shift_level
  65
  66 .fi
  67 The
  68 .I offset
  69 field of the
  70 .I key_sym_map
  71 entry for a key is used to access the beginning of the array.
  72
  73 .I XkbKeySymEntry
  74 returns the keysym corresponding to shift level
  75 .I shift
  76 and group
  77 .I grp
  78 from the two-dimensional array of keysyms for the key corresponding to
  79 .I keycode.