NAME
XkbChangeControls - Provides a flexible method for updating the con‐ trols in a server to match those in the changed keyboard description SYNOPSIS Bool XkbChangeControls (Display *dpy, XkbDescPtr xkb, XkbCon‐ trolsChangesPtr changes); ARGUMENTS
- dpy connection to X server
- xkb keyboard description with changed xkb->ctrls
- changes
which parts of xkb->ctrls have changed DESCRIPTION The XkbControlsChangesRec structure allows applications to track modi‐ fications to an XkbControlsRec structure and thereby reduce the amount of traffic sent to the server. The same XkbControlsChangesRec structure may be used in several successive modifications to the same XkbControl‐ sRec structure, then subsequently used to cause all of the changes, and only the changes, to be propagated to the server. The changedctrls field is a mask specifying which logical sets of data in the controls structure have been modified. In this context, modified means set, that is, if a value is set to the same value it previously contained, it has still been modified, and is noted as changed. Valid values for changedctrls are any combination of the masks listed in Ta‐ ble 1 that have "ok" in the changedctrls column. Setting a bit implies the corresponding data fields from the "Relevant XkbControlsRec Data Fields" column in Table 1 have been modified. The enabledctrlschanges field specifies which bits in the enabledctrls field have changed. If the number of keyboard groups has changed, the numgroupschanged field is set to True. 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 to specify general modifications to the parameters used to configure the control (which), and to enable and disable the control (enabledctrls). The anomalies in the table (no "ok" in column) are for controls that have no configurable attributes; and for controls that are not boolean controls and therefore cannot be enabled or disabled. Table 1 Xkb Controls ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Control Control Selection Relevant Mask XkbControlsRec Boolean Control (which parameter) DataFields enabledctrls bit Section ─────────────────────────────────────────────────────────────────────────────────── AccessXFeedback XkbAccessXFeed‐ axoptions: XkbAccessXFeedbackMask 10.6.3 backMask XkbAX*FBMask AccessXKeys XkbAccessXKeysMask 10.6.1 AccessXTimeout XkbAccessXTime‐ axtimeout XkbAccessXTimeoutMask 10.6.2 outMask axtoptsmask axtoptsvalues axtctrlsmask axtctrlsvalues AudibleBell XkbAudibleBellMask 9.2 AutoReset 10.1.2 BounceKeys XkbBounceKeysMask debouncedelay XkbBounceKeysMask 10.6.7
Detectable- 10.3.3 Autorepeat
EnabledControls XkbControlsEn‐ enabledctrls Non-Boolean Control 10.1.1 abledMask
GroupsWrap XkbGroupsWrapMask groupswrap Non-Boolean Control 10.7.1 IgnoreGroupLock XkbIgnoreGroupLockMask 10.7.3
IgnoreLockMods XkbIgnoreLock‐ ignorelock Non-Boolean Control 5.1 ModsMask
InternalMods XkbInternalMods‐ internal Non-Boolean Control 5.1 Mask MouseKeys XkbMouseKeysMask mkdfltbtn XkbMouseKeysMask 10.5.1 MouseKeysAccel XkbMouseKeysAc‐ mkdelay XkbMouseKeysAccelMask 10.5.2 celMask mkinterval mktimetomax mkmaxspeed mkcurve Overlay1 XkbOverlay1Mask 10.4 Overlay2 XkbOverlay2Mask 10.4
PerKeyRepeat XkbPerKeyRepeat‐ perkeyrepeat Non-Boolean Control 10.3.1 Mask RepeatKeys XkbRepeatKeysMask repeatdelay XkbRepeatKeysMask 10.3 repeatinterval SlowKeys XkbSlowKeysMask slowkeysdelay XkbSlowKeysMask 10.6.6 StickyKeys XkbStickyKeysMask axoptions: XkbStickyKeysMask 10.6.8 XkbAXTwoKeysMask XkbAXLatchToLockMask Table 2 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 to specify general modifications to the parameters used to configure the control (which), and to enable and disable the control (enabledctrls). The anomalies in the table (no "ok" in column) are for controls that have no configurable attributes; and for controls that are not boolean controls and therefore cannot be enabled or disabled. c s s s l l l l l l l l l l l l. Table 2 Controls Mask Bits ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── Mask Bit which or enabled Value changedctrls ctrls ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────── XkbRepeatKeysMask ok ok (1L<<0) XkbSlowKeysMask ok ok (1L<<1) 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) If you have an Xkb description with controls that have been modified and an XkbControlsChangesRec that describes the changes that have been made, the XkbChangeControls function provides a flexible method for updating the controls in a server to match those in the changed key‐ board description. XkbChangeControls copies any controls fields specified by changes from
the keyboard description controls structure, xkb->ctrls, to the server specified by dpy. STRUCTURES The XkbControlsChangesRec structure is defined as follows: typedef struct XkbControlsChanges { unsigned int changedctrls; /∗ bits indicating changed control data */ unsigned int enabledctrlschanges; /∗ bits indicating enabled/disabled controls */ Bool numgroupschanged; /∗ True if number of keyboard groups changed */ } XkbControlsChangesRec,*XkbControlsChangesPtr; X Version 11 libX11 1.6.5 XkbChangeControls(3)