XKB FUNCTIONS XkbGetControlsChanges(3x11)
NAME
XkbGetControlsChanges - Updates a local copy of a keyboard
description with the changes previously noted by one or more calls to XkbNoteControlsChangesSYNOPSIS
cc [ flag... ] file... -lX11 [ library... ]
XkbGetControlsChanges (Display *dpy, XkbDescPtr xkb,
XkbNameChangesPtr changes); ARGUMENTS- dpy
connection to X server- xkb
xkb->ctrls will be updated
- changes
indicates which parts of xkb->ctrls to update
DESCRIPTION
Whenever a field in the controls structure changes in theserver's keyboard description, the server sends an XkbCon-
trolsNotify event to all interested clients.To receive XkbControlsNotify events under all possible conditions, use XkbSelectEvents and pass XkbControlsNotifyMask in bothbits_to_change and values_for_bits.
To receive XkbControlsNotify events only under certain con-
ditions, use XkbSelectEventDetails using XkbControlsNotifyas the event_type and specifying the desired state changes
in bits_to_change and values_for_bits using mask bits from
Table 1. Table 1 shows the actual values for the individual mask bits used to select controls for modification and to enable and disable the control. Note that the same mask bit is used tospecify general modifications to the parameters used to con-
figure the control (which), and to enable and disable thecontrol (enabled_ctrls). The anomalies in the table (no "ok"
in column) are for controls that have no configurable attri-
butes; and for controls that are not boolean controls and therefore cannot be enabled or disabled. Table 1 Controls Mask Bits_________________________________________________________________________
Mask Bit which or enabled Valuechanged_ctrls _ctrls
_________________________________________________________________________
XkbRepeatKeysMask ok ok (1L<<0) XkbSlowKeysMask ok ok (1L<<1) X Version 11 Last change: libX11 1.3.5 1XKB FUNCTIONS XkbGetControlsChanges(3x11)
XkbBounceKeysMask ok ok (1L<<2) XkbStickyKeysMask ok ok (1L<<3) XkbMouseKeysMask ok ok (1L<<4) XkbMouseKeysAccelMask ok ok (1L<<5) XkbAccessXKeysMask ok ok (1L<<6) XkbAccessXTimeoutMask ok ok (1L<<7) XkbAccessXFeedbackMask ok ok (1L<<8) XkbAudibleBellMask ok (1L<<9) XkbOverlay1Mask ok (1L<<10) XkbOverlay2Mask ok (1L<<11) XkbIgnoreGroupLockMask ok (1L<<12) XkbGroupsWrapMask ok (1L<<27) XkbInternalModsMask ok (1L<<28) XkbIgnoreLockModsMask ok (1L<<29) XkbPerKeyRepeatMask ok (1L<<30) XkbControlsEnabledMask ok (1L<<31) XkbAccessXOptionsMask ok ok (XkbStickyKeysMask | XkbAccessXFeedbackMask) XkbAllBooleanCtrlsMask ok (0x00001FFF) XkbAllControlsMask ok (0xF8001FFF)The changed_ctrls field specifies the controls components
that have changed and consists of bits taken from the masksdefined in Table 10.7 with "ok" in the changed_ctrls column.
The controls currently enabled in the server are reported inthe enabled_ctrls field. If any controls were just enabled
or disabled (that is, the contents of the enabled_ctrls
field changed), they are flagged in the enabled_ctrl_changes
field. The valid bits for these fields are the masks listedin Table 10.7 with "ok" in the enabled_ctrls column. The
num_groups field reports the number of groups bound to the
key belonging to the most number of groups and is automati-
cally updated when the keyboard mapping changes. If the change was caused by a request from a client, thekeycode and event_type fields are set to zero and the
req_major and req_minor fields identify the request. The
req_major value is the same as event_type is set to the type
of event that caused the change (one of KeyPress, KeyRelease, DeviceKeyPress, DeviceKeyRelease, ButtonPress orButtonRelease), and req_major and req_minor are undefined.
If event_type is KeyPress, KeyRelease, DeviceKeyPress, or
DeviceKeyRelease, the keycode field is set to the key thatcaused the change. If event_type is ButtonPress or Button-
Release, keycode contains the button number. When a client receives an XkbControlsNotify event, it cannote the changes in a changes structure using XkbNoteCon-
trolsChanges.XkbGetControlsChanges examines the changes parameter,
X Version 11 Last change: libX11 1.3.5 2XKB FUNCTIONS XkbGetControlsChanges(3x11)
queries the server for the necessary information, and copiesthe results into the xkb->ctrls keyboard description. If the
ctrls field of xkb is NULL, XkbGetControlsChanges allocates
and initializes it. To free the ctrls field, use XkbFreeCon-
trols.XkbGetControlsChanges returns Success if successful and can
generate BadAlloc, BadImplementation, and BadMatch errors.RETURN VALUES
Success The XkbGetControlsChanges function returns
Success if the query of the server was suc-
cessful. STRUCTURES The structure for the XkbControlsNotify event is defined as follows: typedef struct { int type; /* Xkb extension base event code */ unsigned long serial; /* X server serial number for event */Bool send_event; /* True => synthetically generated */
Display * display; /* server connection where event generated */ Time time; /* server time when event generated */int xkb_type; /* XkbCompatMapNotify */
int device; /* Xkb device ID, will not be XkbUseCoreKbd */unsigned int changed_ctrls; /* bits indicating which controls data have
changed*/unsigned int enabled_ctrls; /* controls currently enabled in server */
unsigned int enabled_ctrl_changes; /* bits indicating enabled/disabled
controls */int num_groups; /* current number of keyboard groups */
KeyCode keycode; /* != 0 => keycode of key causing change */char event_type; /* Type of event causing change */
char req_major; /* major event code of event causing change */
char req_minor; /* minor event code of event causing change */
} XkbControlsNotifyEvent; DIAGNOSTICS BadAlloc Unable to allocate storage BadImplementation Invalid reply from server BadMatch A compatible version of Xkb was not available in the server or an argument has correct type and range, but is otherwise invalidSEE ALSO
XkbFreeControls(3x11), XkbNoteControlsChanges(3x11), XkbSelectEventDetails(3x11), XkbSelectEvents(3x11) X Version 11 Last change: libX11 1.3.5 3XKB FUNCTIONS XkbGetControlsChanges(3x11)
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes:____________________________________________________________
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
|_____________________________|_____________________________|
| Availability | x11/library/libx11 ||_____________________________|_____________________________|
| Interface Stability | Committed ||_____________________________|_____________________________|
| MT-Level | See XInitThreads(3X11) |
|_____________________________|_____________________________|
X Version 11 Last change: libX11 1.3.5 4