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

NAME

6       XkbFreeCompatMap  -  Free  an entire compatibility map or selected por‐
7       tions of one
8

SYNOPSIS

10       void  XkbFreeCompatMap  (XkbDescPtr  xkb,  unsigned  int  which,   Bool
11              free_map);
12

ARGUMENTS

14       - xkb  Xkb description in which to free compatibility map
15
16       - which
17              mask of compatibility map components to free
18
19       - free_map
20              True => free XkbCompatMap structure itself
21

DESCRIPTION

23       which  specifies  the  compatibility  map  components  to be freed (see
24       XkbGetCompatMap).  which is an inclusive OR of the bits shown in  Table
25       1.
26
27
28                 Table 1 Compatibility Map Component Masks
29       ───────────────────────────────────────────────────────────────
30       Mask                 Value    Affecting
31       ───────────────────────────────────────────────────────────────
32       XkbSymInterpMask     (1<<0)   Symbol interpretations
33       XkbGroupCompatMask   (1<<1)   Group maps
34       XkbAllCompatMask     (0x3)    All compatibility map components
35
36       free_map  indicates whether the XkbCompatMap structure itself should be
37       freed. If free_map is True, which is ignored, all non-NULL  compatibil‐
38       ity  map  components  are freed, and the compat field in the XkbDescRec
39       referenced by xkb is set to NULL.
40

STRUCTURES

42           typedef struct _XkbCompatMapRec {
43               XkbSymInterpretPtr    sym_interpret;            /∗ symbol based key semantics*/
44               XkbModsRec            groups[XkbNumKbdGroups];  /∗ group => modifier map */
45               unsigned short        num_si;                   /∗ # structures used in sym_interpret */
46               unsigned short        size_si;                  /∗ # structures allocated in sym_interpret */
47           } XkbCompatMapRec, *XkbCompatMapPtr;
48
49
50       The complete description of an Xkb keyboard is given by an  XkbDescRec.
51       The component structures in the XkbDescRec represent the major Xkb com‐
52       ponents outlined in Figure 1.1.
53
54       typedef struct {
55          struct _XDisplay * display;      /∗ connection to X server */
56          unsigned short     flags;        /∗ private to Xkb, do not modify */
57          unsigned short     device_spec;  /∗ device of interest */
58          KeyCode            min_key_code; /∗ minimum keycode for device */
59          KeyCode            max_key_code; /∗ maximum keycode for device */
60          XkbControlsPtr     ctrls;        /∗ controls */
61          XkbServerMapPtr    server;       /∗ server keymap */
62          XkbClientMapPtr    map;          /∗ client keymap */
63          XkbIndicatorPtr    indicators;   /∗ indicator map */
64          XkbNamesPtr        names;        /∗ names for all components */
65          XkbCompatMapPtr    compat;       /∗ compatibility map */
66          XkbGeometryPtr     geom;         /∗ physical geometry of keyboard */
67       } XkbDescRec, *XkbDescPtr;
68
69       The display field points to an X display structure. The flags field  is
70       private  to  the  library:  modifying  flags  may  yield  unpredictable
71       results. The device_spec field specifies the device identifier  of  the
72       keyboard  input device, or XkbUseCoreKeyboard, which specifies the core
73       keyboard device. The min_key_code and max_key_code fields  specify  the
74       least  and  greatest keycode that can be returned by the keyboard.  The
75       other fields specify structure components of the  keyboard  description
76       and are described in detail in other sections of this document. Table 2
77       identifies the subsequent sections of this document  that  discuss  the
78       individual components of the XkbDescRec.
79
80
81       Table 2 XkbDescRec Component References
82       ────────────────────────────────────────
83       XkbDescRec Field      For more info
84       ────────────────────────────────────────
85       ctrls                 Chapter 10
86       server                Chapter 16
87       map                   Chapter 15
88       indicators            Chapter 8
89       names                 Chapter 18
90       compat                Chapter 17
91       geom                  Chapter 13
92
93       Each  structure  component has a corresponding mask bit that is used in
94       function calls to indicate that the structure should be manipulated  in
95       some manner, such as allocating it or freeing it. These masks and their
96       relationships to the fields in the XkbDescRec are shown in Table 3.
97
98
99               Table 3 Mask Bits for XkbDescRec
100       ──────────────────────────────────────────────────
101       Mask Bit               XkbDescRec Field   Value
102       ──────────────────────
103       XkbControlsMask        ctrls              (1L<<0)
104       XkbServerMapMask       server             (1L<<1)
105       XkbIClientMapMask      map                (1L<<2)
106       XkbIndicatorMapMask    indicators         (1L<<3)
107       XkbNamesMask           names              (1L<<4)
108       XkbCompatMapMask       compat             (1L<<5)
109       XkbGeometryMask        geom               (1L<<6)
110       XkbAllComponentsMask   All Fields         (0x7f)
111

SEE ALSO

113       XkbGetCompatMap(3)
114
115
116
117X Version 11                     libX11 1.6.7              XkbFreeCompatMap(3)
Impressum