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  keycode of first key to get
17
18       num    number of keys for which information is desired
19
20       xkb    keyboard description to update
21

DESCRIPTION

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

DIAGNOSTICS

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