man/xkb/XkbGetKeyVirtualModMap.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 XkbGetKeyVirtualModMap __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
  23 .SH NAME
  24 XkbGetKeyVirtualModMap \- Obtain the virtual modifier map (the vmodmap array)
  25 for a subset of the keys in a keyboard description
  26 .SH SYNOPSIS
  27 .HP
  28 .B Status XkbGetKeyVirtualModMap
  29 .BI "(\^Display *" "dpy" "\^,"
  30 .BI "unsigned int " "first" "\^,"
  31 .BI "unsigned int " "num" "\^,"
  32 .BI "XkbDescPtr " "xkb" "\^);"
  33 .if n .ti +5n
  34 .if t .ti +.5i
  35 .SH ARGUMENTS
  36 .TP
  37 .I \- dpy
  38 connection to server
  39 .TP
  40 .I \- first
  41 keycode of first key to fetch
  42 .TP
  43 .I \- num
  44 number of keys for which virtual mod maps are desired
  45 .TP
  46 .I \- xkb
  47 Xkb description where results will be placed
  48 .SH DESCRIPTION
  49 .LP
  50 .I XkbGetKeyVirutalModmap
  51 sends a request to the server to obtain the virtual modifier mappings for
  52 .I num
  53 keys on the keyboard starting with key
  54 .I first.
  55 It waits for a reply and returns the virtual modifier mappings in the
  56 .I server->vmodmap
  57 array of
  58 .I xkb.
  59 If successful,
  60 .I XkbGetKeyVirtualModMap
  61 returns Success. The
  62 .I xkb
  63 parameter must be a pointer to a valid Xkb keyboard description.
  64
  65 If the
  66 .I server
  67 map in the
  68 .I xkb
  69 parameter has not been allocated,
  70 .I XkbGetKeyVirtualModMap
  71 allocates and initializes it before obtaining the virtual modifier mappings.
  72
  73 If the server does not have a compatible version of Xkb, or the Xkb extension
  74 has not been properly initialized,
  75 .I XkbGetKeyVirtualModMap
  76 returns BadMatch. If
  77 .I num
  78 is less than 1 or greater than XkbMaxKeyCount,
  79 .I XkbGetKeyVirtualModMap
  80 returns BadValue. If any allocation errors occur,
  81 .I XkbGetKeyVirtualModMap
  82 returns BadAlloc.
  83 .SH "RETURN VALUES"
  84 .TP 15
  85 Success
  86 The
  87 .I XkbGetKeyVirutalModmap
  88 function returns Success following a successful reply from the server to obtain
  89 the virtual modifier mappings for
  90 .I num
  91 keys on the keyboard starting with key
  92 .I first.
  93 .SH DIAGNOSTICS
  94 .TP 15
  95 .B BadAlloc
  96 Unable to allocate storage
  97 .TP 15
  98 .B BadMatch
  99 A compatible version of Xkb was not available in the server or an argument has
 100 correct type and range, but is otherwise invalid
 101 .TP 15
 102 .B BadValue
 103 An argument is out of range