man/xkb/XkbLookupKeyBinding.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 XkbLookupKeyBinding __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
  23 .SH NAME
  24 XkbLookupKeyBinding \- Find the string bound to a key by XRebindKeySym
  25 .SH SYNOPSIS
  26 .HP
  27 .B int XkbLookupKeyBinding
  28 .BI "(\^Display *" "dpy" "\^,"
  29 .BI "KeySym " "sym" "\^,"
  30 .BI "unsigned int " "state" "\^,"
  31 .BI "char *" "buf" "\^,"
  32 .BI "int " "nbytes" "\^,"
  33 .BI "int *" "extra_rtrn" "\^);"
  34 .if n .ti +5n
  35 .if t .ti +.5i
  36 .SH ARGUMENTS
  37 .TP
  38 .I \- dpy
  39 connection to server
  40 .TP
  41 .I \- sym
  42 connection to server
  43 .TP
  44 .I \- state
  45 state for which string is to be looked up
  46 .TP
  47 .I \- buf
  48 buffer into which returned string is written
  49 .TP
  50 .I \- nbytes
  51 size of buffer in bytes
  52 .TP
  53 .I \- extra_rtrn
  54 backfilled with number bytes overflow
  55 .SH DESCRIPTION
  56 .LP
  57 .I XkbLookupKeyBinding
  58 is the equivalent of the core
  59 .I XLookupString
  60 function.
  61
  62 .I XRebindKeysym
  63 binds an ASCII string to a specified keysym, so that the string and keysym are
  64 returned when the key is pressed and a specified list of modifiers are also
  65 being held down.
  66 .I XkbLookupKeyBinding
  67 returns in
  68 .I buf
  69 the string associated with the keysym
  70 .I sym
  71 and modifier state
  72 .I state. buf
  73 is NULL terminated unless there's an overflow. If the string returned is larger
  74 than
  75 .I nbytes,
  76 a count of bytes that does not fit into the buffer is returned in
  77 .I extra_rtrn.
  78 .I XkbTranslateKeySym
  79 returns the number of bytes that it placed into
  80 .I buf.
  81 .SH "SEE ALSO"
  82 .BR XkbTranslateKeySym (__libmansuffix__),
  83 .BR XLookupString (__libmansuffix__),
  84 .BR XRebindKeysym (__libmansuffix__)