Tickit...ignable(3pm)

✨ Tickit::WidgetRole::Alignable ✨

🎀 NAME 🎀

Tickit::WidgetRole::Alignable — bestie, this is the role that lets your widgets have adjustable alignment 💅

---

🌸 DESCRIPTION 🌸

Okay so picture this: you mix this parametric role into a Tickit::Widget subclass, and boom 💥 — now your widget knows how to align its content inside a space that might be bigger than the content itself. Main character behaviour, fr fr. 🫶

---

👑 METHODS 👑

The way this works is parametric, meaning these methods get generated onto your caller package when you import the module like this:

use Tickit::WidgetRole::Alignable
   name    => NAME,
   style   => STYLE,
   reshape => RESHAPE;

Now the parameters, bestie — read these carefully 👀

• name => STRING — Optional, lowkey. This is the name that gets swapped in for "NAME" in all the generated methods down below. If you don't pass it, it just defaults to 'align'. 💖
• dir => "h" or "v" — Also optional. This is the direction — horizontal or vertical — that the alignment is representing. It's what gets used to parse symbolic names into fractions. Defaults to 'h' if you don't say anything. 🌈
• reshape => BOOL — Optional too. If it's true, your widget gets reshaped after the value is set, by calling the "reshape" method. If it's false or just… absent? Then it only gets redrawn, via the "redraw" method. No reshape, just a lil refresh. ✨

🦋 NAME 🦋

$align = $widget->NAME;

Returns the current alignment value. That's it, that's the vibe. 💜

💅 set_NAME 💅

$widget->set_NAME( $value );

Sets the new alignment value, periodt.

You hand it a value anywhere in the range from 0.0 to 1.0, and that's how the content display gets aligned within the window. 🔥

• For vertical direction alignments, you can pass the symbolic values top, middle and bottom instead of 0.0, 0.5 and 1.0 respectively. 🍓
• For horizontal direction alignments, you can pass the symbolic values left, centre and right instead of 0.0, 0.5 and 1.0 respectively. 🌸

🧚 _NAME_allocation 🧚

( $before, $alloc, $after ) = $widget->_NAME_allocation( $value, $total );

Returns a list of three integers — yes, three — created by aligning the $value to the given alignment position within the $total. If you wanna know more, go peek at "align" in Tickit::Utils. iykyk 💫

---

⭐ AUTHOR ⭐

Paul Evans <leonerd@leonerd.org.uk> — thank you legend, we stan 👑

---

Okay that's the whole page bestie, you're officially aligned (pun absolutely intended 😭). This was Tickit...ignable(3pm), part of the User Contributed Perl Documentation, running on perl v5.40.0, dated 2024-09-16. Slay, go align something iconic 💖✨🎀