Keyboard(3pm)

💖 Keyboard(3pm) — X11::Keyboard 💖

okay bestie, so this is the manual for X11::Keyboard — keyboard support functions for X11. it's a Perl module, she's giving utility, she's giving access, and she's here to let you talk to your keyboard at the X11 level. let's get into it 🎀

---

✨ NAME ✨

X11::Keyboard — Keyboard support functions for X11. that's it, that's the girl 💅

---

🌸 SYNOPSIS 🌸

use X11::Protocol;
use X11::Keyboard;

$x = X11::Protocol->new();
$k = X11::Keyboard->new($x);
$keysym = $k->StringToKeysym("plus");
print $k->KeysymToKeycode($keysym);

# or, more simply
print $k->KeysymToKeycode("plus");

like… look at her go. set up an X connection, wrap it, and suddenly you're converting keysyms and keycodes like it's nothing. periodt. ✨

---

🦋 DESCRIPTION 🦋

so the whole point of this module is to give you access to the keyboard functions of X11. and here's the tea: the function names are basically identical to the ones in xlib — just minus the X that xlib prepends. iconic, love that for us.

BUT — and this is the important part, no cap — the parameter lists and return values are different, and they're specified right here in this document. so don't go assuming xlib habits carry over, bestie. read the doc. 💜

---

👑 METHODS 👑

An object oriented interface is provided as follows:

---

🌈 new <x-connection>

this one initialises the whole system. it needs a handle to an X connection — typically something you generated using the X11::Protocol module — and it returns an object instance. your lil baby object. so cute. 🫶

---

💫 keysym-num = StringToKeysym [keysym-name = $_]

give this method a keysym name and it hands you back the corresponding numeric value. and if you don't pass a name at all? it just uses $_. lowkey convenient. 🍓

• exempli gratia -

$c = $k->StringToKeysym("Backspace");
# $c now contains 65288

see? 65288. that's the number. she ate. 🔥

---

🧚 keycode [state] = KeysymToKeycode [keysym-[num|name] = $_]

this method returns the keycode corresponding to the keysym name or number you pass in. and if you pass neither? it uses $_. main character energy, honestly.

⚠️ okay important caveat bestie: in cases where the keysym name evaluates to a numeric value, e.g. [0-9], the caller is responsible for first converting that value to a true keysym-num. so like, that's on you, not the module. don't come for her. 😭

and plot twist — this method can also return the associated state. how does it decide? by your calling context:

• if the calling context is a list → the state is returned too 💖
• if the calling context is scalar → only the keycode is returned

so, y'know. context matters. as always. 💅

---

🌟 AUTHOR 🌟

Erick Calder <ecalder@cpan.org> 💌

---

🎀 ACKNOWLEDGEMENTS 🎀

my gratitude to Benjamin Goldberg for his patience and direction in my struggles to put this together, as well as to Somni and dkr from the OPN #perl channel. legends, all of them. 🫶✨

---

⭐ AVAILABILITY + SUPPORT ⭐

for support, e-mail the author. this module may be found on the CPAN.

additionally, both the module and its RPM package are available from:

http://perl.arix.com

go get her. 💜

---

📅 DATE 📅

$Date: 2002/12/04 05:16:01 $

---

🔥 VERSION 🔥

$Revision: 1.4 $

---

💖 LICENSE AND COPYRIGHT 💖

Copyright (c) 2002 Erick Calder. this product is distributed under the MIT License. a copy of this license was included in a file called LICENSE. and if for some reason that file was not included, please see:

http://www.opensource.org/licenses/mit-license.html

to obtain a copy of this license. k thanks bye, legal besties 🎀

---

and that's the whole page, babes 💅 this was Keyboard(3pm), generated by perl v5.28.1 on 2019-02-04 — mwah, go convert some keysyms, you've got this 🦋✨💖