The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
[%#
  # IMPORTANT NOTE
  #   This documentation is generated automatically from source
  #   templates.  Any changes you make here may be lost.
  # 
  #   The 'docsrc' documentation source bundle is available for download
  #   from http://www.template-toolkit.org/docs.html and contains all
  #   the source templates, XML files, scripts, etc., from which the
  #   documentation for the Template Toolkit is built.
-%]
[% META book = 'Modules'
        page = 'Plugin_GD_Text_Wrap'
%]
[%  WRAPPER toc;
	PROCESS tocitem 
	        title ="SYNOPSIS"
                subs  = [];
	PROCESS tocitem 
	        title ="EXAMPLES"
                subs  = [];
	PROCESS tocitem 
	        title ="DESCRIPTION"
                subs  = [];
	PROCESS tocitem 
	        title ="AUTHOR"
                subs  = [];
	PROCESS tocitem 
	        title ="VERSION"
                subs  = [];
	PROCESS tocitem 
	        title ="COPYRIGHT"
                subs  = [];
	PROCESS tocitem 
	        title ="SEE ALSO"
                subs  = [];
    END
%]
<!-- Pod to HTML conversion by the Template Toolkit version 2 -->
[% WRAPPER section
    title="SYNOPSIS"
-%]<pre>    [% tt_start_tag %] USE align = GD.Text.Wrap(gd_image); [% tt_end_tag %]</pre>
[%- END %]
[% WRAPPER section
    title="EXAMPLES"
-%]<pre>    [% tt_start_tag %] FILTER null;
        USE gd  = GD.Image(200,400);
        USE gdc = GD.Constants;
        black = gd.colorAllocate(0,   0, 0);
        green = gd.colorAllocate(0, 255, 0);
        txt = &quot;This is some long text. &quot; | repeat(10);
        USE wrapbox = GD.Text.Wrap(gd,
         line_space  =&gt; 4,
         color       =&gt; green,
         text        =&gt; txt,
        );
        wrapbox.set_font(gdc.gdMediumBoldFont);
        wrapbox.set(align =&gt; 'center', width =&gt; 160);
        wrapbox.draw(20, 20);
        gd.png | stdout(1);
      END;
    -[% tt_end_tag %]</pre>
<pre>    [% tt_start_tag %] txt = BLOCK -[% tt_end_tag %]
    Lorem ipsum dolor sit amet, consectetuer adipiscing elit,
    sed diam nonummy nibh euismod tincidunt ut laoreet dolore
    magna aliquam erat volutpat.
    [% tt_start_tag %] END -[% tt_end_tag %]
    [% tt_start_tag %] FILTER null;
        #
        # This example follows the example in GD::Text::Wrap, except
        # we create a second image that is a copy just enough of the
        # first image to hold the final text, plus a border.
        #
        USE gd  = GD.Image(400,400);
        USE gdc = GD.Constants;
        green = gd.colorAllocate(0, 255, 0);
        blue  = gd.colorAllocate(0, 0, 255);
        USE wrapbox = GD.Text.Wrap(gd,
         line_space  =&gt; 4,
         color       =&gt; green,
         text        =&gt; txt,
        );
        wrapbox.set_font(gdc.gdMediumBoldFont);
        wrapbox.set(align =&gt; 'center', width =&gt; 140);
        rect = wrapbox.get_bounds(5, 5);
        x0 = rect.0;
        y0 = rect.1;
        x1 = rect.2 + 9;
        y1 = rect.3 + 9;
        gd.filledRectangle(0, 0, x1, y1, blue);
        gd.rectangle(0, 0, x1, y1, green);
        wrapbox.draw(x0, y0);
        nx = x1 + 1;
        ny = y1 + 1;
        USE gd2 = GD.Image(nx, ny);
        gd2.copy(gd, 0, 0, 0, 0, x1, y1);
        gd2.png | stdout(1);
       END;
    -[% tt_end_tag %]</pre>
[%- END %]
[% WRAPPER section
    title="DESCRIPTION"
-%]<p>
The GD.Text.Wrap plugin provides an interface to the GD::Text::Wrap
module. It allows multiples line of text to be drawn in GD images with
various wrapping and alignment.
</p>
<p>
See [% ttlink('GD::Text::Wrap') -%] for more details. See
[% ttlink('Template::Plugin::GD::Text::Align') -%] for a plugin
that allow you to draw text with various alignment
and orientation.
</p>
[%- END %]
[% WRAPPER section
    title="AUTHOR"
-%]<p>
Craig Barratt &lt;craig@arraycomm.com&gt;
</p>
<p>
The GD::Text module was written by Martien Verbruggen.
</p>
[%- END %]
[% WRAPPER section
    title="VERSION"
-%]<p>
1.43, distributed as part of the
Template Toolkit version 2.08, released on 30 July 2002.
</p>
[%- END %]
[% WRAPPER section
    title="COPYRIGHT"
-%]<p>
Copyright (C) 2001 Craig Barratt &lt;craig@arraycomm.com&gt;
</p>
<p>
GD::Text is copyright 1999 Martien Verbruggen.
</p>
<p>
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
</p>
[%- END %]
[% WRAPPER section
    title="SEE ALSO"
-%]<p>
[% ttlink('Template::Plugin', 'Template::Plugin') -%], [% ttlink('Template::Plugin::GD', 'Template::Plugin::GD') -%], [% ttlink('Template::Plugin::GD::Text::Align', 'Template::Plugin::GD::Text::Align') -%], [% ttlink('GD', 'GD') -%], [% ttlink('GD::Text::Wrap', 'GD::Text::Wrap') -%]
</p>
[%- END %]