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

NAME

6       XkbLockModifiers  -   Locks  and unlocks any of the eight real keyboard
7       modifiers
8

SYNOPSIS

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

RETURN VALUES

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