1XkbSARedirectVMods(3) XKB FUNCTIONS XkbSARedirectVMods(3)
2
6 XkbSARedirectVMods - Returns the vmods0 and vmods1 fields of act con‐
7 verted to an unsigned int
8
10 unsigned int XkbSARedirectVMods (XkbRedirectKeyAction act);
11
13 - act action from which to extract vmods
14
16 Actions associated with the XkbRedirectKeyAction structure generate
17 KeyPress and KeyRelease events containing a keycode different from the
18 key that was pressed or released.
19 The type field for the XkbRedirectKeyAction structure should always be
21 XkbSA_RedirectKey. Key presses cause a KeyPress event for the key
22 specified by the new_key field instead of the actual key. The state
23 reported in this event reports the current effective modifiers changed
24 as follows: any real modifiers selected by the mods_mask field are set
25 to corresponding values from the mods field. Any real modifiers bound
26 to the virtual modifiers specified by the vmods_mask0 and vmods_mask1
27 fields are either set or cleared, depending on the corresponding values
28 in the vmods0 and vmods1 fields. If the real and virtual modifier defi‐
29 nitions specify conflicting values for a single modifier, the real mod‐
30 ifier definition has priority.
31 Key releases cause a KeyRelease event for the key specified by the
33 new_key field instead of the actual key. The state for this event con‐
34 sists of the effective keyboard modifiers at the time of the release,
35 changed as described previously.
36 The XkbSA_RedirectKey action normally redirects to another key on the
38 same device as the key that caused the event, unless that device does
39 not belong to the input extension KeyClass, in which case this action
40 causes an event on the core keyboard device. (The input extension cate‐
41 gorizes devices by breaking them into classes. Keyboards, and other
42 input devices with keys, are classified as KeyClass devices by the
43 input extension.)
44 The vmods_mask0 and vmods_mask1 fields actually represent one
46 vmods_mask value. Xkb provides macros to convert between the two for‐
47 mats.
48 XkbSARedirectVModsMask returns the vmods0 and vmods1 fields of act con‐
50 verted to an unsigned int.
51
53 typedef struct_XkbRedirectKeyAction {
54 unsigned char type; /∗ XkbSA_RedirectKey */
55 unsigned char new_key; /∗ keycode to be put in event */
56 unsigned char mods_mask; /∗ mask of real mods to be reset */
57 unsigned char mods; /∗ mask of real mods to take values from */
58 unsigned char vmods_mask0; /∗ first half of mask of virtual mods to be
59 reset */
60 unsigned char vmods_mask1; /∗ other half of mask of virtual mods to be
61 reset */
62 unsigned char vmods0; /∗ first half of mask of virtual mods to
63 take values from */
64 unsigned char vmods1; /∗ other half of mask of virtual mods to
65 take values from */
66 } XkbRedirectKeyAction;
67X Version 11 libX11 1.3.4 XkbSARedirectVMods(3)