2 .\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
4 .\" Permission is hereby granted, free of charge, to any person obtaining a
5 .\" copy of this software and associated documentation files (the "Software"),
6 .\" to deal in the Software without restriction, including without limitation
7 .\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 .\" and/or sell copies of the Software, and to permit persons to whom the
9 .\" Software is furnished to do so, subject to the following conditions:
11 .\" The above copyright notice and this permission notice (including the next
12 .\" paragraph) shall be included in all copies or substantial portions of the
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 .\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 .\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 .\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 .\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 .\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 .\" DEALINGS IN THE SOFTWARE.
23 .TH XkbFreeControls __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
25 XkbFreeControls \- Frees memory used by the ctrls member of an XkbDescRec structure
28 .B void XkbFreeControls
29 .BI "(\^XkbDescPtr " "xkb" "\^,"
30 .BI "unsigned int " "which" "\^,"
31 .BI "Bool " "free_all" "\^);"
37 Xkb description in which to free controls components
40 mask of components of ctrls to free
43 True => free everything + ctrls itself
47 frees the specified components of the
51 keyboard description and sets the corresponding structure component values to NULL or zero. The
53 mask specifies the fields of
55 to be freed and can contain any of the controls components specified in Table 1.
57 Table 1 shows the actual values for the individual mask bits used to select
59 modification and to enable and disable the control. Note that the same mask bit
61 specify general modifications to the parameters used to configure the control
63 enable and disable the control (enabled_ctrls). The anomalies in the table (no
65 are for controls that have no configurable attributes; and for controls that are
67 controls and therefore cannot be enabled or disabled.
74 Table 1 Controls Mask Bits
76 Mask Bit which or enabled Value
79 XkbRepeatKeysMask ok ok (1L<<0)
80 XkbSlowKeysMask ok ok (1L<<1)
81 XkbBounceKeysMask ok ok (1L<<2)
82 XkbStickyKeysMask ok ok (1L<<3)
83 XkbMouseKeysMask ok ok (1L<<4)
84 XkbMouseKeysAccelMask ok ok (1L<<5)
85 XkbAccessXKeysMask ok ok (1L<<6)
86 XkbAccessXTimeoutMask ok ok (1L<<7)
87 XkbAccessXFeedbackMask ok ok (1L<<8)
88 XkbAudibleBellMask ok (1L<<9)
89 XkbOverlay1Mask ok (1L<<10)
90 XkbOverlay2Mask ok (1L<<11)
91 XkbIgnoreGroupLockMask ok (1L<<12)
92 XkbGroupsWrapMask ok (1L<<27)
93 XkbInternalModsMask ok (1L<<28)
94 XkbIgnoreLockModsMask ok (1L<<29)
95 XkbPerKeyRepeatMask ok (1L<<30)
96 XkbControlsEnabledMask ok (1L<<31)
97 XkbAccessXOptionsMask ok ok (XkbStickyKeysMask |
98 XkbAccessXFeedbackMask)
99 XkbAllBooleanCtrlsMask ok (0x00001FFF)
100 XkbAllControlsMask ok (0xF8001FFF)
107 frees every non-NULL structure component in the controls, frees the XkbControlsRec structure referenced by the