Christopher J. Madsen > PostScript-Report-0.10 > PostScript::Report::LinkField

Download:
PostScript-Report-0.10.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.10   Source   Latest Release: PostScript-Report-0.13

NAME ^

PostScript::Report::LinkField - A field that can contain hyperlinks

VERSION ^

This document describes version 0.10 of PostScript::Report::LinkField, released April 4, 2012 as part of PostScript-Report version 0.10.

DESCRIPTION ^

This Component is a text field that can contain hyperlinks. It's intended for use when the report will be converted to a PDF file.

Note: While you may use a LinkField as a label by giving it a constant value, it always uses font to draw the text, not label_font.

The hyperlink syntax is a tiny subset of Markdown syntax (http://daringfireball.net/projects/markdown/syntax). Only the following codes are recognized:

  [link text](URL)
  <SCHEME:URL>     (e.g. <http://perl.org>)
  <EMAIL@DOMAIN>

The angle bracket forms cannot contain whitespace, or they will not be recognized. If you want angle brackets surrounding the link in the text, use two angle brackets: <<EMAIL@DOMAIN>>.

You can escape any character by preceding it with a backslash. The only character that must always be escaped is \. You only need to escape [ and < if they would otherwise appear to start a hyperlink.

ATTRIBUTES ^

A LinkField has all the normal component attributes, including padding_bottom, padding_side, and value.

It also has the following attributes, whose values may be inherited.

link_color

This is the color used by hyperlinks (default #00F, meaning blue). See "Color" in PostScript::Report::Types.

text_color

This is the color used by regular text (default 0, meaning black).

underline

If set to a true value, hyperlinks will be underlined. The default is true.

INCOMPATIBILITIES ^

None reported.

BUGS AND LIMITATIONS ^

No bugs have been reported.

AUTHOR ^

Christopher J. Madsen <perl AT cjmweb.net>

Please report any bugs or feature requests to <bug-PostScript-Report AT rt.cpan.org> or through the web interface at http://rt.cpan.org/Public/Bug/Report.html?Queue=PostScript-Report.

You can follow or contribute to PostScript-Report's development at http://github.com/madsen/postscript-report.

ACKNOWLEDGMENTS ^

I'd like to thank Micro Technology Services, Inc. http://www.mitsi.com, who sponsored development of PostScript-Report, and fREW Schmidt, who recommended me for the job. It wouldn't have happened without them.

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2012 by Christopher J. Madsen.

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

DISCLAIMER OF WARRANTY ^

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENSE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

syntax highlighting: