The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Tickit::Widget::VLine - a widget displaying a vertical line

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;

DESCRIPTION

This class provides a widget which displays a single vertical line, using line-drawing characters. It consumes the full height of the window given to it by its parent. By default it is drawn in the horizontal centre of the window but this can be adjusted by 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. Must be one of the LINE_* constants from Tickit::RenderBuffer.

align => NUM | STR

A fraction giving a position within the window to draw the line. Defaults to 0.5, which puts it in the centre.

Symbolic names of left, centre and right are also accepted.

CONSTRUCTOR

new

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

Constructs a new Tickit::Widget::VLine object.

AUTHOR

Paul Evans <leonerd@leonerd.org.uk>