man/xkb/XkbSetModActionVMods.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 XkbSetModActionVMods __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
  24 .SH NAME
  25 XkbSetModActionVMods \- Sets the vmods1 and vmods2 fields of act using the vmods
  26 format of an Xkb modifier description
  27 .SH SYNOPSIS
  28 .HP
  29 .B void XkbSetModActionVMods
  30 .BI "(\^XkbAction " "act" "\^,"
  31 .BI "unsigned short " "vmods" "\^);"
  32 .if n .ti +5n
  33 .if t .ti +.5i
  34 .SH ARGUMENTS
  35 .TP
  36 .I \- act
  37 action in which to set vmods
  38 .TP
  39 .I \- vmods
  40 virtual mods to set
  41 .SH DESCRIPTION
  42 .LP
  43 .I XkbSetModActionVMods
  44 sets the
  45 .I vmods1
  46 and
  47 .I vmods2
  48 fields of
  49 .I act
  50 using the
  51 .I vmods
  52 format of an Xkb modifier description.
  53 .SH NOTES
  54 .LP
  55 Despite the fact that the first parameter of these two macros is of type
  56 XkbAction, these macros may be used only with Actions of type XkbModAction and
  57 XkbISOAction.