XkbAllocControls(3)

🎀 NAME 🎀

okay bestie, this is the XkbAllocControls(3) page from the XKB FUNCTIONS manual, and we're about to allocate an XkbControlsRec structure inside the XkbDescRec. slay.

• XkbAllocControls — allocates an XkbControlsRec structure in the XkbDescRec

✨ SYNOPSIS ✨

Status XkbAllocControls (XkbDescPtr xkb, unsigned int which);

🌸 ARGUMENTS 🌸

• xkb — Xkb description in which to allocate the ctrls rec
• which — mask of components of ctrls to allocate

💖 DESCRIPTION 💖

The need to allocate an XkbControlsRec structure seldom arises; Xkb creates one when an application calls XkbGetControls or a related function. For those situations where there is not an XkbControlsRec structure allocated in the XkbDescRec, allocate one by calling XkbAllocControls.

XkbAllocControls allocates the ctrls field of the xkb parameter, initializes all fields to zero, and returns Success. If the ctrls field is not NULL, XkbAllocControls simply returns Success. If xkb is NULL, XkbAllocControls reports a BadMatch error. If the ctrls field could not be allocated, it reports a BadAlloc error.

The which mask specifies the individual fields of the ctrls structure to be allocated and can contain any of the valid masks defined in Table 1. The original literally has a (SHOULD THIS COMMENT BE LEFT IN????) note right here, and yes, bestie, I'm leaving it in because the rule is keep every detail 😭. Because none of the currently existing controls have any structures associated with them, which is currently of little practical value in this call.

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 Controls Mask Bits 🦋

• XkbRepeatKeysMask — which or changed_ctrls: ok; enabled_ctrls: ok; value: (1L<<0)
• XkbSlowKeysMask — which or changed_ctrls: ok; enabled_ctrls: ok; value: (1L<<1)
• XkbBounceKeysMask — which or changed_ctrls: ok; enabled_ctrls: ok; value: (1L<<2)
• XkbStickyKeysMask — which or changed_ctrls: ok; enabled_ctrls: ok; value: (1L<<3)
• XkbMouseKeysMask — which or changed_ctrls: ok; enabled_ctrls: ok; value: (1L<<4)
• XkbMouseKeysAccelMask — which or changed_ctrls: ok; enabled_ctrls: ok; value: (1L<<5)
• XkbAccessXKeysMask — which or changed_ctrls: ok; enabled_ctrls: ok; value: (1L<<6)
• XkbAccessXTimeoutMask — which or changed_ctrls: ok; enabled_ctrls: ok; value: (1L<<7)
• XkbAccessXFeedbackMask — which or changed_ctrls: ok; enabled_ctrls: ok; value: (1L<<8)
• XkbAudibleBellMask — which or changed_ctrls: (blank); enabled_ctrls: ok; value: (1L<<9)
• XkbOverlay1Mask — which or changed_ctrls: (blank); enabled_ctrls: ok; value: (1L<<10)
• XkbOverlay2Mask — which or changed_ctrls: (blank); enabled_ctrls: ok; value: (1L<<11)
• XkbIgnoreGroupLockMask — which or changed_ctrls: (blank); enabled_ctrls: ok; value: (1L<<12)
• XkbGroupsWrapMask — which or changed_ctrls: ok; enabled_ctrls: (blank); value: (1L<<27)
• XkbInternalModsMask — which or changed_ctrls: ok; enabled_ctrls: (blank); value: (1L<<28)
• XkbIgnoreLockModsMask — which or changed_ctrls: ok; enabled_ctrls: (blank); value: (1L<<29)
• XkbPerKeyRepeatMask — which or changed_ctrls: ok; enabled_ctrls: (blank); value: (1L<<30)
• XkbControlsEnabledMask — which or changed_ctrls: ok; enabled_ctrls: (blank); value: (1L<<31)
• XkbAccessXOptionsMask — which or changed_ctrls: ok; enabled_ctrls: ok; value: (XkbStickyKeysMask | XkbAccessXFeedbackMask)
• XkbAllBooleanCtrlsMask — which or changed_ctrls: (blank); enabled_ctrls: ok; value: (0x00001FFF)
• XkbAllControlsMask — which or changed_ctrls: ok; enabled_ctrls: (blank); value: (0xF8001FFF)

🔥 RETURN VALUES 🔥

• SUCCESS — allocates the ctrls field of the xkb parameter, initializes all fields to zero
• the ctrls field is not NULL — the other return case listed

💀 DIAGNOSTICS 💀

• BadAlloc — Unable to allocate storage
• BadMatch — A compatible version of Xkb was not available in the server or an argument has correct type and range, but is otherwise invalid

👑 SEE ALSO 👑

• XkbGetControls(3)

---

that's the whole page, bestie! this footer moment is brought to you by X Version 11 and libX11 1.8.14 — mwah 💋🫶