1XkbChangeMap(3) XKB FUNCTIONS XkbChangeMap(3)
2
6 XkbChangeMap - Update only partial components of a keyboard descrip‐
7 tion, modify the appropriate fields in the server and map components of
8 a local copy of the keyboard description
9
11 Bool XkbChangeMap (Display *dpy, XkbDescPtr xkb, XkbMapChangesPtr
12 changes);
13
15 - dpy connection to X server
16 - xkb description from which new values are taken
18 - changes
20 identifies component parts to update
21
23 To update only partial components of a keyboard description, modify the
24 appropriate fields in the server and map components of a local copy of
25 the keyboard description, then call XkbChangeMap with an XkbMapChanges‐
26 Rec structure indicating which components have changed.
27 XkbChangeMap copies any components specified by the changes structure
29 from the keyboard description, xkb, to the X server specified by dpy.
30 If any components specified by changes are not present in the xkb pa‐
32 rameter, XkbChangeMap returns False. Otherwise, it sends a request to
33 the server and returns True.
34 XkbChangeMap can generate BadAlloc, BadLength, and BadValue protocol
36 errors.
37
39 True The XkbChangeMap function returns True if the components
40 specified by changes are present in the xkb parameter.
41 False The XkbChangeMap function returns False if the compo‐
43 nents specified by changes are not present in the xkb
44 parameter.
45
47 Use the XkbMapChangesRec structure to identify and track partial modi‐
48 fications to the mapping components and to reduce the amount of traffic
49 between the server and clients.
50 typedef struct _XkbMapChanges {
52 unsigned short changed; /* identifies valid components in structure */
53 KeyCode min_key_code; /* lowest numbered keycode for device */
54 KeyCode max_key_code; /* highest numbered keycode for device */
55 unsigned char first_type; /* index of first key type modified */
56 unsigned char num_types; /* # types modified */
57 KeyCode first_key_sym; /* first key whose key_sym_map changed */
58 unsigned char num_key_syms; /* # key_sym_map entries changed */
59 KeyCode first_key_act; /* first key whose key_acts entry changed */
60 unsigned char num_key_acts; /* # key_acts entries changed */
61 KeyCode first_key_behavior; /* first key whose behaviors changed */
62 unsigned char num_key_behaviors; /* # behaviors entries changed */
63 KeyCode first_key_explicit; /* first key whose explicit entry changed */
64 unsigned char num_key_explicit; /* # explicit entries changed */
65 KeyCode first_modmap_key; /* first key whose modmap entry changed */
66 unsigned char num_modmap_keys; /* # modmap entries changed */
67 KeyCode first_vmodmap_key; /* first key whose vmodmap changed */
68 unsigned char num_vmodmap_keys; /* # vmodmap entries changed */
69 unsigned char pad1; /* reserved */
70 unsigned short vmods; /* mask indicating which vmods changed */
71 } XkbMapChangesRec,*XkbMapChangesPtr;
72
75 BadAlloc Unable to allocate storage
76 BadLength The length of a request is shorter or longer than that
78 required to minimally contain the arguments
79 BadValue An argument is out of range
81X Version 11 libX11 1.8.1 XkbChangeMap(3)