man/xkb/XkbFindOverlayForKey.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 XkbFindOverlayForKey __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
  23 .SH NAME
  24 XkbFindOverlayForKey \- Find the alternate name by using the primary name for a
  25 key that is part of an overlay
  26 .SH SYNOPSIS
  27 .HP
  28 .B char * XkbFindOverlayForKey
  29 .BI "(\^XkbGeometryPtr " "geom" "\^,"
  30 .BI "XkbSectionPtr " "section" "\^,"
  31 .BI "char *" "under" "\^);"
  32 .if n .ti +5n
  33 .if t .ti +.5i
  34 .SH ARGUMENTS
  35 .TP
  36 .I \- geom
  37 geometry that contains the section
  38 .TP
  39 .I \- section
  40 section to be searched for matching keys
  41 .TP
  42 .I \- under
  43 primary name of the key to be considered
  44 .SH DESCRIPTION
  45 .LP
  46 Keys that can generate multiple keycodes may be associated with multiple names.
  47 Such keys have a primary name and an alternate name.
  48
  49 .I XkbFindOverlayForKey
  50 uses the primary name of the key,
  51 .I under,
  52 to look up the alternate name, which it returns.