XkbGetAutoResetControls(3) XKB FUNCTIONS XkbGetAutoResetControls(3)NAME
XkbGetAutoResetControls - Gets the current values of the auto-reset controls
SYNOPSIS
Bool XkbGetAutoResetControls (Display *dpy, unsigned int *auto_ctrls, unsigned int *auto_values);
ARGUMENTS
- dpy
connection to X server
- auto_ctrls
specifies which bits in auto_values are relevant
- auto_values
1 bit => corresponding control has auto-reset on
DESCRIPTION
You can configure the boolean controls to automatically be enabled or disabled when a program exits. This capability is controlled via two
masks maintained in the X server on a per-client basis. There is no client-side Xkb data structure corresponding to these masks. Whenever
the client exits for any reason, any boolean controls specified in the auto-reset mask are set to the corresponding value from the auto-
reset values mask. This makes it possible for clients to "clean up after themselves" automatically, even if abnormally terminated. The bits
used in the masks correspond to the EnabledControls control bits.
For example, a client that replaces the keyboard bell with some other audible cue might want to turn off the AudibleBell control to prevent
the server from also generating a sound and avoid cacophony. If the client were to exit without resetting the AudibleBell control, the user
would be left without any feedback at all. Setting AudibleBell in both the auto-reset mask and auto-reset values guarantees that the audi-
ble bell will be turned back on when the client exits.
XkbGetAutoResetControls backfills auto_ctrls and auto_values with the AutoReset control attributes for this particular client. It returns
True if successful, and False otherwise.
RETURN VALUES
True The XkbGetAutoResetControls function returns True when it successfully backfills auto_ctrls and auto_values with the AutoRe-
set control attributes for this particular client.
False The XkbGetAutoResetControls function returns False when it does not successfully backfill auto_ctrls and auto_values with
the AutoReset control attributes for this particular client.
X Version 11 libX11 1.5.0 XkbGetAutoResetControls(3)
Check Out this Related Man Page
XkbSetAutoResetControls(3) XKB FUNCTIONS XkbSetAutoResetControls(3)NAME
XkbSetAutoResetControls - Changes the current values of the AutoReset control attributes
SYNOPSIS
Bool XkbSetAutoResetControls (Display *dpy, unsigned int changes, unsigned int *auto_ctrls, unsigned int *auto_values);
ARGUMENTS
- dpy connection to X server
- changes
controls for which to change auto-reset values
- auto_ctrls
controls from changes that should auto reset
- auto_values
1 bit => auto-reset on
DESCRIPTION
XkbSetAutoResetControls changes the auto-reset status and associated auto-reset values for the controls selected by changes. For any con-
trol selected by changes, if the corresponding bit is set in auto_ctrls, the control is configured to auto-reset when the client exits. If
the corresponding bit in auto_values is on, the control is turned on when the client exits; if zero, the control is turned off when the
client exits. For any control selected by changes, if the corresponding bit is not set in auto_ctrls, the control is configured to not
reset when the client exits.
For example:
To leave the auto-reset controls for StickyKeys the way they are:
ok = XkbSetAutoResetControls(dpy, 0, 0, 0);
To change the auto-reset controls so that StickyKeys are unaffected when the
client exits:
ok = XkbSetAutoResetControls(dpy, XkbStickyKeysMask, 0, 0);
To change the auto-reset controls so that StickyKeys are turned off when the
client exits:
ok = XkbSetAutoResetControls(dpy, XkbStickyKeysMask, XkbStickyKeysMask, 0);
To change the auto-reset controls so that StickyKeys are turned on when the
client exits:
ok = XkbSetAutoResetControls(dpy, XkbStickyKeysMask, XkbStickyKeysMask,
XkbStickyKeysMask);
XkbSetAutoResetControls backfills auto_ctrls and auto_values with the auto-reset controls for this particular client. Note that all of the
bits are valid in the returned values, not just the ones selected in the changes mask.
X Version 11 libX11 1.3.2 XkbSetAutoResetControls(3)