XkbLatchGroup (3) - Linux Man Pages

XkbLatchGroup: Latches the keysym group

NAME

XkbLatchGroup - Latches the keysym group

SYNOPSIS

Bool XkbLatchGroup (Display *display, unsigned int device_spec, unsigned int group);
     

ARGUMENTS

display
connection to the X server
device_spec
device ID, or XkbUseCoreKbd
group
index of the keysym group to latch

DESCRIPTION

XkbLatchGroup sends a request to the server to latch the specified group and does not wait for a reply. It returns True if the request was sent and False otherwise.

Reference the keysym group indices with these symbolic constants:

Table 1 Symbolic Group Names

Symbolic NameValue

XkbGroup1Index0
XkbGroup2Index1
XkbGroup3Index2
XkbGroup4Index3

RETURN VALUES

True
The XkbLatchGroup function returns True if a request was sent to the server to latch the specified group.
False
The XkbLatchGroup function returns False if the request was not sent.