XkbAddGeomOverlayKey(3)

💅 XkbAddGeomOverlayKey(3) 💅

welcome to the XKB FUNCTIONS corner of the manual, bestie 🫶 — this page is all about XkbAddGeomOverlayKey, and we’re gonna make it make sense. no cap.

---

🎀 NAME 🎀

XkbAddGeomOverlayKey — add a key to an existing overlay row. That’s it, that’s the assignment: one more key slides into an overlay row that’s already there. slay. ✨

✨ SYNOPSIS ✨

       XkbOverlayKeyPtr XkbAddGeomOverlayKey (XkbOverlayPtr overlay, XkbRowPtr
              row, _Xconst char *over, _Xconst char *under);

🌸 ARGUMENTS 🌸

• overlay — the overlay to be updated. 💅
• row — the row in the overlay to be updated. 🎀
• under — the primary name of the key to be considered. 🦋

also, yes, over is right there in the synopsis — the ARGUMENTS list on this page doesn’t give it its own separate blurb, so I’m not making one up, bestie. 🙈

💖 DESCRIPTION 💖

okay so Xkb provides functions to add a single new element to the top-level keyboard geometry. In each case, the num_ * fields of the corresponding structure are incremented by 1 — one whole increment, no cap. These functions do not change sz_* unless there is no more room in the array. Some of these functions fill in the values of the element’s structure from the arguments. For other functions, you must explicitly write code to fill the structure’s elements. so sometimes it’s giving “handled,” and sometimes you’re the main character writing the fill-in yourself. 😭

The top-level geometry description includes a list of geometry properties. A geometry property associates an arbitrary string with an equally arbitrary name. Programs that display images of keyboards can use geometry properties as hints, but they are not interpreted by Xkb. No other geometry structures refer to geometry properties. literally just lil hint vibes for display programs — iconic, but not Xkb’s business. ✨

XkbAddGeomOverlayKey adds one key to the row in the overlay. If there is no key named under in the row of the underlying section, XkbAddGeomOverlayKey returns NULL. that’s the plot twist, bestie — no under, no key, just NULL. 💀

🦋 STRUCTURES 🦋

here’s the struct, exactly as the page gives it — code is sacred, so we’re not touching a single character: 🫶

           typedef struct _XkbOverlayKey {
               XkbKeyNameRec           over;      /* name of this overlay key */
               XkbKeyNameRec           under;     /* name of the key under this overlay key */
           } XkbOverlayKeyRec,*XkbOverlayKeyPtr;

---

okay that’s the whole page, bestie 🫶💖 — it comes from X Version 11, libX11 1.8.14, and the footer tag is XkbAddGeomOverlayKey(3). the footer doesn’t show a date, so I’m not inventing one — just source/version and the page tag, periodt. 💅✨