PDF::API2::Annotation.3pm

Langue: en

Autres versions - même langue

Version: 2009-04-03 (debian - 07/07/09)

Section: 3 (Bibliothèques de fonctions)

Sommaire

NAME

PDF::API2::Annotation - annotation management

$ant = PDF::API2::Annotation->new

Returns a annotation object (called from $page->annotation).
$ant->link $page, %opts
Defines the annotation as launch-page with page $page and options %opts (-rect, -border or 'dest-options').
$ant->url $url, %opts
Defines the annotation as launch-url with url $url and options %opts (-rect and/or -border).
$ant->file $file, %opts
Defines the annotation as launch-file with filepath $file and options %opts (-rect and/or -border).
$ant->pdfile $pdfile, $pagenum, %opts
Defines the annotation as pdf-file with filepath $pdfile, $pagenum and options %opts (same as dest).
$ant->text $text, %opts
Defines the annotation as textnote with content $text and options %opts (-rect and/or -open).
$ant->movie $file, $contentype, %opts
Defines the annotation as a movie from $file with $contentype and options %opts (-rect).
$ant->rect $llx, $lly, $urx, $ury
Sets the rectangle of the annotation.
$ant->border @b
Sets the border-styles of the annotation, if applicable.
$ant->content @lines
Sets the text-content of the annotation, if applicable.
$ant->open $bool
Display the annotation either open or closed, if applicable.
$ant->dest( $page, -fit => 1 )
Display the page designated by page, with its contents magnified just enough to fit the entire page within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the page within the window in the other dimension.
$ant->dest( $page, -fith => $top )
Display the page designated by page, with the vertical coordinate top positioned at the top edge of the window and the contents of the page magnified just enough to fit the entire width of the page within the window.
$ant->dest( $page, -fitv => $left )
Display the page designated by page, with the horizontal coordinate left positioned at the left edge of the window and the contents of the page magnified just enough to fit the entire height of the page within the window.
$ant->dest( $page, -fitr => [ $left, $bottom, $right, $top ] )
Display the page designated by page, with its contents magnified just enough to fit the rectangle specified by the coordinates left, bottom, right, and top entirely within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the rectangle within the window in the other dimension.
$ant->dest( $page, -fitb => 1 )
(PDF 1.1) Display the page designated by page, with its contents magnified just enough to fit its bounding box entirely within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the bounding box within the window in the other dimension.
$ant->dest( $page, -fitbh => $top )
(PDF 1.1) Display the page designated by page, with the vertical coordinate top positioned at the top edge of the window and the contents of the page magnified just enough to fit the entire width of its bounding box within the window.
$ant->dest( $page, -fitbv => $left )
(PDF 1.1) Display the page designated by page, with the horizontal coordinate left positioned at the left edge of the window and the contents of the page magnified just enough to fit the entire height of its bounding box within the window.
$ant->dest( $page, -xyz => [ $left, $top, $zoom ] )
Display the page designated by page, with the coordinates (left, top) positioned at the top-left corner of the window and the contents of the page magnified by the factor zoom. A zero (0) value for any of the parameters left, top, or zoom specifies that the current value of that parameter is to be retained unchanged.
$ant->dest( $name )
(PDF 1.2) Connect the Annotation to a ``Named Destination'' defined elswere.

AUTHOR

alfred reibenschuh

HISTORY

     $Log: Annotation.pm,v $
     Revision 2.1  2007/10/02 19:59:37  areibens
     added movie annotation
 
     Revision 2.0  2005/11/16 02:16:00  areibens
     revision workaround for SF cvs import not to screw up CPAN
 
     Revision 1.2  2005/11/16 01:27:48  areibens
     genesis2
 
     Revision 1.1  2005/11/16 01:19:24  areibens
     genesis
 
     Revision 1.21  2005/06/17 19:43:46  fredo
     fixed CPAN modulefile versioning (again)
 
     Revision 1.20  2005/06/17 18:53:04  fredo
     fixed CPAN modulefile versioning (dislikes cvs)
 
     Revision 1.19  2005/06/14 12:55:59  fredo
     fixed typo for text annotation leaving it empty
 
     Revision 1.18  2005/03/14 22:01:05  fredo
     upd 2005
 
     Revision 1.17  2005/01/03 05:00:27  fredo
     changed default behavior of border
 
     Revision 1.16  2005/01/03 04:17:24  fredo
     fixed link bug
 
     Revision 1.15  2005/01/03 03:29:31  fredo
     removed code duplication
 
     Revision 1.14  2005/01/03 00:30:31  fredo
     added named destination support
 
     Revision 1.13  2004/12/16 00:30:51  fredo
     added no warn for recursion
 
     Revision 1.12  2004/10/13 18:30:34  fredo
     fixed pdfile method from utf8 back to ascii
 
     Revision 1.11  2004/10/11 07:54:24  fredo
     fixed file method from utf8 back to ascii
 
     Revision 1.10  2004/10/01 01:20:35  fredo
     fixed url link annotation to 7-bit ascii as per pdf-spec-1.5
 
     Revision 1.9  2004/06/15 09:11:37  fredo
     removed cr+lf
 
     Revision 1.8  2004/06/07 19:43:58  fredo
     cleaned out cr+lf for lf
 
     Revision 1.7  2004/02/22 23:55:49  fredo
     full utf8 awareness
 
     Revision 1.6  2004/02/05 13:33:18  fredo
     added unicode handling to strings
 
     Revision 1.5  2003/12/08 13:05:18  Administrator
     corrected to proper licencing statement
 
     Revision 1.4  2003/12/08 11:55:17  Administrator
     change for proper module versioning
 
     Revision 1.3  2003/11/30 17:08:11  Administrator
     merged into default