man/xkb/XkbNoteNameChanges.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 XkbNoteNameChanges __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
  24 .SH NAME
  25 XkbNoteNameChanges \- Note the changed names in a changes structure
  26 .SH SYNOPSIS
  27 .HP
  28 .B void XkbNoteNameChanges
  29 .BI "(\^XkbNameChangesPtr " "old" "\^,"
  30 .BI "XkbNamesNotifyEvent *" "new" "\^,"
  31 .BI "unsigned int " "wanted" "\^);"
  32 .if n .ti +5n
  33 .if t .ti +.5i
  34 .SH ARGUMENTS
  35 .TP
  36 .I \- old
  37 XkbNameChanges structure to be updated
  38 .TP
  39 .I \- new
  40 event from which changes are to be copied
  41 .TP
  42 .I \- wanted
  43 types of names for which changes are to be noted
  44 .SH DESCRIPTION
  45 .LP
  46 When your application receives a XkbNamesNotify event, you can note the changed
  47 names in a changes structure using
  48 .I XkbNoteNameChanges.
  49
  50 The
  51 .I wanted
  52 parameter is the bitwise inclusive OR of the valid names mask bits shown in
  53 Table 1.
  54 .I XkbNoteNameChanges
  55 copies any changes that are reported in
  56 .I new
  57 and specified in
  58 .I wanted
  59 into the changes record specified by
  60 .I old.
  61
  62 .TS
  63 c s s s
  64 l l l l.
  65 Table 1 Symbolic Names Masks
  66 _
  67 Mask Bit        Value   Keyboard        Field
  68                 Component
  69 _
  70 XkbKeycodesNameMask     (1<<0)  Xkb->names      keycodes
  71 XkbGeometryNameMask     (1<<1)  Xkb->names      geometry
  72 XkbSymbolsNameMask      (1<<2)  Xkb->names      symbols
  73 XkbPhysSymbolsNameMask  (1<<3)  Xkb->names      phys_symbols
  74 XkbTypesNameMask        (1<<4)  Xkb->names      type
  75 XkbCompatNameMask       (1<<5)  Xkb->names      compat
  76 XkbKeyTypeNamesMask     (1<<6)  Xkb->map        type[*].name
  77 XkbKTLevelNamesMask     (1<<7)  Xkb->map        type[*].lvl_names[*]
  78 XkbIndicatorNamesMask   (1<<8)  Xkb->names      indicators[*]
  79 XkbKeyNamesMask (1<<9)  Xkb->names      keys[*], num_keys
  80 XkbKeyAliasesMask       (1<<10) Xkb->names      key_aliases[*], num_key_aliases
  81 XkbVirtualModNamesMask  (1<<11) Xkb->names      vmods[*]
  82 XkbGroupNamesMask       (1<<12) Xkb->names      groups[*]
  83 XkbRGNamesMask  (1<<13) Xkb->names      radio_groups[*], num_rg
  84 XkbComponentNamesMask   (0x3f)  Xkb->names      keycodes,
  85                         geometry,
  86                         symbols,
  87                         physical symbols,
  88                         types, and
  89                         compatibility map
  90 XkbAllNamesMask (0x3fff)        Xkb->names      all name components
  91 .TE
  92