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

NAME

6       XkbAllocControls  - Allocates an XkbControlsRec structure in the XkbDe‐
7       scRec
8

SYNOPSIS

10       Status XkbAllocControls (XkbDescPtr xkb, unsigned int which);
11

ARGUMENTS

13       - xkb  Xkb description in which to allocate ctrls rec
14
15       - which
16              mask of components of ctrls to allocate
17

DESCRIPTION

19       The need to allocate an XkbControlsRec  structure  seldom  arises;  Xkb
20       creates one when an application calls XkbGetControls or a related func‐
21       tion. For those situations where there is not an XkbControlsRec  struc‐
22       ture  allocated in the XkbDescRec, allocate one by calling XkbAllocCon‐
23       trols.
24
25       XkbAllocControls allocates the ctrls field of the xkb  parameter,  ini‐
26       tializes all fields to zero, and returns Success. If the ctrls field is
27       not NULL, XkbAllocControls simply returns  Success.  If  xkb  is  NULL,
28       XkbAllocControls reports a BadMatch error. If the ctrls field could not
29       be allocated, it reports a BadAlloc error.
30
31       The which mask specifies the individual fields of the  ctrls  structure
32       to be allocated and can contain any of the valid masks defined in Table
33       1.  (SHOULD THIS COMMENT BE LEFT IN????)  Because none of the currently
34       existing  controls  have  any structures associated with them, which is
35       currently of little practical value in this call.
36
37       Table 1 shows the actual values for the individual mask  bits  used  to
38       select controls for modification and to enable and disable the control.
39       Note that the same mask bit is used to specify general modifications to
40       the parameters used to configure the control (which), and to enable and
41       disable the control (enabled_ctrls). The anomalies  in  the  table  (no
42       "ok"  in column) are for controls that have no configurable attributes;
43       and for controls that are not boolean controls and therefore cannot  be
44       enabled or disabled.
45
46
47                               Table 1 Controls Mask Bits
48       ───────────────────────────────────────────────────────────────────────────
49       Mask Bit                 which or        enabled   Value
50                                changed_ctrls   _ctrls
51       ───────────────────────────────────────────────────────────────────────────
52       XkbRepeatKeysMask        ok              ok        (1L<<0)
53       XkbSlowKeysMask          ok              ok        (1L<<1)
54       XkbBounceKeysMask        ok              ok        (1L<<2)
55       XkbStickyKeysMask        ok              ok        (1L<<3)
56       XkbMouseKeysMask         ok              ok        (1L<<4)
57       XkbMouseKeysAccelMask    ok              ok        (1L<<5)
58       XkbAccessXKeysMask       ok              ok        (1L<<6)
59       XkbAccessXTimeoutMask    ok              ok        (1L<<7)
60       XkbAccessXFeedbackMask   ok              ok        (1L<<8)
61       XkbAudibleBellMask                       ok        (1L<<9)
62       XkbOverlay1Mask                          ok        (1L<<10)
63       XkbOverlay2Mask                          ok        (1L<<11)
64       XkbIgnoreGroupLockMask                   ok        (1L<<12)
65       XkbGroupsWrapMask        ok                        (1L<<27)
66
67       XkbInternalModsMask      ok                        (1L<<28)
68       XkbIgnoreLockModsMask    ok                        (1L<<29)
69       XkbPerKeyRepeatMask      ok                        (1L<<30)
70       XkbControlsEnabledMask   ok                        (1L<<31)
71       XkbAccessXOptionsMask    ok              ok        (XkbStickyKeysMask |
72                                                          XkbAccessXFeedbackMask)
73       XkbAllBooleanCtrlsMask                   ok        (0x00001FFF)
74       XkbAllControlsMask       ok                        (0xF8001FFF)
75

RETURN VALUES

77       SUCCESS        allocates   the   ctrls  field  of  the  xkb  parameter,
78                      initializes all fields to zero
79
80                    the ctrls field is not NULL
81

DIAGNOSTICS

83       BadAlloc       Unable to allocate storage
84
85       BadMatch       A compatible version of Xkb was  not  available  in  the
86                      server or an argument has correct type and range, but is
87                      otherwise invalid
88

SEE ALSO

90       XkbGetControls(3)
91
92
93
94X Version 11                     libX11 1.6.12             XkbAllocControls(3)
Impressum