1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
'\" t
.\" Copyright 1999 Oracle and/or its affiliates. All rights reserved.
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the "Software"),
.\" to deal in the Software without restriction, including without limitation
.\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
.\" and/or sell copies of the Software, and to permit persons to whom the
.\" Software is furnished to do so, subject to the following conditions:
.\"
.\" The above copyright notice and this permission notice (including the next
.\" paragraph) shall be included in all copies or substantial portions of the
.\" Software.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
.\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
.\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
.\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
.\" DEALINGS IN THE SOFTWARE.
.\"
.TH XkbSetNames __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
.SH NAME
XkbSetNames \- Change the symbolic names in the server
.SH SYNOPSIS
.HP
.B Bool XkbSetNames
.BI "(\^Display *" "dpy" "\^,"
.BI "unsigned int " "which" "\^,"
.BI "unsigned int " "first_type" "\^,"
.BI "unsigned int " "num_types" "\^,"
.BI "XkbDescPtr " "xkb" "\^);"
.if n .ti +5n
.if t .ti +.5i
.SH ARGUMENTS
.TP
.I dpy
connection to the X server
.TP
.I which
mask of names or map components to be changed
.TP
.I first_type
first type whose name is to be changed
.TP
.I num_types
number of types for which names are to be changed
.TP
.I xkb
keyboard description from which names are to be taken
.SH DESCRIPTION
.LP
To change the symbolic names in the server, first modify a local copy of the
keyboard description and then
use either
.I XkbSetNames,
or, to save network traffic, use a XkbNameChangesRecstructure and call
.I XkbChangeNames
to download the changes to the server.
.I XkbSetNames
and
.I XkbChangeNames
can generate BadAlloc, BadAtom, BadLength, BadMatch, and BadImplementation
errors.
Use
.I XkbSetNames
to change many names at the same time. For each bit set in
.I which, XkbSetNames
takes the corresponding value (or values in the case of arrays) from the
keyboard description
.I xkb
and sends it to the server.
The
.I first_type
and
.I num_types
arguments are used only if XkbKeyTypeNamesMask or XkbKTLevelNamesMask is set in
.I which
and specify a subset of the types for which the corresponding names are to be
changed. If either or both of
these mask bits are set but the specified types are illegal,
.I XkbSetNames
returns False and does not update any of the names specified in
.I which.
The specified types are illegal if
.I xkb
does not include a map component or if
.I first_type
and
.I num_types
specify types that are not defined in the keyboard description.
.SH STRUCTURES
.LP
The XkbNameChangesRec allows applications to identify small modifications to the
symbolic names and
effectively reduces the amount of traffic sent to the server:
.nf
typedef struct _XkbNameChanges {
unsigned int changed; /\&* name components that have changed */
unsigned char first_type; /\&* first key type with a new name */
unsigned char num_types; /\&* number of types with new names */
unsigned char first_lvl; /\&* first key type with new level names */
unsigned char num_lvls; /\&* number of key types with new level names */
unsigned char num_aliases; /\&* if key aliases changed, total number of key aliases */
unsigned char num_rg; /\&* if radio groups changed, total number of radio groups */
unsigned char first_key; /\&* first key with a new name */
unsigned char num_keys; /\&* number of keys with new names */
unsigned short changed_vmods; /\&* mask of virtual modifiers for which names have changed */
unsigned long changed_indicators; /\&* mask of indicators for which names were changed */
unsigned char changed_groups; /\&* mask of groups for which names were changed */
} XkbNameChangesRec, *XkbNameChangesPtr
.fi
The
.I changed
field specifies the name components that have changed and is the bitwise
inclusive OR of the valid names
mask bits defined in Table 1. The rest of the fields in the structure specify
the ranges that have changed
for the various kinds of symbolic names, as shown in Table 2.
Xkb provides several functions that work with symbolic names. Each of these
functions uses a mask to
specify individual fields of the structures described above. These masks and
their relationships to the
fields in a keyboard description are shown in Table 1.
.TS
c s s s
l l l l.
Table 1 Symbolic Names Masks
_
Mask Bit Value Keyboard Field
Component
_
XkbKeycodesNameMask (1<<0) Xkb->names keycodes
XkbGeometryNameMask (1<<1) Xkb->names geometry
XkbSymbolsNameMask (1<<2) Xkb->names symbols
XkbPhysSymbolsNameMask (1<<3) Xkb->names phys_symbols
XkbTypesNameMask (1<<4) Xkb->names type
XkbCompatNameMask (1<<5) Xkb->names compat
XkbKeyTypeNamesMask (1<<6) Xkb->map type[*].name
XkbKTLevelNamesMask (1<<7) Xkb->map type[*].lvl_names[*]
XkbIndicatorNamesMask (1<<8) Xkb->names indicators[*]
XkbKeyNamesMask (1<<9) Xkb->names keys[*], num_keys
XkbKeyAliasesMask (1<<10) Xkb->names key_aliases[*], num_key_aliases
XkbVirtualModNamesMask (1<<11) Xkb->names vmods[*]
XkbGroupNamesMask (1<<12) Xkb->names groups[*]
XkbRGNamesMask (1<<13) Xkb->names radio_groups[*], num_rg
XkbComponentNamesMask (0x3f) Xkb->names keycodes,
geometry,
symbols,
physical symbols,
types, and
compatibility map
XkbAllNamesMask (0x3fff) Xkb->names all name components
.TE
.TS
c s s s
l l l l.
Table 2 XkbNameChanges Fields
_
Mask Fields Component Field
_
XkbKeyTypeNamesMask first_type, Xkb->map type[*].name
num_types
XkbKTLevelNamesMask first_lvl, Xkb->map type[*].lvl_names[*]
num_lvls
XkbKeyAliasesMask num_aliases Xkb->names key_aliases[*]
XkbRGNamesMask num_rg Xkb->names radio_groups[*]
XkbKeyNamesMask first_key, Xkb->names keys[*]
num_keys
XkbVirtualModNamesMask changed_vmods Xkb->names vmods[*]
XkbIndicatorNamesMask changed_indicators Xkb->names indicators[*]
XkbGroupNamesMask changed_groups Xkb->names groups[*]
.TE
.SH DIAGNOSTICS
.TP 15
.B BadAlloc
Unable to allocate storage
.TP 15
.B BadAtom
A name is neither a valid Atom or None
.TP 15
.B BadImplementation
Invalid reply from server
.TP 15
.B BadLength
The length of a request is shorter or longer than that required to minimally
contain the arguments
.TP 15
.B BadMatch
A compatible version of Xkb was not available in the server or an argument has
correct type and range, but is otherwise invalid
.SH "SEE ALSO"
.BR XkbChangeNames (__libmansuffix__)
|
