1XkbFreeCompatMap(3) XKB FUNCTIONS XkbFreeCompatMap(3)
2
6 XkbFreeCompatMap - Free an entire compatibility map or selected por‐
7 tions of one
8
10 void XkbFreeCompatMap (XkbDescPtr xkb, unsigned int which, Bool
11 free_map);
12
14 - xkb Xkb description in which to free compatibility map
15 - which
17 mask of compatibility map components to free
18 - free_map
20 True => free XkbCompatMap structure itself
21
23 which specifies the compatibility map components to be freed (see Xk‐
24 bGetCompatMap). which is an inclusive OR of the bits shown in Table 1.
25 Table 1 Compatibility Map Component Masks
28 ───────────────────────────────────────────────────────────────
29 Mask Value Affecting
30 ───────────────────────────────────────────────────────────────
31 XkbSymInterpMask (1<<0) Symbol interpretations
32 XkbGroupCompatMask (1<<1) Group maps
33 XkbAllCompatMask (0x3) All compatibility map components
34 free_map indicates whether the XkbCompatMap structure itself should be
36 freed. If free_map is True, which is ignored, all non-NULL compatibil‐
37 ity map components are freed, and the compat field in the XkbDescRec
38 referenced by xkb is set to NULL.
39
41 typedef struct _XkbCompatMapRec {
42 XkbSymInterpretPtr sym_interpret; /* symbol based key semantics*/
43 XkbModsRec groups[XkbNumKbdGroups]; /* group => modifier map */
44 unsigned short num_si; /* # structures used in sym_interpret */
45 unsigned short size_si; /* # structures allocated in sym_interpret */
46 } XkbCompatMapRec, *XkbCompatMapPtr;
47 The complete description of an Xkb keyboard is given by an XkbDescRec.
50 The component structures in the XkbDescRec represent the major Xkb com‐
51 ponents outlined in Figure 1.1.
52 typedef struct {
54 struct _XDisplay * display; /* connection to X server */
55 unsigned short flags; /* private to Xkb, do not modify */
56 unsigned short device_spec; /* device of interest */
57 KeyCode min_key_code; /* minimum keycode for device */
58 KeyCode max_key_code; /* maximum keycode for device */
59 XkbControlsPtr ctrls; /* controls */
60 XkbServerMapPtr server; /* server keymap */
61 XkbClientMapPtr map; /* client keymap */
62 XkbIndicatorPtr indicators; /* indicator map */
63 XkbNamesPtr names; /* names for all components */
64 XkbCompatMapPtr compat; /* compatibility map */
65 XkbGeometryPtr geom; /* physical geometry of keyboard */
66 } XkbDescRec, *XkbDescPtr;
67 The display field points to an X display structure. The flags field is
69 private to the library: modifying flags may yield unpredictable re‐
70 sults. The device_spec field specifies the device identifier of the
71 keyboard input device, or XkbUseCoreKeyboard, which specifies the core
72 keyboard device. The min_key_code and max_key_code fields specify the
73 least and greatest keycode that can be returned by the keyboard. The
74 other fields specify structure components of the keyboard description
75 and are described in detail in other sections of this document. Table 2
76 identifies the subsequent sections of this document that discuss the
77 individual components of the XkbDescRec.
78 Table 2 XkbDescRec Component References
81 ────────────────────────────────────────
82 XkbDescRec Field For more info
83 ────────────────────────────────────────
84 ctrls Chapter 10
85 server Chapter 16
86 map Chapter 15
87 indicators Chapter 8
88 names Chapter 18
89 compat Chapter 17
90 geom Chapter 13
91 Each structure component has a corresponding mask bit that is used in
93 function calls to indicate that the structure should be manipulated in
94 some manner, such as allocating it or freeing it. These masks and their
95 relationships to the fields in the XkbDescRec are shown in Table 3.
96 Table 3 Mask Bits for XkbDescRec
99 ──────────────────────────────────────────────────
100 Mask Bit XkbDescRec Field Value
101 ──────────────────────
102 XkbControlsMask ctrls (1L<<0)
103 XkbServerMapMask server (1L<<1)
104 XkbIClientMapMask map (1L<<2)
105 XkbIndicatorMapMask indicators (1L<<3)
106 XkbNamesMask names (1L<<4)
107 XkbCompatMapMask compat (1L<<5)
108 XkbGeometryMask geom (1L<<6)
109 XkbAllComponentsMask All Fields (0x7f)
110
112 XkbGetCompatMap(3)
113X Version 11 libX11 1.7.2 XkbFreeCompatMap(3)