XkbChangeControls - Man Page

Provides a flexible method for updating the controls in a server to match those in the changed keyboard description

Synopsis

Bool XkbChangeControls (Display *dpy, XkbDescPtr xkb, XkbControlsChangesPtr 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 modifications  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  XkbControlsRec structure, then  subsequently used to cause all of the changes, and only the changes, to be  propagated to the server.

The changed_ctrls 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 changed_ctrls are any combination of the masks listed in Table 1 that have "ok" in the changed_ctrls column. Setting a bit implies the corresponding data fields from the "Relevant  XkbControlsRec Data  Fields" column in Table 1 have been modified. The enabled_ctrls_changes field specifies which bits in the enabled_ctrls field have changed. If the number of keyboard groups has changed, the num_groups_changed 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 (enabled_ctrls). 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
ControlControl
SelectionRelevant
Mask (whichXkbControlsRecBoolean Control
parameter)DataFieldsenabled_ctrls bitSection
AccessXFeedbackXkbAccessXFeedbackMaskax_options:
 XkbAX_*FBMask
XkbAccessXFeedbackMask10.6.3
AccessXKeysXkbAccessXKeysMask10.6.1
AccessXTimeoutXkbAccessXTimeoutMaskax_timeout axt_opts_mask axt_opts_values axt_ctrls_mask axt_ctrls_valuesXkbAccessXTimeoutMask10.6.2
AudibleBellXkbAudibleBellMask9.2
AutoReset10.1.2
BounceKeysXkbBounceKeysMaskdebounce_delayXkbBounceKeysMask10.6.7
Detectable-10.3.3
Autorepeat
EnabledControlsXkbControlsEnabledMaskenabled_ctrlsNon-Boolean Control10.1.1
GroupsWrapXkbGroupsWrapMaskgroups_wrapNon-Boolean Control10.7.1
IgnoreGroupLockXkbIgnoreGroupLockMask10.7.3
IgnoreLockModsXkbIgnoreLockModsMaskignore_lockNon-Boolean Control5.1
InternalModsXkbInternalModsMaskinternalNon-Boolean Control5.1
MouseKeysXkbMouseKeysMaskmk_dflt_btnXkbMouseKeysMask10.5.1
MouseKeysAccelXkbMouseKeysAccelMaskmk_delay mk_interval mk_time_to_max mk_max_speed mk_curveXkbMouseKeysAccelMask10.5.2
Overlay1XkbOverlay1Mask10.4
Overlay2XkbOverlay2Mask10.4
PerKeyRepeatXkbPerKeyRepeatMaskper_key_repeatNon-Boolean Control10.3.1
RepeatKeysXkbRepeatKeysMaskrepeat_delayXkbRepeatKeysMask10.3
repeat_interval
SlowKeysXkbSlowKeysMaskslow_keys_delayXkbSlowKeysMask10.6.6
StickyKeysXkbStickyKeysMaskax_options:
 XkbAX_TwoKeysMask
 XkbAX_LatchToLockMask
XkbStickyKeysMask10.6.8

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 (enabled_ctrls). 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 2 Controls Mask Bits
Mask Bitwhich orValue
changedenabled
_ctrls_ctrls
XkbRepeatKeysMaskokok(1L<<0)
XkbSlowKeysMaskokok(1L<<1)
XkbBounceKeysMaskokok(1L<<2)
XkbStickyKeysMaskokok(1L<<3)
XkbMouseKeysMaskokok(1L<<4)
XkbMouseKeysAccelMaskokok(1L<<5)
XkbAccessXKeysMaskokok(1L<<6)
XkbAccessXTimeoutMaskokok(1L<<7)
XkbAccessXFeedbackMaskokok(1L<<8)
XkbAudibleBellMaskok(1L<<9)
XkbOverlay1Maskok(1L<<10)
XkbOverlay2Maskok(1L<<11)
XkbIgnoreGroupLockMaskok(1L<<12)
XkbGroupsWrapMaskok(1L<<27)
XkbInternalModsMaskok(1L<<28)
XkbIgnoreLockModsMaskok(1L<<29)
XkbPerKeyRepeatMaskok(1L<<30)
XkbControlsEnabledMaskok(1L<<31)
XkbAccessXOptionsMaskokok(XkbStickyKeysMask |
XkbAccessXFeedbackMask)
XkbAllBooleanCtrlsMaskok(0x00001FFF)
XkbAllControlsMaskok(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  keyboard 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  changed_ctrls;         /∗ bits indicating changed control data 
*/
    unsigned int  enabled_ctrls_changes; /∗ bits indicating enabled/disabled 
controls */
    Bool          num_groups_changed;    /∗ True if number of keyboard groups 
changed */
} XkbControlsChangesRec,*XkbControlsChangesPtr;

Info

libX11 1.7.0 X Version 11 XKB FUNCTIONS