PDF::API2::Lite.3pm

Langue: en

Autres versions - même langue

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

Section: 3 (Bibliothèques de fonctions)

NAME

PDF::API2::Lite - lite pdf creation

SYNOPSIS

     $pdf = PDF::API2::Lite->new;
     $pdf->page(595,842);
     $img = $pdf->image('some.jpg');
     $font = $pdf->corefont('Times-Roman');
     $font = $pdf->ttfont('TimesNewRoman.ttf');
 
 

METHODS

PDF::API2::Lite

$pdf = PDF::API::Lite->new
$pdf->page
$pdf->page $width,$height
$pdf->page $llx, $lly, $urx, $ury
Opens a new page.
$pdf->mediabox $w, $h
$pdf->mediabox $llx, $lly, $urx, $ury
Sets the global mediabox.
$pdf->saveas $file
Saves the document (may not be modified later) and deallocates the pdf-structures.
$font = $pdf->corefont $fontname
Returns a new or existing adobe core font object.

Examples:

     $font = $pdf->corefont('Times-Roman');
     $font = $pdf->corefont('Times-Bold');
     $font = $pdf->corefont('Helvetica');
     $font = $pdf->corefont('ZapfDingbats');
 
 
$font = $pdf->ttfont $ttfile
Returns a new or existing truetype font object.

Examples:

     $font = $pdf->ttfont('TimesNewRoman.ttf');
     $font = $pdf->ttfont('/fonts/Univers-Bold.ttf');
     $font = $pdf->ttfont('../Democratica-SmallCaps.ttf');
 
 
$font = $pdf->psfont $pfb, $afm, $encoding
Returns a new type1 font object.

Examples:

     $font = $pdf->psfont('TimesRoman.pfb','TimesRoman.afm','latin1');
     $font = $pdf->psfont('/fonts/Univers.pfb','/fonts/Univers.afm','latin2');
 
 
$egs = $pdf->create_egs
Returns a new extended-graphics-state object.

Examples:

     $egs = $pdf->create_egs;
 
 
$img = $pdf->image_jpeg $file
Returns a new jpeg-image object.
$img = $pdf->image_png $file
Returns a new png-image object.
$img = $pdf->image_tiff $file
Returns a new tiff-image object.
$img = $pdf->image_pnm $file
Returns a new pnm-image object.
$pdf->savestate
Saves the state of the page.
$pdf->restorestate
Restores the state of the page.
$pdf->egstate $egs
Sets extended-graphics-state.
$pdf->fillcolor $color
Sets fillcolor.
$pdf->strokecolor $color
Sets strokecolor.

Defined color-names are:

     aliceblue, antiquewhite, aqua, aquamarine, azure, beige, bisque, black, blanchedalmond,
     blue, blueviolet, brown, burlywood, cadetblue, chartreuse, chocolate, coral, cornflowerblue,
     cornsilk, crimson, cyan, darkblue, darkcyan, darkgoldenrod, darkgray, darkgreen, darkgrey,
     darkkhaki, darkmagenta, darkolivegreen, darkorange, darkorchid, darkred, darksalmon,
     darkseagreen, darkslateblue, darkslategray, darkslategrey, darkturquoise, darkviolet,
     deeppink, deepskyblue, dimgray, dimgrey, dodgerblue, firebrick, floralwhite, forestgreen,
     fuchsia, gainsboro, ghostwhite, gold, goldenrod, gray, grey, green, greenyellow, honeydew,
     hotpink, indianred, indigo, ivory, khaki, lavender, lavenderblush, lawngreen, lemonchiffon,
     lightblue, lightcoral, lightcyan, lightgoldenrodyellow, lightgray, lightgreen, lightgrey,
     lightpink, lightsalmon, lightseagreen, lightskyblue, lightslategray, lightslategrey,
     lightsteelblue, lightyellow, lime, limegreen, linen, magenta, maroon, mediumaquamarine,
     mediumblue, mediumorchid, mediumpurple, mediumseagreen, mediumslateblue, mediumspringgreen,
     mediumturquoise, mediumvioletred, midnightblue, mintcream, mistyrose, moccasin, navajowhite,
     navy, oldlace, olive, olivedrab, orange, orangered, orchid, palegoldenrod, palegreen,
     paleturquoise, palevioletred, papayawhip, peachpuff, peru, pink, plum, powderblue, purple,
     red, rosybrown, royalblue, saddlebrown, salmon, sandybrown, seagreen, seashell, sienna,
     silver, skyblue, slateblue, slategray, slategrey, snow, springgreen, steelblue, tan, teal,
     thistle, tomato, turquoise, violet, wheat, white, whitesmoke, yellow, yellowgreen
 
 

or the rgb-hex-notation:

     #rgb, #rrggbb, #rrrgggbbb and #rrrrggggbbbb
 
 

or the cmyk-hex-notation:

     %cmyk, %ccmmyykk, %cccmmmyyykkk and %ccccmmmmyyyykkkk
 
 

or the hsl-hex-notation:

     &hsl, &hhssll, &hhhssslll and &hhhhssssllll
 
 

and additionally the hsv-hex-notation:

     !hsv, !hhssvv, !hhhsssvvv and !hhhhssssvvvv
 
 
$pdf->linedash @dash
Sets linedash.
$pdf->linewidth $width
Sets linewidth.
$pdf->transform %opts
Sets transformations (eg. translate, rotate, scale, skew) in pdf-canonical order.

Example:

     $pdf->transform(
         -translate => [$x,$y],
         -rotate    => $rot,
         -scale     => [$sx,$sy],
         -skew      => [$sa,$sb],
     )
 
 
$pdf->move $x, $y
$pdf->line $x, $y
$pdf->curve $x1, $y1, $x2, $y2, $x3, $y3
$pdf->arc $x, $y, $a, $b, $alfa, $beta, $move
$pdf->ellipse $x, $y, $a, $b
$pdf->circle $x, $y, $r
$pdf->rect $x,$y, $w,$h
$pdf->rectxy $x1,$y1, $x2,$y2
$pdf->poly $x1,$y1, ..., $xn,$yn
$pdf->close
$pdf->stroke
$pdf->fill
$pdf->fillstroke
$pdf->image $imgobj, $x,$y, $w,$h
$pdf->image $imgobj, $x,$y, $scale
$pdf->image $imgobj, $x,$y
Please Note: The width/height or scale given is in user-space coordinates which is subject to transformations which may have been specified beforehand.

Per default this has a 72dpi resolution, so if you want an image to have a 150 or 300dpi resolution, you should specify a scale of 72/150 (or 72/300) or adjust width/height accordingly.

$pdf->textstart
$pdf->textfont $fontobj,$size
$txt->textlead $leading
$pdf->text $string
Applys the given text.
$pdf->nl
$pdf->textend
$pdf->print $font, $size, $x, $y, $rot, $just, $text
Convenience wrapper for shortening the textstart..textend sequence.

AUTHOR

alfred reibenschuh

HISTORY

     $Log: Lite.pm,v $
     Revision 2.1  2007/05/08 18:32:09  areibens
     renamed compress to compressFlate
 
     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.12  2005/06/17 19:43:47  fredo
     fixed CPAN modulefile versioning (again)
 
     Revision 1.11  2005/06/17 18:53:33  fredo
     fixed CPAN modulefile versioning (dislikes cvs)
 
     Revision 1.10  2005/03/14 22:01:05  fredo
     upd 2005
 
     Revision 1.9  2005/02/28 18:00:06  fredo
     removed color method since businesscolor is not available anymore in PDF::API2
 
     Revision 1.8  2004/12/16 00:30:51  fredo
     added no warn for recursion
 
     Revision 1.7  2004/06/15 09:11:38  fredo
     removed cr+lf
 
     Revision 1.6  2004/06/07 19:44:12  fredo
     cleaned out cr+lf for lf
 
     Revision 1.5  2004/05/21 15:04:43  fredo
     fixed NAME pod bug for cpan indexer
 
     Revision 1.4  2003/12/08 13:05:19  Administrator
     corrected to proper licencing statement
 
     Revision 1.3  2003/11/30 17:11:55  Administrator
     merged into default
 
     Revision 1.2.2.1  2003/11/30 16:56:21  Administrator
     merged into default
 
     Revision 1.2  2003/11/30 11:32:56  Administrator
     added CVS id/log