man/xkb/XkbKeyType.man

   1 '\" t
   2 .\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
   3 .\"
   4 .\" Permission is hereby granted, free of charge, to any person obtaining a
   5 .\" copy of this software and associated documentation files (the "Software"),
   6 .\" to deal in the Software without restriction, including without limitation
   7 .\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8 .\" and/or sell copies of the Software, and to permit persons to whom the
   9 .\" Software is furnished to do so, subject to the following conditions:
  10 .\"
  11 .\" The above copyright notice and this permission notice (including the next
  12 .\" paragraph) shall be included in all copies or substantial portions of the
  13 .\" Software.
  14 .\"
  15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16 .\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 .\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18 .\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19 .\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20 .\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21 .\" DEALINGS IN THE SOFTWARE.
  22 .\"
  23 .TH XkbKeyType __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
  24 .SH NAME
  25 XkbKeyType \- Obtain the index of a key type or the pointer to a key type
  26 .SH SYNOPSIS
  27 .HP
  28 .B XkbKeyTypePtr XkbKeyType
  29 .BI "(\^XkbDescPtr " "xkb" "\^,"
  30 .BI "KeyCode " "keycode" "\^,"
  31 .BI "int " "group" "\^);"
  32 .if n .ti +5n
  33 .if t .ti +.5i
  34 .SH ARGUMENTS
  35 .TP
  36 .I \- xkb
  37 Xkb description of interest
  38 .TP
  39 .I \- keycode
  40 keycode of interest
  41 .TP
  42 .I \- group
  43 group index
  44 .SH DESCRIPTION
  45 .LP
  46 .I XkbKeyType
  47 returns a pointer to the key type in the
  48 .I types
  49 vector of the client map in
  50 .I xkb
  51 corresponding to the given
  52 .I keycode
  53 and
  54 .I group
  55 index.
  56 .SH STRUCTURES
  57 .LP
  58 .nf
  59
  60 typedef struct {                             /\(** Key Type */
  61         XkbModsRec              mods;           /\(** modifiers used to compute shift level */
  62         unsigned char           num_levels;     /\(** total # shift levels, do not modify directly */
  63         unsigned char           map_count;      /\(** # entries in map, preserve (if non-NULL) */
  64         XkbKTMapEntryPtr        map;            /\(** vector of modifiers for each shift level */
  65         XkbModsPtr              preserve;       /\(** mods to preserve for corresponding map entry */
  66         Atom                    name;           /\(** name of key type */
  67         Atom *                  level_names;    /\(** array of names of each shift level */
  68 } XkbKeyTypeRec, *XkbKeyTypePtr;
  69
  70 .fi