KeyMap(3U)

💅 KeyMap(3U) — it's giving "press a key, get a control" energy 🎀

okay bestie, welcome to the InterViews Reference Manual, Unidraw chapter, and today's main character is KeyMap — the lil guy that activates controls given their keyboard equivalents. 🦋

✨ SYNOPSIS ✨

#include <Unidraw/keymap.h>

like, that's it. that's the include. go off. 💖

🌸 DESCRIPTION 🌸

so KeyMap supports keyboard equivalents, which is the whole vibe where the user of a Unidraw application can execute menu commands or select from a palette of controls by typing instead of pointing and clicking with the mouse. no cap, keyboard supremacy. ⌨️👑

The KeyMap can activate a control given its key code as defined by its ControlInfo object. Only those controls registered with the KeyMap can be activated through the KeyMap — so if you didn't register, you're not getting in, it's giving exclusive guest list. 💅

By default, the Editor base class handles key events by having its KeyMap execute the key code. default behavior, iconic, no notes. ✨

🎀 PUBLIC OPERATIONS 🎀

• KeyMap() — construct a new keymap, initially with no registrants. brand new, empty, zero friends, we love a fresh start. 🙈
• void Register(UControl*)
• void Register(KeyMap*)
• void Unregister(UControl*)
• void Unregister(KeyMap*) — register and unregister a control or another KeyMap. Registering a KeyMap is equivalent to registering all its registered controls individually — like, it's a whole friend group joining the party at once, slay. 🫶
• void Execute(const char* keyCode) — execute the given key code by activating the corresponding control. Each UControl contains a ControlInfo object that specifies its key code; thus the mapping between key codes and controls is defined by the ControlInfo objects collectively. so it's a team effort fr fr. 🤝

⚠️ bestie listen: key codes among registered controls should be unique. two controls claiming the same key code is not the moment, it's a vibe check failure. 💀

👀 SEE ALSO 👀

ControlInfo(3U), KeyMap(3U), UControl(3U), kybd(3U)

(yes it references itself, that's just self-love, periodt. 👑)

Unidraw · 1 August 1990 — ok that's the whole page, mwah 💋 thanks for coming to my ted talk, go register some controls and stay hydrated bestie 💖✨🌈