man/xkb/XkbLockGroup.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 XkbLockGroup __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
  24 .SH NAME
  25 XkbLockGroup \-  Locks the keysym group
  26 .SH SYNOPSIS
  27 .HP
  28 .B Bool XkbLockGroup
  29 .BI "(\^Display *" "display" "\^,"
  30 .BI "unsigned int " "device_spec" "\^,"
  31 .BI "unsigned int " "group" "\^);"
  32 .if n .ti +5n
  33 .if t .ti +.5i
  34 .SH ARGUMENTS
  35 .TP
  36 .I display
  37 connection to the X server
  38 .TP
  39 .I device_spec
  40 device ID, or XkbUseCoreKbd
  41 .TP
  42 .I group
  43 index of the keysym group to lock
  44 .SH DESCRIPTION
  45 .LP
  46 .I XkbLockGroup
  47 sends a request to the server to lock the specified
  48 .I group
  49 and does not wait for a reply. It returns True if the request was sent and
  50 False otherwise.
  51
  52 Reference the keysym group indices with these symbolic constants:
  53
  54 .TS
  55 c s
  56 l l
  57 l l.
  58 Table 1 Symbolic Group Names
  59 _
  60 Symbolic Name   Value
  61 _
  62 XkbGroup1Index  0
  63 XkbGroup2Index  1
  64 XkbGroup3Index  2
  65 XkbGroup4Index  3
  66 .TE
  67 .SH "RETURN VALUES"
  68 .TP 15
  69 True
  70 The
  71 .I XkbLockGroup
  72 function returns True when a request was sent to the server to lock the
  73 specified
  74 .I group
  75 and does not wait for a reply.
  76 .TP 15
  77 False
  78 The
  79 .I XkbLockGroup
  80 function returns False if the request was not sent.
  81