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

NAME

6       XkbGetKeyModifierMap  -  Update the modifier map for one or more of the
7       keys in a keyboard description
8

SYNOPSIS

10       Status XkbGetKeyModifierMap (Display *dpy, unsigned int first, unsigned
11              int num, XkbDescPtr xkb);
12

ARGUMENTS

14       - dpy  connection to X server
15
16       - first
17              keycode of first key to get
18
19       - num  number of keys for which information is desired
20
21       - xkb  keyboard description to update
22

DESCRIPTION

24       The  modmap  entry  of  the client map is an array, indexed by keycode,
25       specifying the real modifiers bound to a key. Each entry is a mask com‐
26       posed of a bitwise inclusive OR of the legal real modifiers: ShiftMask,
27       LockMask, ControlMask,  Mod1Mask,  Mod2Mask,  Mod3Mask,  Mod4Mask,  and
28       Mod5Mask.  If  a bit is set in a modmap entry, the corresponding key is
29       bound to that modifier.
30
31       Pressing or releasing the key bound to a modifier changes the  modifier
32       set  and  unset  state. The particular manner in which the modifier set
33       and unset state changes is determined by the behavior and  actions  as‐
34       signed to the key.
35
36       XkbGetKeyModifierMap  sends  a  request  to the server for the modifier
37       mappings for num keys starting with the key whose keycode is first.  It
38       waits for a reply and places the results in the xkb->map->modmap array.
39       If successful, XkbGetKeyModifier returns Success.
40
41       If the map component of the xkb parameter has not been  allocated,  Xk‐
42       bGetKeyModifierMap allocates and initializes it.
43
44       If  a  compatible  version of Xkb is not available in the server or the
45       Xkb extension has not been properly initialized, XkbGetKeySyms  returns
46       BadAccess.  If any allocation errors occur while obtaining the modifier
47       map, XkbGetKeyModifierMap returns BadAlloc.
48

DIAGNOSTICS

50       BadAccess      The Xkb extension has not been properly initialized
51
52       BadAlloc       Unable to allocate storage
53
54
55
56X Version 11                     libX11 1.8.1          XkbGetKeyModifierMap(3)
Impressum