1XkbCopyKeyType(3) XKB FUNCTIONS XkbCopyKeyType(3)
2
6 XkbCopyKeyType - Copy one XkbKeyTypeRec structures
7
9 Status XkbCopyKeyType (XkbKeyTypePtr from, XkbKeyTypePtr into);
10
12 - from pointer to XkbKeyTypeRec to be copied
13 - into pointer to XkbKeyTypeRec to be changed
15
17 XkbCopyKeyType copies the key type specified by from to the key type
18 specified by into. Both must point to legal XkbKeyTypeRec structures.
19 Xkb assumes from and into point to different places. As a result, over‐
20 laps can be fatal. XkbCopyKeyType frees any existing map, preserve,
21 and level_names in into prior to copying. If any allocation errors oc‐
22 cur while copying from to into, XkbCopyKeyType returns BadAlloc. Other‐
23 wise, XkbCopyKeyType copies from to into and returns Success.
24
26 Key types are used to determine the shift level of a key given the cur‐
27 rent state of the keyboard. The set of all possible key types for the
28 Xkb keyboard description are held in the types field of the client map,
29 whose total size is stored in size_types, and whose total number of
30 valid entries is stored in num_types. Key types are defined using the
31 following structure:
32 typedef struct { /* Key Type */
34 XkbModsRec mods; /* modifiers used to compute shift level */
35 unsigned char num_levels; /* total # shift levels, do not modify directly */
36 unsigned char map_count; /* # entries in map, preserve (if non-NULL) */
37 XkbKTMapEntryPtr map; /* vector of modifiers for each shift level */
38 XkbModsPtr preserve; /* mods to preserve for corresponding map entry */
39 Atom name; /* name of key type */
40 Atom * level_names; /* array of names of each shift level */
41 } XkbKeyTypeRec, *XkbKeyTypePtr;
42
44 BadAlloc Unable to allocate storage
45X Version 11 libX11 1.7.3.1 XkbCopyKeyType(3)