/ 
UI-Various-0.05
River stage one • 1 direct dependent • 1 total dependent
/ UI::Various::RichTerm::Text

NAME

UI::Various::RichTerm::Text - concrete implementation of UI::Various::Text

SYNOPSIS

# This module should never be used directly!
# It is used indirectly via the following:
use UI::Various::Text;

ABSTRACT

This module is the specific implementation of UI::Various::Text using the rich terminal UI.

DESCRIPTION

The documentation of this module is only intended for developers of the package itself.

METHODS

_prepare - prepare UI element

($width, $height) = $ui_element->_prepare($content_width);

example:

my ($w, $h) = $_->_prepare($content_width);
$width < $w  and  $width = $w;
$height += $h;

parameters:

$content_width      preferred width of content

description:

Prepare output of the UI element by determining and returning the space it wants or needs. The method should only be called from UI::Various::Curses container elements!

returns:

width and height the UI element will require or need when printed

_show - return formatted UI element

$string = $ui_element->_show($prefix, $width, $height);

example:

my ($w, $h) = $_->_prepare($content_width);
...
$_->_show('    ', $w, $h, $my_width, 0);

parameters:

$prefix             text in front of first line
$width              the width returned by _prepare above
$height             the height returned by _prepare above

description:

Return the formatted (rectangular) text box of the UI element. Its height will be exactly as specified, unless there hasn't been enough space. The weight is similarly as specified plus the width needed for the prefix. The method should only be called from UI::Various::RichTerm container elements!

returns:

the rectangular text box for UI element

SEE ALSO

UI::Various, UI::Various::Text

LICENSE

Copyright (C) Thomas Dorner.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See LICENSE file for more details.

AUTHOR

Thomas Dorner <dorner@cpan.org>