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

NAME

6       XkbFreeControls  -  Frees  memory used by the ctrls member of an XkbDe‐
7       scRec structure
8

SYNOPSIS

10       void  XkbFreeControls  (XkbDescPtr  xkb,  unsigned  int   which,   Bool
11              free_all);
12

ARGUMENTS

14       - xkb  Xkb description in which to free controls components
15
16       - which
17              mask of components of ctrls to free
18
19       - free_all
20              True => free everything + ctrls itself
21

DESCRIPTION

23       XkbFreeControls  frees  the  specified components of the ctrls field in
24       the xkb keyboard description and sets the corresponding structure  com‐
25       ponent  values  to NULL or zero. The which mask specifies the fields of
26       ctrls to be freed and can contain any of the controls components speci‐
27       fied in Table 1.
28
29       Table  1  shows  the actual values for the individual mask bits used to
30       select controls for modification and to enable and disable the control.
31       Note that the same mask bit is used to specify general modifications to
32       the parameters used to configure the control (which), and to enable and
33       disable  the  control  (enabled_ctrls).  The anomalies in the table (no
34       "ok" in column) are for controls that have no configurable  attributes;
35       and  for controls that are not boolean controls and therefore cannot be
36       enabled or disabled.
37
38
39                               Table 1 Controls Mask Bits
40       ───────────────────────────────────────────────────────────────────────────
41       Mask Bit                 which or        enabled   Value
42                                changed_ctrls   _ctrls
43       ───────────────────────────────────────────────────────────────────────────
44       XkbRepeatKeysMask        ok              ok        (1L<<0)
45       XkbSlowKeysMask          ok              ok        (1L<<1)
46       XkbBounceKeysMask        ok              ok        (1L<<2)
47       XkbStickyKeysMask        ok              ok        (1L<<3)
48       XkbMouseKeysMask         ok              ok        (1L<<4)
49       XkbMouseKeysAccelMask    ok              ok        (1L<<5)
50       XkbAccessXKeysMask       ok              ok        (1L<<6)
51       XkbAccessXTimeoutMask    ok              ok        (1L<<7)
52       XkbAccessXFeedbackMask   ok              ok        (1L<<8)
53       XkbAudibleBellMask                       ok        (1L<<9)
54       XkbOverlay1Mask                          ok        (1L<<10)
55       XkbOverlay2Mask                          ok        (1L<<11)
56       XkbIgnoreGroupLockMask                   ok        (1L<<12)
57       XkbGroupsWrapMask        ok                        (1L<<27)
58       XkbInternalModsMask      ok                        (1L<<28)
59       XkbIgnoreLockModsMask    ok                        (1L<<29)
60       XkbPerKeyRepeatMask      ok                        (1L<<30)
61       XkbControlsEnabledMask   ok                        (1L<<31)
62       XkbAccessXOptionsMask    ok              ok        (XkbStickyKeysMask |
63                                                          XkbAccessXFeedbackMask)
64       XkbAllBooleanCtrlsMask                   ok        (0x00001FFF)
65       XkbAllControlsMask       ok                        (0xF8001FFF)
66
67       If free_all is True, XkbFreeControls  frees  every  non-NULL  structure
68       component  in  the  controls, frees the XkbControlsRec structure refer‐
69       enced by the ctrls member of xkb, and sets ctrls to NULL.
70
71
72
73X Version 11                    libX11 1.7.3.1              XkbFreeControls(3)
Impressum