man/xkb/XkbGetIndicatorMap.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 XkbGetIndicatorMap __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
  23 .SH NAME
  24 XkbGetIndicatorMap \- Gets the map for one or more indicators, using a mask to
  25 specify the indicators
  26 .SH SYNOPSIS
  27 .HP
  28 .B Status XkbGetIndicatorMap
  29 .BI "(\^Display *" "dpy" "\^,"
  30 .BI "unsigned int " "which" "\^,"
  31 .BI "XkbDescPtr " "desc" "\^);"
  32 .if n .ti +5n
  33 .if t .ti +.5i
  34 .SH ARGUMENTS
  35 .TP
  36 .I \- dpy
  37 connection to the X server
  38 .TP
  39 .I \- which
  40 mask of indicators for which maps should be returned
  41 .TP
  42 .I \- desc
  43 keyboard description to be updated
  44 .SH DESCRIPTION
  45 .LP
  46 Xkb allows applications to obtain information about indicators using two
  47 different methods. The first method, which is similar to the core X
  48 implementation, uses a mask to specify the indicators. The second method, which
  49 is more suitable for applications concerned with interoperability, uses
  50 indicator names. The correspondence between the indicator name and the bit
  51 position in masks is as follows: one of the parameters returned from
  52 .I XkbGetNamedIndicators
  53 is an index that is the bit position to use in any function call that requires a
  54 mask of indicator bits, as well as the indicator's index into the
  55 XkbIndicatorRec array of indicator maps.
  56
  57
  58 .I XkbGetIndicatorMap
  59 obtains the maps from the server for only those indicators specified by the
  60 .I which
  61 mask and copies the values into the keyboard description specified by
  62 .I desc.
  63 If the
  64 .I indicators
  65 field of the
  66 .I desc
  67 parameter is NULL,
  68 .I XkbGetIndicatorMap
  69 allocates and initializes it.
  70
  71 To free the indicator maps, use
  72 .I XkbFreeIndicatorMaps.
  73 .SH DIAGNOSTICS
  74 .TP 15
  75 .B BadAlloc
  76 Unable to allocate storage
  77 .TP 15
  78 .B BadMatch
  79 A compatible version of Xkb was not available in the server or an argument has
  80 correct type and range, but is otherwise invalid
  81 .TP 15
  82 .B BadImplementation
  83 Invalid reply from server
  84 .SH "SEE ALSO"
  85 .BR XkbFreeIndicatorMaps (__libmansuffix__),
  86 .BR XkbGetNamedIndicators (__libmansuffix__)
  87