man/xkb/XkbGetKeyTypes.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 XkbGetKeyTypes __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
  24 .SH NAME
  25 XkbGetKeyTypes \- Obtain the list of available key types in the server's
  26 keyboard mapping
  27 .SH SYNOPSIS
  28 .HP
  29 .B Status XkbGetKeyTypes
  30 .BI "(\^Display *" "dpy" "\^,"
  31 .BI "unsigned int " "first" "\^,"
  32 .BI "unsigned int " "num" "\^,"
  33 .BI "XkbDescPtr " "xkb" "\^);"
  34 .if n .ti +5n
  35 .if t .ti +.5i
  36 .SH ARGUMENTS
  37 .TP
  38 .I \- dpy
  39 connection to X server
  40 .TP
  41 .I \- first
  42 index to first type to get, 0 => 1st type
  43 .TP
  44 .I \- num
  45 number of key types to be returned
  46 .TP
  47 .I \- xkb
  48 keyboard description containing client map to update
  49 .SH DESCRIPTION
  50 .LP
  51 .I XkbGetKeyTypes
  52 queries the server for the desired types, waits for a reply, and returns the
  53 desired types in the
  54 .I xkb->map->types.
  55 If successful, it returns Success.
  56
  57 .I XkbGetKeyTypes
  58 returns BadAccess if the Xkb extension has not been properly initialized and
  59 BadValue if the combination of
  60 .I first
  61 and
  62 .I num
  63 results in numbers out of valid range.
  64
  65 .B NOTE:
  66 .I XkbGetKeyTypes
  67 is used to obtain descriptions of the key types themselves, not the key types
  68 bound to individual keys. To obtain the key types bound to an individual key,
  69 refer to the
  70 .I key_sym_map
  71 field of the client map.
  72 .SH DIAGNOSTICS
  73 .TP 15
  74 .B BadAccess
  75 The Xkb extension has not been properly initialized
  76 .TP 15
  77 .B BadValue
  78 An argument is out of range
  79 .SH "SEE ALSO"
  80 .BR XkbKeyType (__libmansuffix__),
  81 .BR XkbKeyTypeIndex (__libmansuffix__)
  82