Eric Waters > Text-UnicodeBox > Text::UnicodeBox::Control

Download:
Text-UnicodeBox-0.03.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Source  

NAME ^

Text::UnicodeBox::Control - Objects to describe and control rendering

DESCRIPTION ^

This module is part of the low level interface to Text::UnicodeBox; you probably don't need to use it directly.

METHODS ^

new (%params)

style

The style of this line. 'light', 'double' or 'heavy' are the main style names. See the unicode box table for all the names.

position

Takes 'start', 'rule', or 'end'

top

Currently this only makes sense with a position of 'start'. Indicates that the box to follow should have a line drawn above it. The value is the style (light, double, heavy)

bottom

Same as top but for a line below.

EXPORTED METHODS ^

The following methods are exportable by name or by the tag ':all'

BOX_START (%params)

Same as new with a position of 'start'

BOX_RULE (%params)

Same as new with a position of 'rule'

BOX_END (%params)

Same as new with a position of 'end'

to_string (\%context)

Return a string representing the rendering of this control part. Pass a hashref to this and all other calls within the same context to allow this to share styles with other objects.

COPYRIGHT ^

Copyright (c) 2012 Eric Waters and Shutterstock Images (http://shutterstock.com). All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

The full text of the license can be found in the LICENSE file included with this module.

AUTHOR ^

Eric Waters <ewaters@gmail.com>

syntax highlighting: