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

NAME

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

SYNOPSIS

11       Bool  XkbChangeMap  (Display  *dpy,  XkbDescPtr  xkb,  XkbMapChangesPtr
12              changes);
13

ARGUMENTS

15       - dpy  connection to X server
16
17       - xkb  description from which new values are taken
18
19       - changes
20              identifies component parts to update
21

DESCRIPTION

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
28       XkbChangeMap  copies  any components specified by the changes structure
29       from the keyboard description, xkb, to the X server specified by dpy.
30
31       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
35       XkbChangeMap can generate BadAlloc, BadLength,  and  BadValue  protocol
36       errors.
37

RETURN VALUES

39       True           The XkbChangeMap function returns True if the components
40                      specified by changes are present in the xkb parameter.
41
42       False          The XkbChangeMap function returns False  if  the  compo‐
43                      nents  specified  by  changes are not present in the xkb
44                      parameter.
45

STRUCTURES

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
51       typedef struct _XkbMapChanges {
52           unsigned short   changed;            /* identifies valid components in
53       structure */
54           KeyCode          min_key_code;       /* lowest numbered keycode for device
55       */
56           KeyCode          max_key_code;       /* highest numbered keycode for device
57       */
58           unsigned char    first_type;         /* index of first key type modified */
59           unsigned char    num_types;          /* # types modified */
60           KeyCode          first_key_sym;      /* first key whose key_sym_map changed
61       */
62           unsigned char    num_key_syms;       /* # key_sym_map entries changed */
63           KeyCode          first_key_act;      /* first key whose key_acts entry
64       changed */
65           unsigned char    num_key_acts;       /* # key_acts entries changed */
66           KeyCode          first_key_behavior; /* first key whose behaviors changed */
67           unsigned char    num_key_behaviors;  /* # behaviors entries changed */
68           KeyCode          first_key_explicit; /* first key whose explicit entry
69       changed */
70           unsigned char    num_key_explicit;   /* # explicit entries changed */
71           KeyCode          first_modmap_key;   /* first key whose modmap entry changed
72       */
73           unsigned char    num_modmap_keys;    /* # modmap entries changed */
74           KeyCode          first_vmodmap_key;  /* first key whose vmodmap changed */
75           unsigned char    num_vmodmap_keys;   /* # vmodmap entries changed */
76           unsigned char    pad1;               /* reserved */
77           unsigned short   vmods;              /* mask indicating which vmods changed
78       */
79       } XkbMapChangesRec,*XkbMapChangesPtr;
80
81

DIAGNOSTICS

83       BadAlloc       Unable to allocate storage
84
85       BadLength      The length of a request is shorter or longer  than  that
86                      required to minimally contain the arguments
87
88       BadValue       An argument is out of range
89
90
91
92X Version 11                    libX11 1.7.3.1                 XkbChangeMap(3)