NAME

Text::UnicodeBox::Utility

DESCRIPTION

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

EXPORTED METHODS

The following methods are exportable by name.

fetch_box_character

  my $character = fetch_box_character( vertical => 'heavy' );

Same as "find_box_unicode_name" but returns the actual symbol.

find_box_unicode_name (%spec)

Given a list of directions and styles, find a matching unicode name that can represent the symbol. Returns undefined if no such symbol exists.

The spec may contain keys like so:

up
down
left
right: Provide a style for the named direction
horizontal
vertical: These are the same as having provided 'top' & 'bottom' or 'left' and 'right'

For each key, the value may be and empty string or the string '1' to default to the style 'light'. Otherwise, the value is the style you want the line segment to be ('light', 'heavy', 'double', 'single').

normalize_box_character_parameters (%spec)

Takes the passed argument list to fetch_box_character() and normalizes the arguments in an idempotent fashion, returning the new spec list.

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>