.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Text::Flow::Wrap 3pm" .TH Text::Flow::Wrap 3pm "2022-06-28" "perl v5.34.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Text::Flow::Wrap \- Flexible word wrapping for not just ASCII output. .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Text::Flow::Wrap; \& \& # for regular ASCII usage ... \& my $wrapper = Text::Flow::Wrap\->new( \& check_width => sub { length($_[0]) < 70 }, \& ); \& \& # for non\-ASCII usage ... \& my $wrapper = Text::Flow::Wrap\->new( \& check_width => sub { $pdf\->get_text_width($_[0]) < 500 }, \& ); \& \& my $text = $wrapper\->wrap($text); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" The main purpose of this module is to provide text wrapping features without being tied down to \s-1ASCII\s0 based output and fixed-width fonts. .PP My needs were for sophisticated test control in \s-1PDF\s0 and \s-1GIF\s0 output formats in particular. .SH "METHODS" .IX Header "METHODS" .IP "\fBnew (%params)\fR" 4 .IX Item "new (%params)" This constructs a new Text::Flow::Wrap module whose \f(CW%params\fR set the values of the attributes listed below. .IP "\fBwrap ($text)\fR" 4 .IX Item "wrap ($text)" This method will accept a bunch of text, it will then return a new string which is wrapped to the expected width. .SS "Attribute Accessors" .IX Subsection "Attribute Accessors" .IP "\fBcheck_width (\e&code)\fR" 4 .IX Item "check_width (&code)" This attribute is required, and must be a \s-1CODE\s0 reference. This will be used to determine if the width of the text is appropriate. It will get as an argument, a string which is should check the width of. It should return a Boolean value, true if the string is not exceeded the max width and false if it has. .IP "\fBline_break ($str)\fR" 4 .IX Item "line_break ($str)" This is the line break character used when assembling and disassembling the text, it defaults to the newline character \f(CW\*(C`\en\*(C'\fR. .IP "\fBparagraph_boundry ($str)\fR" 4 .IX Item "paragraph_boundry ($str)" This is the paragraph boundry marker used when disassembling the text, it defaults to the string \f(CW\*(C`\en\*(C'\fR. .IP "\fBparagraph_break ($str)\fR" 4 .IX Item "paragraph_break ($str)" This is the paragraph breaker used when re-assembling the text, it defaults to the string \f(CW\*(C`\en\en\*(C'\fR. .IP "\fBword_boundry ($str)\fR" 4 .IX Item "word_boundry ($str)" This is the word boundry marker used when disassembling the text, it defaults to a single space character. .IP "\fBword_break ($str)\fR" 4 .IX Item "word_break ($str)" This is the paragraph breaker used when re-assembling the text, it defaults to a single space character. .SS "Paragraph Disassembling" .IX Subsection "Paragraph Disassembling" These methods deal with breaking up the paragraphs into its parts, which can then be processed through the re-assembling methods. .PP These methods are mostly used internally, but more sophisticated tools might need to access them as well (see Text::Flow). .IP "\fBdisassemble_paragraph\fR" 4 .IX Item "disassemble_paragraph" .PD 0 .IP "\fBdisassemble_paragraphs\fR" 4 .IX Item "disassemble_paragraphs" .PD .SS "Paragraph Reassembling" .IX Subsection "Paragraph Reassembling" These methods deal with putting the paragraph parts back together after the disassembling methods have done thier work. .PP These methods are mostly used internally, but more sophisticated tools might need to access them as well (see Text::Flow) .IP "\fBreassemble_paragraph\fR" 4 .IX Item "reassemble_paragraph" .PD 0 .IP "\fBreassemble_paragraphs\fR" 4 .IX Item "reassemble_paragraphs" .PD .SS "Introspection" .IX Subsection "Introspection" .IP "\fBmeta\fR" 4 .IX Item "meta" Returns the Moose meta object associated with this class. .SH "BUGS" .IX Header "BUGS" All complex software has bugs lurking in it, and this module is no exception. If you find a bug please either email me, or add the bug to cpan-RT. .SH "AUTHOR" .IX Header "AUTHOR" Stevan Little .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright 2007 by Infinity Interactive, Inc. .PP .PP This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.