.\" 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 3pm" .TH Text::Flow 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 \- Flexible text flowing and word wrapping for not just ASCII output. .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use Text::Flow; \& \& # use it on ASCII text ... \& my $flow = Text::Flow\->new( \& check_height => sub { \& my $paras = shift; \& sum(map { scalar @$_ } @$paras) <= 10; \& }, \& wrapper => Text::Flow::Wrap\->new( \& check_width => sub { length($_[0]) < 70 } \& ), \& ); \& \& my @sections = $flow\->flow($text); \& \& # @sections will now be an array of strings, each string \& # will contain no more than 10 lines of text each of which \& # will be no longer then 70 characters long \& \& # or use it on text in a PDF file ... \& my $flow = Text::Flow\->new( \& check_height => sub { \& my $paras = shift; \& (sum(map { scalar @$_ } @$paras) * $pdf\->get_font_height) < 200; \& }, \& wrapper => Text::Flow::Wrap\->new( \& check_width => sub { \& my $string = shift; \& $pdf\->get_string_width($string) < 100 \& }, \& ) \& ); \& \& my @sections = $flow\->flow($text); \& \& # @sections will now be an array of strings, each string \& # will contain text which will fit within 200 pts and \& # each line will be no longer then 100 pts wide .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module provides a flexible way to wrap and flow text for both \&\s-1ASCII\s0 and non-ASCII outputs. .SS "Another Text Wrap module!!?!?!" .IX Subsection "Another Text Wrap module!!?!?!" The main purpose of this module is to provide text wrapping and flowing features without being tied down to \s-1ASCII\s0 based output and fixed-width fonts. My needs were for a more sophisticated text 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 the new Text::Flow instance, and accepts parameters for the \f(CW\*(C`wrapper\*(C'\fR and \f(CW\*(C`check_height\*(C'\fR variables. .IP "\fBwrapper (?$wrapper)\fR" 4 .IX Item "wrapper (?$wrapper)" This is the accessor for the internally help Text::Flow::Wrapper instance which is used by Text::Flow to wrap the individual lines. .IP "\fBcheck_height\fR" 4 .IX Item "check_height" This is the accessor for the \s-1CODE\s0 ref which is used to check the height of the current paragraph. It gets as an argument, an array-ref of paragraphs, each of which is also an array-ref of text lines. The most common usage is shown in the \s-1SYNOPSIS\s0 above, but you can really do anything you want with them. It is expected to return a Boolean value, true if the height is still okay, and false if the max height has been reached. .IP "\fBflow ($text)\fR" 4 .IX Item "flow ($text)" This method preforms the text flowing. It returns an array of strings which can be treated as complete blocks of text. It will handle paragraph breaks and line breaks for you. .SS "Introspection" .IX Subsection "Introspection" .IP "\fBmeta\fR" 4 .IX Item "meta" Returns the Moose meta object associated with this class. .SH "TODO" .IX Header "TODO" I wanted to write some tests for using this with \s-1GD\s0 modules as well. I suppose we will have to wait until 0.02 for that. .SH "SIMILAR MODULES" .IX Header "SIMILAR MODULES" There are a bunch of other text wrapping and flowing modules out there, but they are all meant for use in \s-1ASCII\s0 outout only. This just didn't work for my needs, so I wrote this one. If you need to wrap \s-1ASCII\s0 text and want to do it in a much simpler manner then this module provides, then I suggest checking out those modules. This module is specifically made for when those other modules are no longer powerful and flexible enough. .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.