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

NAME

6       XkbAllocNames - Allocate symbolic names structures
7

SYNOPSIS

9       Status  XkbAllocNames  (XkbDescPtr xkb, unsigned int which, int num_rg,
10              int num_key_aliases);
11

ARGUMENTS

13       xkb    keyboard description for which names are to be allocated
14
15       which  mask of names to be allocated
16
17       num_rg total number of radio group names needed
18
19       num_key_aliases
20              total number of key aliases needed
21

DESCRIPTION

23       Most applications do not  need  to  directly  allocate  symbolic  names
24       structures.  Do not allocate a names structure directly using malloc or
25       Xmalloc if your application changes the number of key aliases or  radio
26       groups  or  constructs  a  symbolic names structure without loading the
27       necessary components from the X server. Instead use XkbAllocNames.
28
29       XkbAllocNames can return BadAlloc, BadMatch, and BadValue  errors.  The
30       which  parameter  is  the  bitwise inclusive OR of the valid names mask
31       bits defined in Table 1.
32
33
34                                 Table 1 Symbolic Names Masks
35       ─────────────────────────────────────────────────────────────────────────────────
36       Mask Bit                 Value      Keyboard     Field
37                                           Component
38       ─────────────────────────────────────────────────────────────────────────────────
39       XkbKeycodesNameMask      (1<<0)     Xkb->names   keycodes
40       XkbGeometryNameMask      (1<<1)     Xkb->names   geometry
41       XkbSymbolsNameMask       (1<<2)     Xkb->names   symbols
42       XkbPhysSymbolsNameMask   (1<<3)     Xkb->names   phys_symbols
43       XkbTypesNameMask         (1<<4)     Xkb->names   type
44       XkbCompatNameMask        (1<<5)     Xkb->names   compat
45       XkbKeyTypeNamesMask      (1<<6)     Xkb->map     type[*].name
46       XkbKTLevelNamesMask      (1<<7)     Xkb->map     type[*].lvl_names[*]
47       XkbIndicatorNamesMask    (1<<8)     Xkb->names   indicators[*]
48       XkbKeyNamesMask          (1<<9)     Xkb->names   keys[*], num_keys
49       XkbKeyAliasesMask        (1<<10)    Xkb->names   key_aliases[*], num_key_aliases
50       XkbVirtualModNamesMask   (1<<11)    Xkb->names   vmods[*]
51       XkbGroupNamesMask        (1<<12)    Xkb->names   groups[*]
52       XkbRGNamesMask           (1<<13)    Xkb->names   radio_groups[*], num_rg
53       XkbComponentNamesMask    (0x3f)     Xkb->names   keycodes,
54                                                        geometry,
55                                                        symbols,
56                                                        physical symbols,
57                                                        types, and
58                                                        compatibility map
59       XkbAllNamesMask          (0x3fff)   Xkb->names   all name components
60
61       Do not free symbolic names structures directly  using  free  or  XFree.
62       Use XkbFreeNames instead.
63

DIAGNOSTICS

65       BadAlloc       Unable to allocate storage
66
67       BadMatch       A  compatible  version  of  Xkb was not available in the
68                      server or an argument has correct type and range, but is
69                      otherwise invalid
70
71       BadValue       An argument is out of range
72

SEE ALSO

74       XkbFreeNames(3)
75
76
77
78X Version 11                     libX11 1.8.7                 XkbAllocNames(3)
Impressum