XkbCopyKeyTypes(3)

1XkbCopyKeyTypes(3)               XKB FUNCTIONS              XkbCopyKeyTypes(3)
2
3
4

NAME

6       XkbCopyKeyTypes - Copy more than one XkbKeyTypeRec structure
7

SYNOPSIS

9       Status  XkbCopyKeyTypes  (XkbKeyTypePtr  from,  XkbKeyTypePtr into, int
10              num_types);
11

ARGUMENTS

13       - from pointer to array of XkbKeyTypeRecs to copy
14
15       - into pointer to array of XkbKeyTypeRecs to change
16
17       - num_types
18              number of types to copy
19

DESCRIPTION

21       XkbCopyKeyTypes copies num_types XkbKeyTypeRec structures from the  ar‐
22       ray specified by from into the array specified by into.  It is intended
23       for copying between, rather than within, keyboard descriptions,  so  it
24       doesn't  check  for overlaps. The same rules that apply to the from and
25       into parameters in XkbCopyKeyType apply to each entry of the  from  and
26       into  arrays  of XkbCopyKeyTypes.  If any allocation errors occur while
27       copying from to into, XkbCopyKeyTypes returns BadAlloc. Otherwise, Xkb‐
28       CopyKeyTypes copies from to into and returns Success.
29

RETURN VALUES

31       Success        The  XkbCopyKeyTypes function returns Success when there
32                      are no allocation errors.
33

STRUCTURES

35       Key types are used to determine the shift level of a key given the cur‐
36       rent  state  of the keyboard. The set of all possible key types for the
37       Xkb keyboard description are held in the types field of the client map,
38       whose  total  size  is  stored in size_types, and whose total number of
39       valid entries is stored in num_types.  Key types are defined using  the
40       following structure:
41
42       typedef struct {                   /∗ Key Type */
43           XkbModsRec        mods;        /∗ modifiers used to compute shift level */
44           unsigned char     num_levels;  /∗ total # shift levels, do not modify
45       directly */
46           unsigned char     map_count;   /∗ # entries in map, preserve (if non-NULL)
47       */
48           XkbKTMapEntryPtr  map;         /∗ vector of modifiers for each shift level
49       */
50           XkbModsPtr        preserve;    /∗ mods to preserve for corresponding map
51       entry */
52           Atom              name;        /∗ name of key type */
53           Atom *            level_names; /∗ array of names of each shift level */
54       } XkbKeyTypeRec, *XkbKeyTypePtr;
55

DIAGNOSTICS

57       BadAlloc       Unable to allocate storage
58