Paul Evans > Tickit-Widget-Scroller-0.18 > Tickit::Widget::Scroller::Item::Text

Download:
Tickit-Widget-Scroller-0.18.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.18   Source  

NAME ^

Tickit::Widget::Scroller::Item::Text - add static text to a Scroller

SYNOPSIS ^

 use Tickit::Widget::Scroller;
 use Tickit::Widget::Scroller::Item::Text;

 my $scroller = Tickit::Widget::Scroller->new;

 $scroller->push(
    Tickit::Widget::Scroller::Item::Text->new( "Hello world" )
 );

DESCRIPTION ^

This implementation of Tickit::Widget::Scroller::Item displays a simple static piece of text. It will be wrapped on whitespace (characters matching the /\s/ regexp pattern).

CONSTRUCTOR ^

$item = Tickit::Widget::Scroller::Item::Text->new( $text, %opts )

Constructs a new text item, containing the given string of text. Once constructed, the item is immutable.

The following options are recognised in %opts:

indent => INT

If the text item needs to wrap, indent the second and subsequent lines by this amount. Does not apply to the first line.

METHODS ^

@chunks = $item->chunks

Returns the chunks of text displayed by this item. Each chunk is represented by an ARRAY reference of three fields, giving the text string, its width in columns, and various options

 [ $text, $width, %opts ]

Recognised options are:

pen => Tickit::Pen

Pen to render the chunk with.

linebreak => BOOL

If true, force a linebreak after this chunk; the next one starts on the following line.

AUTHOR ^

Paul Evans <leonerd@leonerd.org.uk>

syntax highlighting: