XkbGetBounceKeysDelay

NAME

XkbGetBounceKeysDelay
− Queries the current BounceKeys delay for a keyboard
device.

SYNOPSIS

Bool
XkbGetBounceKeysDelay

(Display
*display, unsigned intdevice_spec,

unsigned int
*delay_rtrn);

ARGUMENTS

−
display

connection to X server

− device_spec

device ID, or XkbUseCoreKbd

− delay_rtrn

backfilled with bounce keys
delay, ms

DESCRIPTION

The server can
generate XkbAccessXNotify events for some of the global
keyboard controls. The detail field describes what AccessX
event just occurred and can be any of the values in Table
1.

The
keycode field reports the keycode of the key for
which the event occurred. If the action is related to
SlowKeys, the slowKeysDelay field contains the
current SlowKeys acceptance delay. If the action is related
to BounceKeys, the debounceDelay field contains the
current BounceKeys debounce delay.

Selecting for
AccessX Events

To receive
XkbAccessXNotify events under all possible conditions, use
XkbSelectEvents and pass XkbAccesXNotifyMask in both
bits_to_change and values_for_bits.

To receive
XkbStateNotify events only under certain conditions, use
XkbSelectEventDetails using XkbAccessXNotify as the
event_type and specifying the desired state changes
in bits_to_change and values_for_bits using
mask bits from Table 2.

Some users may
accidentally "bounce" on a key when they release
it. They press it once, then accidentally press it again
after they release it. The BounceKeys control temporarily
disables a key after it has been pressed, effectively
"debouncing" the keyboard. The period of time the
key is disabled after it is released is known as the
BounceKeys delay. BounceKeys is a boolean
control.

When the
BounceKeys control is active, the server reports acceptance
or rejection of any key to interested clients by sending an
appropriate AccessXNotify event (see STRUCTURES).

XkbGetBounceKeysDelay
requests the attributes of the BounceKeys control from the
server, waits for a reply, and backfills delay_rtrn
with the BounceKeys delay attribute.
XkbGetBounceKeysDelay returns True if successful; if
a compatible version of the Xkb extension is not available
in the server XkbGetSlowKeysDelay returns False.

RETURN VALUES

True

The XkbGetBounceKeysDelay
function returns True when it successfully requests the
attributes of the BounceKeys control from the server, waits
for a reply, and backfills delay_rtrn with the
BounceKeys delay attribute.

False

The XkbGetBounceKeysDelay function returns False
if a compatible version of the Xkb extension is not
available in the server.