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

NAME

6       XkbLatchModifiers  -   Latches and unlatches any of the eight real key‐
7       board modifiers
8

SYNOPSIS

10       Bool XkbLatchModifiers (Display *display, unsigned int device_spec, un‐
11              signed int affect, unsigned int values);
12

ARGUMENTS

14       display
15              connection to the X server
16
17       device_spec
18              device ID, or XkbUseCoreKbd
19
20       affect mask of real modifiers whose lock state is to change
21
22       values 1 => lock, 0 => unlock; only for modifiers selected by affect
23

DESCRIPTION

25       XkbLatchModifiers sends a request to the server to latch the real modi‐
26       fiers selected by both affect and values and to unlatch the real  modi‐
27       fiers selected by affect , but not selected by values.
28
29       XkbLatchModifiers does not wait for a reply from the server. It returns
30       True if the request was sent, and False otherwise.
31
32       The functions in this section that change the use of  modifiers  use  a
33       mask in the parameter affect. It is a bitwise inclusive OR of the legal
34       modifier masks:
35
36
37       Table 1 Real Modifier Masks
38       ────────────────────────────
39       Mask
40       ────────────────────────────
41       ShiftMask
42       LockMask
43       ControlMask
44       Mod1Mask
45       Mod2Mask
46       Mod3Mask
47       Mod4Mask
48       Mod5Mask
49

RETURN VALUES

51       True           The XkbLatchModifiers function returns True if a request
52                      was  sent  to the server to latch the real modifiers se‐
53                      lected by both affect and values and to unlatch the real
54                      modifiers  selected by affect , but not selected by val‐
55                      ues.
56
57       False          The XkbLatchModifiers function returns False if the  re‐
58                      quest was not sent.
59
60
61
62
63X Version 11                    libX11 1.7.3.1            XkbLatchModifiers(3)