2
.\" Copyright (c) 1999 - Sun Microsystems, Inc.
3
.\" All rights reserved.
5
.\" Permission is hereby granted, free of charge, to any person obtaining a
6
.\" copy of this software and associated documentation files (the
7
.\" "Software"), to deal in the Software without restriction, including
8
.\" without limitation the rights to use, copy, modify, merge, publish,
9
.\" distribute, and/or sell copies of the Software, and to permit persons
10
.\" to whom the Software is furnished to do so, provided that the above
11
.\" copyright notice(s) and this permission notice appear in all copies of
12
.\" the Software and that both the above copyright notice(s) and this
13
.\" permission notice appear in supporting documentation.
15
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
16
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
18
.\" OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
19
.\" HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL
20
.\" INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING
21
.\" FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
22
.\" NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
23
.\" WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
25
.\" Except as contained in this notice, the name of a copyright holder
26
.\" shall not be used in advertising or otherwise to promote the sale, use
27
.\" or other dealings in this Software without prior written authorization
28
.\" of the copyright holder.
30
.TH XkbFreeControls __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
32
XkbFreeControls \- Frees memory used by the ctrls member of an XkbDescRec structure
34
.B void XkbFreeControls
41
XkbDescPtr \fIxkb\fP\^;
43
unsigned int \fIwhich\fP\^;
45
Bool \fIfree_all\fP\^;
51
Xkb description in which to free controls components
54
mask of components of ctrls to free
57
True => free everything + ctrls itself
61
frees the specified components of the
65
keyboard description and sets the corresponding structure component values to NULL or zero. The
67
mask specifies the fields of
69
to be freed and can contain any of the controls components specified in Table 1.
71
Table 1 shows the actual values for the individual mask bits used to select
73
modification and to enable and disable the control. Note that the same mask bit
75
specify general modifications to the parameters used to configure the control
77
enable and disable the control (enabled_ctrls). The anomalies in the table (no
79
are for controls that have no configurable attributes; and for controls that are
81
controls and therefore cannot be enabled or disabled.
88
Table 1 Controls Mask Bits
90
Mask Bit which or enabled Value
93
XkbRepeatKeysMask ok ok (1L<<0)
94
XkbSlowKeysMask ok ok (1L<<1)
95
XkbBounceKeysMask ok ok (1L<<2)
96
XkbStickyKeysMask ok ok (1L<<3)
97
XkbMouseKeysMask ok ok (1L<<4)
98
XkbMouseKeysAccelMask ok ok (1L<<5)
99
XkbAccessXKeysMask ok ok (1L<<6)
100
XkbAccessXTimeoutMask ok ok (1L<<7)
101
XkbAccessXFeedbackMask ok ok (1L<<8)
102
XkbAudibleBellMask ok (1L<<9)
103
XkbOverlay1Mask ok (1L<<10)
104
XkbOverlay2Mask ok (1L<<11)
105
XkbIgnoreGroupLockMask ok (1L<<12)
106
XkbGroupsWrapMask ok (1L<<27)
107
XkbInternalModsMask ok (1L<<28)
108
XkbIgnoreLockModsMask ok (1L<<29)
109
XkbPerKeyRepeatMask ok (1L<<30)
110
XkbControlsEnabledMask ok (1L<<31)
111
XkbAccessXOptionsMask ok ok (XkbStickyKeysMask |
112
XkbAccessXFeedbackMask)
113
XkbAllBooleanCtrlsMask ok (0x00001FFF)
114
XkbAllControlsMask ok (0xF8001FFF)
121
frees every non-NULL structure component in the controls, frees the XkbControlsRec structure referenced by the
added
removed
man/xkb/XkbFreeControls.man
