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

NAME

6       XkbAllocCompatMap  -  Allocate  a  new  compatibility map if you do not
7       already have one available
8

SYNOPSIS

10       Status XkbAllocCompatMap (XkbDescPtr xkb, unsigned int which,  unsigned
11              int num_si);
12

ARGUMENTS

14       - xkb  keyboard description in which to allocate compat map
15
16       - which
17              mask of compatibility map components to allocate
18
19       - num_si
20              number of symbol interpretations to allocate
21

DESCRIPTION

23       xkb specifies the keyboard description for which compatibility maps are
24       to be allocated. The compatibility map is  the  compat  field  in  this
25       structure.
26
27       which  specifies  the compatibility map components to be allocated (see
28       XkbGetCompatMap).  which is an inclusive OR of the bits shown in  Table
29       1.
30
31
32                 Table 1 Compatibility Map Component Masks
33       ───────────────────────────────────────────────────────────────
34       Mask                 Value    Affecting
35       ───────────────────────────────────────────────────────────────
36       XkbSymInterpMask     (1<<0)   Symbol interpretations
37       XkbGroupCompatMask   (1<<1)   Group maps
38       XkbAllCompatMask     (0x3)    All compatibility map components
39
40       num_si  specifies the total number of entries to allocate in the symbol
41       interpretation vector (xkb.compat.sym_interpret).
42
43       XkbAllocCompatMap returns Success if successful,  BadMatch  if  xkb  is
44       NULL, or BadAlloc if errors are encountered when attempting to allocate
45       storage.
46

STRUCTURES

48           typedef struct {
49               KeySym            sym;          /∗ keysym of interest or NULL */
50               unsigned char     flags;        /∗ XkbSI_AutoRepeat, XkbSI_LockingKey */
51               unsigned char     match;        /∗ specifies how mods is interpreted */
52               unsigned char     mods;         /∗ modifier bits, correspond to eight real modifiers */
53               unsigned char     virtual_mod;  /∗ 1 modifier to add to key virtual mod map */
54               XkbAnyAction      act;          /∗ action to bind to symbol position on key */
55           } XkbSymInterpretRec,*XkbSymInterpretPtr;
56
57

DIAGNOSTICS

59       BadAlloc       Unable to allocate storage
60
61       BadMatch       A compatible version of Xkb was  not  available  in  the
62                      server or an argument has correct type and range, but is
63                      otherwise invalid
64

SEE ALSO

66       XkbGetCompatMap(3)
67

NOTES

69       Note that symbol interpretations in a compatibility map (the sym_inter‐
70       pret  vector of XkbSymInterpretRec structures) are also allocated using
71       this same function. To ensure that there is  sufficient  space  in  the
72       symbol  interpretation vector for entries to be added, use XkbAllocCom‐
73       patMap specifying which as XkbSymInterpretMask and the number  of  free
74       symbol interpretations needed in num_si.
75
76
77
78X Version 11                     libX11 1.6.7             XkbAllocCompatMap(3)
Impressum