1. NAME▲

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

2. SYNOPSIS ▲

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

3. ARGUMENTS ▲

  • - xkb
        keyboard description in which to allocate compat map
  • - which
        mask of compatibility map components to allocate
  • - num_si
        number of symbol interpretations to allocate

4. DESCRIPTION ▲

xkbspecifies the keyboard description for which compatibility maps are to be allocated. The compatibility map is the compatfield in this structure. whichspecifies the compatibility map components to be allocated (see XkbGetCompatMap). whichis an inclusive OR of the bits shown in Table 1.

c s s
Table 1 Compatibility Map Component Masks
_
Mask Value Affecting
_
XkbSymInterpMask (1<<0) Symbol interpretations
XkbGroupCompatMask (1<<1) Group maps
XkbAllCompatMask (0x3) All compatibility map components

num_sispecifies the total number of entries to allocate in the symbol interpretation vector (xkb.compat.sym_interpret). XkbAllocCompatMapreturns Success if successful, BadMatch if xkbis NULL, or BadAlloc if errors are encountered when attempting to allocate storage.

5. STRUCTURES ▲

 
Sélectionnez
    typedef struct {
        KeySym            sym;          /(** keysym of interest or NULL */
        unsigned char     flags;        /(** XkbSI_AutoRepeat, XkbSI_LockingKey */
        unsigned char     match;        /(** specifies how mods is interpreted */
        unsigned char     mods;         /(** modifier bits, correspond to eight real modifiers */
        unsigned char     virtual_mod;  /(** 1 modifier to add to key virtual mod map */
        XkbAnyAction      act;          /(** action to bind to symbol position on key */
    } XkbSymInterpretRec,*XkbSymInterpretPtr;

6. DIAGNOSTICS ▲

BadAlloc

               Unable to allocate storage

BadMatch

               A compatible version of Xkb was not available in the server or an argument has correct type and range, but is otherwise invalid

7. SEE ALSO ▲

R XkbGetCompatMap (3)

8. NOTES ▲

Note that symbol interpretations in a compatibility map (the sym_interpretvector of XkbSymInterpretRec structures) are also allocated using this same function. To ensure that there is sufficient space in the symbol interpretation vector for entries to be added, use XkbAllocCompatMapspecifying whichas XkbSymInterpretMask and the number of free symbol interpretations needed in num_si.