Tickit...::VLine(3pm)

💅 Tickit::Widget::VLine — the 3pm manual page, bestie edition

okay so welcome to the Tickit::Widget::VLine page 💖 this is a Perl thing (manual section 3pm, iykyk), and it's about drawing one single vertical line on your terminal. that's it. that's the whole job. and it does it gorgeously.

---

✨ NAME ✨

Tickit::Widget::VLine — a widget displaying a vertical line 🌈

like literally just a vertical line. vertical line main character energy. slay.

---

✨ SYNOPSIS ✨

use Tickit::Widget::HBox;
use Tickit::Widget::VLine;

my $hbox = Tickit::Widget::HBox->new;

$hbox->add( ... );

$hbox->add( Tickit::Widget::VLine->new );

$hbox->add( ... );

Tickit->new( root => $hbox )->run;

see how it just... slots in between the ...s? no cap. it's giving divider. it's giving separation. 🎀

---

✨ DESCRIPTION ✨

so this class gives you a widget that displays a single vertical line, and it draws it using line-drawing characters — the fancy box-art ones, not sad little ASCII pipes. iconic behavior fr fr 💅

it consumes the full height of whatever window its parent hands it. like it takes up ALL the vertical real estate, no sharing, no compromise. periodt.

by default the line gets drawn in the horizontal centre of the window. but!! if centre isn't your vibe you can move it with the align style value 🦋

---

✨ STYLE ✨

the default style pen is used as the widget pen. 💖

the following additional style keys are used:

• line_style => INT — the style to draw the line in. it must be one of the LINE_* constants from Tickit::RenderBuffer. no random numbers, bestie, the constants or nothing 🙈
• align => NUM | STR — a fraction giving the position within the window where the line gets drawn. defaults to 0.5, which puts it dead centre 🎯

symbolic names of "left", "centre" and "right" are also accepted. so you can be all fancy and wordy about it if you want 🎀

---

✨ CONSTRUCTOR ✨

🌸 new

$vline = Tickit::Widget::VLine->new( %args );

constructs a new Tickit::Widget::VLine object. that's the whole thing. hand it your %args, get a line. obsessed. ⭐

---

✨ AUTHOR ✨

Paul Evans <leonerd@leonerd.org.uk> 👑

the legend who made the line happen.

---

no cap: this whole page was perl v5.40.0, dated 2024-09-16, filed under Tickit...::VLine(3pm). go draw a line, bestie 💜🦋✨