Tickit...Ribbon(3pm)

💖 Tickit::Widget::Tabbed::Ribbon 💖

okay bestie, so this one's a Perl manual page — User Contributed Perl Documentation, no big deal, just the docs for a lil' Perl module. and the module is...

✨ NAME ✨

Tickit::Widget::Tabbed::Ribbon — the base class for the Tickit::Widget::Tabbed control ribbon 🎀

---

🌸 DESCRIPTION 🌸

so like. this class is where the default implementation of the control ribbon for Tickit::Widget::Tabbed lives, AND it doubles as the base class you'd build a custom ribbon on top of. two jobs, main character energy fr fr 💅

the deets about this class and how it works? genuinely useful to know when you're out here implementing your own custom control ribbon. so don't skip it 🙈

but ngl, if you're just using Tickit::Widget::Tabbed with its default control ribbon? you can fully ignore this class. not your problem, babe 💖

---

🦋 CUSTOM RIBBON CLASS 🦋

wanna make your own ribbon? slay. here's the vibe:

make a subclass of Tickit::Widget::Tabbed::Ribbon, and give it a constructor that behaves like this 👇

use Object::Pad;
class Custom::Ribbon::Class :isa(Tickit::Widget::Tabbed::Ribbon);

sub new_for_orientation   # note: Not a method
{
        my $class = shift;
        my ( $orientation, %args ) = @_;

        ...
 }

👀 notice that # note: Not a method — keep that in mind, it's literally not a method.

ok but alternatively — if you don't do that — then one of two subclasses gets used for the constructor instead, by appending ::horizontal or ::vertical onto the class name. and in that case your custom class should provide those too, bestie:

use Object::Pad;

class Custom::Ribbon::Class
       :isa(Tickit::Widget::Tabbed::Ribbon);

class Custom::Ribbon::Class::horizontal
       :isa(Custom::Ribbon::Class);

...

class Custom::Ribbon::Class::vertical
       :isa(Custom::Ribbon::Class);

...

now, how do you actually get the tabbed widget to use your class? two ways, pick your fighter 💅

option one: pass its name as a constructor argument called ribbon_class:

my $tabbed = Tickit::Widget::Tabbed->new(
        ribbon_class => "Ribbon::Class::Name"
);

option two: override a method called RIBBON_CLASS:

use constant RIBBON_CLASS => "Ribbon::Class::Name";

either one, chef's kiss 👑

---

💜 METHODS 💜

⭐ tabs

@tabs = $ribbon->tabs

$count = $ribbon->tabs

gives you a list of the contained Tickit::Widget::Tabbed tab objects when you're in list context. and in scalar context? you get the count of them instead. context is everything, iykyk ✨

⭐ active_tab_index

$index = $ribbon->active_tab_index

returns the index of the currently-active tab. the one that's got the spotlight 🔥

⭐ active_tab

$tab = $ribbon->active_tab

returns the currently-active tab as a Tickit::Widget::Tabbed tab object. that's your girl 💖

---

🌈 SUBCLASS METHODS 🌈

ok so if you're subclassing, you're gonna need to provide implementations of these. no skipping, bestie, the vibes depend on it 🫶

🎀 render

$ribbon->render( %args )

🎀 lines

$lines = $ribbon->lines

🎀 cols

$cols = $ribbon->cols

both lines and cols work as per the Tickit::Widget methods. ✨

🎀 on_key

$handled = $ribbon->on_key( $ev )

🎀 on_mouse

$handled = $ribbon->on_mouse( $ev )

also as per the Tickit::Widget methods. these two are optional though — and listen, if you don't supply them, then the ribbon simply won't respond to keyboard or mouse events. it's giving unbothered 💀

🎀 scroll_to_visible

$ribbon->scroll_to_visible( $index )

asks a scrollable control ribbon to scroll itself so that the given $index tab becomes visible. like, scoot over, we need to see this one 👀

---

👑 AUTHOR 👑

Paul Evans <leonerd@leonerd.org.uk> — thank you for your service 🫡💖

---

and that's the whole page, bestie!! this was perl v5.36.0, dated 2023-09-30, and it's the Tickit...Ribbon(3pm) page — go forth and build the cutest ribbon ever, mwah 💅✨🎀