XkbRefreshKeyboardMapping(3)

📦
version 1.8.14 · 8 versions
, in alpine 3.24, arch rolling, nixos 26.05, nixpkgs unstable

💅 XkbRefreshKeyboardMapping(3) — from the XKB FUNCTIONS manual, bestie

okay so picture this: your keyboard description inside the X library is looking a lil stale, and you need it to refresh, and this function right here is the one that does it. welcome to the glow-up page, let's go ✨

🌸 NAME 🌸

XkbRefreshKeyboardMapping — update the keyboard description that is internal to the X library

like literally, it's the internal-to-X-library keyboard desc getting its refresh on 🫶

✨ SYNOPSIS ✨

Status XkbRefreshKeyboardMapping (XkbMapNotifyEvent *event);

🎀 ARGUMENTS 🎀

  • event — the event that's initiating the remapping. it's giving "the thing that started all this" 💅

🦋 DESCRIPTION 🦋

okay so XkbRefreshKeyboardMapping is the Xkb equivalent of the core XRefreshKeyboardMapping function. no cap. it requests that the X server send the current key mapping information to this client. 🫶

a client usually invokes XkbRefreshKeyboardMapping after receiving an XkbMapNotify event. that's the standard move, bestie. 👑

XkbRefreshKeyboardMapping returns Success if it succeeds and BadMatch if the event is not an Xkb event. so if you hand it something that isn't an Xkb event? it's gonna hit you with that BadMatch, sorry not sorry 😭

and here's the tea on where that XkbMapNotify event even comes from: it can be generated when some client calls XkbSetMap, XkbChangeMap, XkbGetKeyboardByName, or any of the standard X library functions that change the keyboard mapping or modifier mapping. so basically a whole lil squad of functions can set it off — know the whole roster, iykyk 🔥

⭐ RETURN VALUES ⭐

  • Success — XkbRefreshKeyboardMapping returns Success when the request that the X server send the current key mapping information to this client is successful. ate, no notes 💖

💀 DIAGNOSTICS 💀

  • BadMatch — a compatible version of Xkb was not available in the server, or an argument has correct type and range but is otherwise invalid. two very different heartbreaks, same error name 🙈

🌈 SEE ALSO 🌈

👑 sign-off 👑

okay that's the whole page, bestie, go refresh those mappings responsibly 🧚 and just so you have the receipts: this was X Version 11, libX11 1.8.14, and yes — XkbRefreshKeyboardMapping(3) — periodt 💜🎀

📦 where this page comes from