1XkbFreeNames(3)                  XKB FUNCTIONS                 XkbFreeNames(3)
2
3
4

NAME

6       XkbFreeNames - Free symbolic names structures
7

SYNOPSIS

9       void XkbFreeNames (XkbDescPtr xkb, unsigned int which, Bool free_map);
10

ARGUMENTS

12       - xkb  keyboard description for which names are to be freed
13
14       - which
15              mask of names components to be freed
16
17       - free_map
18              True => XkbNamesRec structure itself should be freed
19

DESCRIPTION

21       Do  not  free  symbolic  names structures directly using free or XFree.
22       Use XkbFreeNames instead.
23
24       The which parameter is the bitwise inclusive OR of the valid names mask
25       bits defined in Table 1.
26
27       Xkb  provides  several functions that work with symbolic names. Each of
28       these functions uses a mask to specify individual fields of the  struc‐
29       tures  described  above.  These  masks  and  their relationships to the
30       fields in a keyboard description are shown in Table 1.
31
32
33                                 Table 1 Symbolic Names Masks
34       ─────────────────────────────────────────────────────────────────────────────────
35       Mask Bit                 Value      Keyboard     Field
36                                           Component
37       ─────────────────────────────────────────────────────────────────────────────────
38       XkbKeycodesNameMask      (1<<0)     Xkb->names   keycodes
39       XkbGeometryNameMask      (1<<1)     Xkb->names   geometry
40       XkbSymbolsNameMask       (1<<2)     Xkb->names   symbols
41       XkbPhysSymbolsNameMask   (1<<3)     Xkb->names   phys_symbols
42       XkbTypesNameMask         (1<<4)     Xkb->names   type
43       XkbCompatNameMask        (1<<5)     Xkb->names   compat
44       XkbKeyTypeNamesMask      (1<<6)     Xkb->map     type[*].name
45       XkbKTLevelNamesMask      (1<<7)     Xkb->map     type[*].lvl_names[*]
46       XkbIndicatorNamesMask    (1<<8)     Xkb->names   indicators[*]
47       XkbKeyNamesMask          (1<<9)     Xkb->names   keys[*], num_keys
48       XkbKeyAliasesMask        (1<<10)    Xkb->names   key_aliases[*], num_key_aliases
49       XkbVirtualModNamesMask   (1<<11)    Xkb->names   vmods[*]
50       XkbGroupNamesMask        (1<<12)    Xkb->names   groups[*]
51       XkbRGNamesMask           (1<<13)    Xkb->names   radio_groups[*], num_rg
52       XkbComponentNamesMask    (0x3f)     Xkb->names   keycodes,
53                                                        geometry,
54                                                        symbols,
55                                                        physical symbols,
56                                                        types, and
57                                                        compatibility map
58       XkbAllNamesMask          (0x3fff)   Xkb->names   all name components
59
60
61
62X Version 11                     libX11 1.3.4                  XkbFreeNames(3)