XkbGetAccessXTimeout(3)

💖 NAME 💖

XkbGetAccessXTimeout — ok bestie, this one queries the current AccessXTimeout options for a keyboard device. that's it, that's the job 💅

---

✨ SYNOPSIS ✨

Bool XkbGetAccessXTimeout (Display *display, unsigned int device_spec,
       unsigned short *timeout_rtrn, unsigned int *ctrls_mask_rtrn,
       unsigned int *ctrls_values_rtrn, unsigned short
       *options_mask_rtrn, unsigned short *options_values_rtrn);

look at her. six args, one Bool, absolutely serving 🫶

---

🎀 ARGUMENTS 🎀

• display — unsigned short (yes literally that's what it says, don't come for me, I'm just the messenger 🙈)
• device_spec — the device you wanna query, or XkbUseCoreKbd if you're feeling vanilla
• timeout_rtrn — backfilled with the delay until AccessXTimeout, in seconds ⏱️
• ctrls_mask_rtrn — backfilled with the controls to modify
• ctrls_values_rtrn — backfilled with the on/off status for those controls
• options_mask_rtrn — backfilled with the ax_options to modify
• options_values_rtrn — backfilled with values for ax_options

heads up: all those _rtrn ones are out params, so they get written into after the server replies. pass real pointers, bestie, not vibes.

---

🌸 DESCRIPTION 🌸

ok so picture this: shared computers. multiple people, one keyboard, chaos. and features like SlowKeys are lowkey a problem in that world — because if SlowKeys is on, the keyboard can look completely unresponsive, since keys aren't accepted until you hold them down for a certain period of time. it's giving "is my keyboard broken" when actually it's just doing its thing 😭

to fix that whole situation, Xkb gives you an AccessXTimeout control. what it does: if the keyboard is idle for a specified period of time, it automatically changes the enabled/disabled state of any boolean controls, and it can also change the value of the AccessXKeys and AccessXFeedback control attributes. automatic. no cap. 👑

and when a timeout as specified by AccessXTimeout actually occurs and a control gets modified as a result, Xkb generates an XkbControlsNotify event. so you will know, bestie.

now, what does this function actually do? XkbGetAccessXTimeout sends a request to the X server to obtain the current values for the AccessXTimeout attributes, waits for a reply, and backfills the values into the appropriate arguments. that's the whole flow: ask, wait, fill ✨

the parameters options_mask_rtrn and options_values_rtrn get backfilled with the options to modify and the values for ax_options — and ax_options is a field in the XkbControlsRec structure (scroll down, she's right there 💜).

XkbGetAccessXTimeout returns True if it's successful. but if a compatible version of the Xkb extension is not available in the server, XkbGetAccessXTimeout returns False. so always check, fr fr 🙏

---

💅 RETURN VALUES 💅

• True — returned when it successfully sends a request to the X server to obtain the current values for the AccessXTimeout attributes, waits for a reply, and backfills the values into the appropriate arguments. icon behavior, we love to see it ✨
• False — returned if a compatible version of the Xkb extension is not available in the server. sad girl hours 😭 no extension, no data.

---

🦋 STRUCTURES 🦋

the XkbControlsRec structure is defined as follows:

#define XkbMaxLegalKeyCode     255
#define XkbPerKeyBitArraySize  ((XkbMaxLegalKeyCode+1)/8)

typedef struct {
    unsigned char   mk_dflt_btn;      /* default button for keyboard driven mouse */
    unsigned char   num_groups;       /* number of keyboard groups */
    unsigned char   groups_wrap;      /* how to wrap out-of-bounds groups */
    XkbModsRec      internal;         /* defines server internal modifiers */
    XkbModsRec      ignore_lock;      /* modifiers to ignore when checking for grab */
    unsigned int    enabled_ctrls;    /* 1 bit => corresponding boolean control enabled */
    unsigned short  repeat_delay;     /* ms delay until first repeat */
    unsigned short  repeat_interval;  /* ms delay between repeats */
    unsigned short  slow_keys_delay;  /* ms minimum time key must be down to be ok */
    unsigned short  debounce_delay;   /* ms delay before key reactivated */
    unsigned short  mk_delay;         /* ms delay to second mouse motion event */
    unsigned short  mk_interval;      /* ms delay between repeat mouse events */
    unsigned short  mk_time_to_max;   /* # intervals until constant mouse move */
    unsigned short  mk_max_speed;     /* multiplier for maximum mouse speed */
    short           mk_curve;         /* determines mouse move curve type */
    unsigned short  ax_options;       /* 1 bit => Access X option enabled */
    unsigned short  ax_timeout;       /* seconds until Access X disabled */
    unsigned short  axt_opts_mask;    /* 1 bit => options to reset on Access X timeout */
    unsigned short  axt_opts_values;  /* 1 bit => turn option on, 0=> off */
    unsigned int    axt_ctrls_mask;   /* which bits in enabled_ctrls to modify */
    unsigned int    axt_ctrls_values; /* values for new bits in enabled_ctrls */
    unsigned char   per_key_repeat[XkbPerKeyBitArraySize];  /* per key auto repeat */
} XkbControlsRec, *XkbControlsPtr;

not me reading the whole struct every time like it's a menu 🍓 the fields you actually care about for this function are ax_options, ax_timeout, axt_opts_mask, axt_opts_values, axt_ctrls_mask and axt_ctrls_values. iykyk 💜

---

and that's the whole page, bestie!! 🌈 this lil masterpiece lives in X Version 11, libX11 1.8.4, and it's filed under XkbGetAccessXTimeout(3). go forth, query those timeouts, and slay 💅✨🎀🦋💖