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

NAME

6       XkbVirtualModsToReal  -  Determines the mapping of virtual modifiers to
7       core X protocol modifiers
8

SYNOPSIS

10       Bool XkbVirtualModsToReal (XkbDescPtr xkb, unsigned  int  virtual_mask,
11              unsigned int *mask_rtrn);
12

ARGUMENTS

14       - xkb  keyboard description for input device
15
16       - virtual_mask
17              virtual modifier mask to translate
18
19       - mask_rtrn
20              backfilled with real modifiers
21

DESCRIPTION

23       Xkb maintains a virtual modifier mapping, which lists the virtual modi‐
24       fiers associated with, or bound to, each key. The real modifiers  bound
25       to  a virtual modifier always include all of the modifiers bound to any
26       of the keys that specify that virtual modifier in their  virtual  modi‐
27       fier  mapping.  The  server.vmodmap array indicates which virtual modi‐
28       fiers are bound to each key; each entry is a bitmask  for  the  virtual
29       modifier bits. The server.vmodmap array is indexed by keycode.
30
31       The  vmodmap  and vmods members of the server map are the "master" vir‐
32       tual modifier definitions. Xkb automatically propagates any changes  to
33       these fields to all other fields that use virtual modifier mappings.
34
35       For  example, if Mod3 is bound to the Num_Lock key by the core protocol
36       modifier mapping, and the NumLock virtual modifier  is  bound  to  they
37       Num_Lock  key by the virtual modifier mapping, Mod3 is added to the set
38       of modifiers associated with NumLock.
39
40       The virtual modifier mapping is normally updated whenever  actions  are
41       automatically  applied  to  symbols and few applications should need to
42       change the virtual modifier mapping explicitly.
43
44       Use XkbGetMap to get the virtual modifiers from the server or  use  Xk‐
45       bGetVirtualMods  to  update a local copy of the virtual modifiers bind‐
46       ings from the server. To set the binding of a  virtual  modifier  to  a
47       real modifier, use XkbGetVirtualMods
48
49       If  the  keyboard description defined by xkb includes bindings for vir‐
50       tual modifiers, XkbVirtualModsToReal uses those bindings  to  determine
51       the  set  of real modifiers that correspond to the set of virtual modi‐
52       fiers specified in virtual_mask.  The virtual_mask parameter is a  mask
53       specifying  the  virtual  modifiers to translate; the i-th bit (0 rela‐
54       tive) of the mask represents the i-th virtual modifier. If mask_rtrn is
55       non-NULL,  XkbVirtualModsToReal  backfills  it  with the resulting real
56       modifier mask. If the keyboard description in xkb does not include vir‐
57       tual  modifier bindings, XkbVirtualModsToReal returns False; otherwise,
58       it returns True.
59

RETURN VALUES

61       True           The XkbVirtualModsToReal function returns  True  if  the
62                      keyboard  description  in xkb does include virtual modi‐
63                      fier bindings.
64
65       False          The XkbVirtualModsToReal function returns False  if  the
66                      keyboard  description  in  xkb  does not include virtual
67                      modifier bindings.
68

SEE ALSO

70       XkbGetMap(3), XkbGetVirtualMods(3)
71

NOTES

73       It is possible for a local (client-side) keyboard description (the  xkb
74       parameter)  to not contain any virtual modifier information (simply be‐
75       cause the client has not requested it) while the server's corresponding
76       definition may contain virtual modifier information.
77
78
79
80
81X Version 11                     libX11 1.8.1          XkbVirtualModsToReal(3)