[%# # 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' %] [% 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 %] [% WRAPPER section title="SYNOPSIS" -%]

        [% tt_start_tag %] USE gd_text = GD.Text [% tt_end_tag %]

[%- END %] [% WRAPPER section title="EXAMPLES" -%]

        [% tt_start_tag %]
            USE gd_c = GD.Constants;
            USE t = GD.Text;
            x = t.set_text('Some text');
            r = t.get('width', 'height', 'char_up', 'char_down');
            r.join(":"); "\n";     # returns 54:13:13:0.
        -[% tt_end_tag %]

        [% tt_start_tag %]
            USE gd_c = GD.Constants;
            USE t = GD.Text(text => 'FooBar Banana', font => gd_c.gdGiantFont);
            t.get('width'); "\n";  # returns 117.
        -[% tt_end_tag %]

[%- END %] [% WRAPPER section title="DESCRIPTION" -%]

The GD.Text plugin provides an interface to the GD::Text module. It allows attributes of strings such as width and height in pixels to be computed.

See [% ttlink('GD::Text') -%] for more details. See [% ttlink('Template::Plugin::GD::Text::Align') -%] and [% ttlink('Template::Plugin::GD::Text::Wrap') -%] for plugins that allow you to render aligned or wrapped text in GD images.

[%- END %] [% WRAPPER section title="AUTHOR" -%]

Craig Barratt <craig@arraycomm.com>

The GD::Text module was written by Martien Verbruggen.

[%- END %] [% WRAPPER section title="VERSION" -%]

1.56, distributed as part of the Template Toolkit version 2.14, released on 04 October 2004.

[%- END %] [% WRAPPER section title="COPYRIGHT" -%]

Copyright (C) 2001 Craig Barratt <craig@arraycomm.com>

GD::Text is copyright 1999 Martien Verbruggen.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

[%- END %] [% WRAPPER section title="SEE ALSO" -%]

[% ttlink('Template::Plugin', 'Template::Plugin') -%], [% ttlink('Template::Plugin::GD', 'Template::Plugin::GD') -%], [% ttlink('Template::Plugin::GD::Text::Wrap', 'Template::Plugin::GD::Text::Wrap') -%], [% ttlink('Template::Plugin::GD::Text::Align', 'Template::Plugin::GD::Text::Align') -%], [% ttlink('GD', 'GD') -%], [% ttlink('GD::Text', 'GD::Text') -%]

[%- END %]