PDF::Haru - Perl interface to Haru Free PDF Library. Haru is a free, cross platform, open-sourced software library for generating PDF.
use PDF::Haru; # create new document my $pdf = PDF::Haru::New(); # add page my $page = $pdf->AddPage(); # set page size and orientation $page->SetSize(HPDF_PAGE_SIZE_A4, HPDF_PAGE_PORTRAIT); my $font = $pdf->GetFont("Helvetica", "StandardEncoding"); $page->BeginText(); $page->SetFontAndSize($font, 20); $page->TextOut(40, 781, "text"); $page->EndText(); $page->Rectangle (30, 30, $page->GetWidth() - 60, $page->GetHeight() - 60); $page->Stroke(); # save the document to a file $pdf->SaveToFile("filename.pdf"); # cleanup $pdf->Free();
Create an instance of a document object and initialize it.
Revokes a document object and all resources.
Creates new document. If document object already has a document, the current document is revoked.
Revokes the current document. Keeps loaded resource (such as fonts and encodings) and these resources are recycled when new document required these resources.
Revokes the current document and all resources.
Saves the current document to a file.
Returns PDF document as string.
In the default setting, a PDF::Haru object has one "Pages" object as root of pages. All "Page" objects are created as a kid of the "Pages" object. Since a "Pages" object can own only 8191 kids objects, the maximum number of pages are 8191 page.
Additionally, the state that there are a lot of "Page" object under one "Pages" object is not good, because it causes performance degradation of a viewer application.
An application can change the setting of a pages tree by invoking SetPagesConfiguration(). If $page_per_pages parameter is set to more than zero, a two-tier pages tree is created. A root "Pages" object can own 8191 "Pages" object, and each lower "Pages" object can own $page_per_pages "Page" objects. As a result, the maximum number of pages becomes 8191 * $page_per_pages page.
An application cannot invoke SetPageConfiguration() after a page is added to document.
Sets how the page should be displayed. If this attribute is not set, the setting of a viewer application is used.
layout is one of following constants
Only one page is displayed.
Display the pages in one column.
Display the pages in two column. The page of the odd number is displayed left.
Display the pages in two column. The page of the odd number is displayed right.
$pdf->SetPageLayout(HPDF_PAGE_LAYOUT_ONE_COLUMN)
Returns the current setting for page layout.
Sets how the document should be displayed.
mode is one of following constants
Display the document with neither outline nor thumbnail.
Display the document with outline pain.
Display the document with thumbnail pain.
Display the document with full screen mode.
$pdf->SetPageMode(HPDF_PAGE_MODE_FULL_SCREEN)
Returns the current setting for page mode.
Set the first page appears when a document is opened. $destination is a destination object created by $page->CreateDestination() function.
Returns the handle of current page object.
Creates a new page and adds it after the last page of a document.
Creates a new page and inserts it just before the specified page.
Loads a type1 font from an external file and register it to a document object. Returns the name of a font.
A path of an AFM file.
A path of a PFA/PFB file. If it is undef, the gryph data of font file is not embedded to a PDF file.
Loads a TrueType font from an external file and register it to a document object. Returns the name of a font.
A path of a TrueType font file (.ttf).
If this parameter is set to HPDF_TRUE, the glyph data of the font is embedded, otherwise only the matrix data is included in PDF file.
Loads a TrueType font from an TrueType collection file and register it to a document object. Returns the name of a font.
A path of a TrueType font collection file (.ttc).
The index of font that wants to be loaded.
Adds a page labeling range for the document.
The first page that applies this labeling range.
The numbering style:
Page label is displayed by Arabic numerals.
Page label is displayed by Uppercase roman numerals.
Page label is displayed by Lowercase roman numerals.
Page label is displayed by Uppercase letters (using A to Z).
Page label is displayed by Lowercase letters (using a to z).
The first page number in this range.
The prefix for the page label.
Gets the handle of a corresponding font object by specified name and encoding.
Enables Japanese fonts. After UseJPFonts() is involed, an application can use the following Japanese fonts.
* MS-Mincyo * MS-Mincyo,Bold * MS-Mincyo,Italic * MS-Mincyo,BoldItalic * MS-Gothic * MS-Gothic,Bold * MS-Gothic,Italic * MS-Gothic,BoldItalic * MS-PMincyo * MS-PMincyo,Bold * MS-PMincyo,Italic * MS-PMincyo,BoldItalic * MS-PGothic * MS-PGothic,Bold * MS-PGothic,Italic * MS-PGothic,BoldItalic
Enables Korean fonts. After UseKRFonts() is involed, an application can use the following Korean fonts.
* DotumChe * DotumChe,Bold * DotumChe,Italic * DotumChe,BoldItalic * Dotum * Dotum,Bold * Dotum,Italic * Dotum,BoldItalic * BatangChe * BatangChe,Bold * BatangChe,Italic * BatangChe,BoldItalic * Batang * Batang,Bold * Batang,Italic * Batang,BoldItalic
Enables simplified Chinese fonts. After UseCNSFonts() is involed, an application can use the following simplified Chinese fonts.
* SimSun * SimSun,Bold * SimSun,Italic * SimSun,BoldItalic * SimHei * SimHei,Bold * SimHei,Italic * SimHei,BoldItalic
Enables traditional Chinese fonts. After UseCNTFonts() is involed, an application can use the following traditional Chinese fonts.
* MingLiU * MingLiU,Bold * MingLiU,Italic * MingLiU,BoldItalic
Gets the handle of a corresponding encoder object by specified encoding name.
Gets the handle of the current encoder of the document object. The current encoder is set by invoking SetCurrentEncoder() and it is used to processing a text when an application invoks Info_SetInfoAttr(). The default value of it is undef.
Sets the current encoder for the document.
Enables Japanese encodings. After UseJPEncodings() is involed, an application can use the following Japanese encodings.
* 90ms-RKSJ-H * 90ms-RKSJ-V * 90msp-RKSJ-H * EUC-H * EUC-V
Enables Korean encodings. After UseKREncodings() is involed, an application can use the following Korean encodings.
* KSC-EUC-H * KSC-EUC-V * KSCms-UHC-H * KSCms-UHC-HW-H * KSCms-UHC-HW-V
Enables simplified Chinese encodings. After UseCNSEncodings() is involed, an application can use the following simplified Chinese encodings.
* GB-EUC-H * GB-EUC-V * GBK-EUC-H * GBK-EUC-V
Enables traditional Chinese encodings. After UseCNTEncodings() is involed, an application can use the following traditional Chinese encodings.
Creates a new outline object.
The handle of an outline object which comes to the parent of the created outline object. If undef, the outline is created as a root outline.
The caption of the outline object.
The handle of an encoding object applied to the title. If undef, PDFDocEncoding is used.
Loads an external png image file and returns image object.
Loads an external png image file and returns image object. Unlike LoadPngImageFromFile(), LoadPngImageFromFile2() does not load whole data immediately. (only size and color properties is loaded). The main data is loaded just before the image object is written to PDF, and the loaded data is deleted immediately.
Loads an external Jpeg image file and returns image object.
SetInfoAttr() sets the text of the info dictionary. SetInfoAttr() uses the current encoding of the document.
The following values are available.
HPDF_INFO_AUTHOR HPDF_INFO_CREATOR HPDF_INFO_TITLE HPDF_INFO_SUBJECT HPDF_INFO_KEYWORDS
A text to set the infomation.
Gets an attribute value from info dictionary.
HPDF_INFO_CREATION_DATE HPDF_INFO_MOD_DATE HPDF_INFO_AUTHOR HPDF_INFO_CREATOR HPDF_INFO_TITLE HPDF_INFO_SUBJECT HPDF_INFO_KEYWORDS
Sets a datetime attribute in the info dictionary.
One of the following attributes:
HPDF_INFO_CREATION_DATE HPDF_INFO_MOD_DATE
The new value for the attribute.
$year $month Between 1 and 12. $day Between 1 and 28, 29, 30, or 31. (Depends on the month.) $hour 0 to 23 $minutes 0 to 59 $seconds 0 to 59 $ind Relationship of local time to Universal Time (" ", +, −, or Z). $off_hour If "ind" is not space, 0 to 23 is valid. Otherwise, ignored. $off_minutes If "ind" is not space, 0 to 59 is valid. Otherwise, ignored.
Sets the pasword for the document. If the password is set, contents in the document are encrypted.
The password for the owner of the document. The owner can change the permission of the document. Zero length string and the same value as user password are not allowed.
The password for the user of the document. The $user_password is allowed to be set to zero length string.
Set the flags of the permission for the document.
permission flags specifying which operations are permitted. This parameter is set by logical addition of the following values.
user can read the document.
user can print the document.
user can edit the contents of the document other than annotations, form fields.
user can copy the text and the graphics of the document.
user can add or modify the annotations and form fields of the document.
$pdf->SetPermission(PDF_ENABLE_READ+PDF_ENABLE_PRINT)
Set the type of encryption. As the side effect, SetEncryptionMode() ups the version of PDF to 1.4 when the mode is set to PDF_ENCRYPT_R3.
The flags specifying which operations are permitted. This parameter is set by logical addition of the following values.
Use "Revision 2" algorithm. The length of key is automatically set to 5(40bit).
Use "Revision 3" algorithm. Between 5(40bit) and 16(128bit) can be specified for length of the key.
Specify the byte length of an encryption key. This parameter is valid only when "mode" parameter is set to PDF_ENCRYPT_R3. Between 5(40bit) and 16(128bit) can be specified for length of the key.
mode flags specifying which type of contents should be compressed.
All contents are not compressed.
Compress the contents stream of the page.
Compress the streams of the image objects.
Other stream datas (fonts, cmaps and so on) are compressed.
All stream datas are compressed. (The same as "PDF_COMP_TEXT + PDF_COMP_IMAGE + PDF_COMP_METADATA")
$pdf->SetCompressionMode(PDF_COMP_TEXT+PDF_COMP_METADATA)
Changes the width of a page. The valid value is between 3 and 14400.
Changes the height of a page. The valid value is between 3 and 14400.
Changes the size and direction of a page to a predefined size.
Specify a predefined page-size value. The following values are available.
HPDF_PAGE_SIZE_LETTER HPDF_PAGE_SIZE_LEGAL HPDF_PAGE_SIZE_A3 HPDF_PAGE_SIZE_A4 HPDF_PAGE_SIZE_A5 HPDF_PAGE_SIZE_B4 HPDF_PAGE_SIZE_B5 HPDF_PAGE_SIZE_EXECUTIVE HPDF_PAGE_SIZE_US4x6 HPDF_PAGE_SIZE_US4x8 HPDF_PAGE_SIZE_US5x7 HPDF_PAGE_SIZE_COMM10
Specify the direction of the page.
HPDF_PAGE_PORTRAIT HPDF_PAGE_LANDSCAPE
Sets rotation angle of the page. Angle must be a multiple of 90 Degrees.
Gets the width of a page.
Gets the height of a page.
Creates a new destination object for the page.
Creates a new text annotation object for the page.
The text to be displayed.
An encoder handle which is used to encode the text. If it is undef, PDFDocEncoding is used.
A Rectangle where the annotation is displayed.
Creates a new link annotation object for the page.
A handle of destination object to jump to.
Rectangle of clickable area.
URL of destination to jump to.
Gets the width of the text in current fontsize, character spacing and word spacing.
Calculates the byte length which can be included within the specified width.
The text to get width.
The width of the area to put the text.
When there are three words of "ABCDE", "FGH", and "IJKL", and the substring until "J" can be included within the width, if wordwrap parameter is HPDF_FALSE it returns 12, and if wordwrap parameter is HPDF_TRUE it returns 10 (the end of the previous word).
Gets the current graphics mode.
Gets the current position for path painting.
Gets the current position for text showing.
Gets the handle of the page's current font.
Gets the size of the page's current font.
Gets the current transformation matrix of the page.
Gets the current line width of the page.
Gets the current line cap style of the page.
Gets the current line join style of the page.
Gets the current value of the page's miter limit.
Gets the current pattern of the page.
Gets the current value of the page's flatness.
Gets the the current value of the page's character spacing.
Returns the current value of the page's word spacing.
Returns the current value of the page's horizontal scalling for text showing.
Returns the current value of the page's line spacing.
Returns the current value of the page's text rendering mode.
Returns the current value of the page's text rising.
Returns the current value of the page's filling color.
Returns the current value of the page's stroking color.
Returns the current value of the page's stroking color space.
Gets the current text transformation matrix of the page.
Returns the number of the page's graphics state stack.
Configures the setting for slide transition of the page.
The transition style. The following values are available.
HPDF_TS_WIPE_RIGHT HPDF_TS_WIPE_UP HPDF_TS_WIPE_LEFT HPDF_TS_WIPE_DOWN HPDF_TS_BARN_DOORS_HORIZONTAL_OUT HPDF_TS_BARN_DOORS_HORIZONTAL_IN HPDF_TS_BARN_DOORS_VERTICAL_OUT HPDF_TS_BARN_DOORS_VERTICAL_IN HPDF_TS_BOX_OUT HPDF_TS_BOX_IN HPDF_TS_BLINDS_HORIZONTAL HPDF_TS_BLINDS_VERTICAL HPDF_TS_DISSOLVE HPDF_TS_GLITTER_RIGHT HPDF_TS_GLITTER_DOWN HPDF_TS_GLITTER_TOP_LEFT_TO_BOTTOM_RIGHT HPDF_TS_REPLACE
The display duration of the page. (in seconds)
The duration of the transition effect. Default value is 1(second).
Appends a circle to the current path.
The center point of the circle.
The ray of the circle.
The angle of the begining of the arc.
The angle of the end of the arc. It must be greater than ang1.
Begins a text object and sets the current text position to the point (0, 0).
Appends a strait line from the current point to the start point of sub path. The current point is moved to the start point of sub path.
Closes the current path, then it paints the path.
Closes the current path, fills the current path using the even-odd rule, then it paints the path.
Closes the current path, fills the current path using the nonzero winding number rule, then it paints the path.
Concat() concatenates the page's current transformation matrix and specified matrix.
# save the current graphics states $page->GSave (); # concatenate the transformation matrix $page->Concat (0.7, 0.3, -0.4, 0.6, 220, 350); # show text on the translated coordinates $page->BeginText (); $page->MoveTextPos (50, 100); $page->ShowText ("Text on the translated coordinates"); $page->EndText (); # restore the graphics states $page->GRestore ();
The transformation matrix to concatenate.
Appends a Bézier curve to the current path using two spesified points. The point ($x1, $y1) and the point ($x2, $y2) are used as the control points for a Bézier curve and current point is moved to the point ($x3, $y3)
Appends a Bézier curve to the current path using two spesified points. The current point and the point ($x2, $y2) are used as the control points for a Bézier curve and current point is moved to the point ($x3, $y3)
Appends a Bézier curve to the current path using two spesified points. The point ($x1, $y1) and the point ($x3, $y3) are used as the control points for a Bézier curve and current point is moved to the point ($x3, $y3)
Shows an image in one operation.
The handle of an image object.
The lower-left point of the region where image is displayed.
The width of the region where image is displayed.
Appends an ellipse to the current path.
The radius in the x and y direction.
Ends the path object without filling and painting operation.
Ends a text object.
Fills the current path using the even-odd rule.
Fills the current path using the even-odd rule, then it paints the path.
Fills the current path using the nonzero winding number rule.
Fills the current path using the nonzero winding number rule, then it paints the path.
Restore the graphics state which is saved by GSave().
Saves the page's current graphics parameter to the stack. An application can invoke GSave() up to 28 and can restore the saved parameter by invoking GRestore().
The parameters that are saved by GSave() is as follows.
* Transformation Matrix * Line Width * Line Cap Style * Line Join Style * Miter Limit * Dash Mode * Flatness * Character Spacing * Word Spacing * Horizontal Scalling * Text Leading * Rendering Mode * Text Rise * Filling Color * Stroking Color * Font * Font Size
Appends a path from the current point to the specified point.
Moves the current text position to the start of the next line with using specified offset values. If the start position of the current line is (x1, y1), the start of the next line is (x1 + $x, y1 + $y).
Moves the current text position to the start of the next line with using specified offset values, and sets the text-leading to -y. If the start position of the current line is (x1, y1), the start of the next line is (x1 + $x, y1 + $y).
Sets the start point for the path to the point.
Moves the current text position to the start of the next line. If the start position of the current line is (x1, y1), the start of the next line is (x1, y1 - text leading). NOTE: Since the default value of Text Leading is 0, an application have to invoke SetTextLeading() before MoveToNextLine() to set text leading.
Appends a rectangle to the current path.
The lower-left point of the rectangle.
The width of the rectangle.
The height of the rectangle.
Sets the character spacing for text showing. The initial value of character spacing is 0.
Sets the filling color. $c,$m,$y,$k - the level of each color element. They must be between 0 and 1.
Sets the stroking color. $c,$m,$y,$k - the level of each color element. They must be between 0 and 1.
Sets the line dash pattern in the page.
Pattern of dashes and gaps used to stroke paths.
The phase in which the pattern begins (default is 0).
$page->SetDash([8, 7, 2, 7], 0);
Applys the graphics state to the page.
The handle of a extended graphics state object.
Sets the filling color. The value of the gray level between 0 and 1.
Sets the stroking color. The value of the gray level between 0 and 1.
Sets the type of font and size leading.
The handle of a font object.
The size of a font.
Sets the horizontal scalling for text showing. The initial value of horizontal scalling is 100.
line_cap The style of line-cap:
The line is squared off at the endpoint of the path.
The end of a line becomes a semicircle whose center is the end point of the path.
The line continues to the point that exceeds half of the stroke width the end point.
Sets the line join style in the page. line_join The style of line-join.
HPDF_MITER_JOIN HPDF_ROUND_JOIN HPDF_BEVEL_JOIN
Sets the width of the line used to stroke a path.
Sets the filling color. $r, $g, $b - the level of each color element. They must be between 0 and 1.
Sets the stroking color. $r, $g, $b - the level of each color element. They must be between 0 and 1.
Sets the text leading (line spacing) for text showing. The initial value of leading is 0.
Sets the text rendering mode. The initial value of text rendering mode is HPDF_FILL.
mode one of the following values
HPDF_FILL HPDF_STROKE HPDF_FILL_THEN_STROKE HPDF_INVISIBLE HPDF_FILL_CLIPPING HPDF_STROKE_CLIPPING HPDF_FILL_STROKE_CLIPPING HPDF_CLIPPING
Moves the text position in vertical direction by the amount of value. Useful for making subscripts or superscripts.
Text rise, in user space units.
Sets the word spacing for text showing. The initial value of word spacing is 0.
Prints the text at the current position on the page.
Moves the current text position to the start of the next line, then prints the text at the current position on the page.
Moves the current text position to the start of the next line, then sets the word spacing, character spacing and prints the text at the current position on the page.
Paints the current path.
Prints the text on the specified position.
The point position where the text is displayed.
The text to show.
Print the text inside the specified region.
Coordinates of corners of the region to output text.
The alignment of the text. One of the following values
HPDF_TALIGN_LEFT HPDF_TALIGN_RIGHT HPDF_TALIGN_CENTER HPDF_TALIGN_JUSTIFY
Gets the name of the font.
Gets the encoding name of the font.
Gets the width of a Unicode character in a specific font.
Gets the bounding box of the font.
Gets the vertical ascent of the font.
Gets the vertical descent of the font.
Gets the distance from the baseline of lowercase letters.
Gets the distance from the baseline of uppercase letters.
Gets total width of the text, number of characters, and number of words.
The byte length of the text.
The text to use for calculation.
The length of the text.
The size of the font.
The character spacing.
The word spacing.
Suppose there are three words: "ABCDE", "FGH", and "IJKL". Also, suppose the substring until "J" can be included within the width (12 bytes). If word_wrap is HPDF_TRUE the function returns 12. If word_wrap parameter is HPDF_FALSE, it returns 10 (the end of the previous word).
Defines the appearance when a mouse clicks on a link annotation.
mode - One of the following values:
HPDF_ANNOT_NO_HIGHTLIGHT No highlighting. HPDF_ANNOT_INVERT_BOX Invert the contents of the area of annotation. HPDF_ANNOT_INVERT_BORDER Invert the annotation's border. HPDF_ANNOT_DOWN_APPEARANCE Dent the annotation.
Defines the style of the annotation's border.
The width of an annotation's border.
The dash style.
icon - The style of icon. The following values are available.
HPDF_ANNOT_ICON_COMMENT HPDF_ANNOT_ICON_KEY HPDF_ANNOT_ICON_NOTE HPDF_ANNOT_ICON_HELP HPDF_ANNOT_ICON_NEW_PARAGRAPH HPDF_ANNOT_ICON_PARAGRAPH HPDF_ANNOT_ICON_INSERT
Defines whether the text-annotation is initially open.
HPDF_TRUE means the annotation initially displayed open.
Sets whether this node is opened or not when the outline is displayed for the first time. $opened specify whether the node is opened or not.
Sets a destination object which becomes to a target to jump when the outline is clicked. $dst specify the handle of an destination object.
Defines the appearance of a page with three parameters which are left, top and zoom.
The left coordinates of the page.
The top coordinates of the page.
The page magnified factor. The value must be between 0.08(8%) to 32(%).
Sets the appearance of the page to displaying entire page within the window.
Defines the appearance of a page to magnifying to fit the width of the page within the window and setting the top position of the page to the value of the "top" parameter.
Defines the appearance of a page to magnifying to fit the height of the page within the window and setting the left position of the page to the value of the "top" parameter.
Defines the appearance of a page to magnifying the page to fit a rectangle specified by left, bottom, right and top.
The bottom coordinates of the page.
The right coordinates of the page.
Sets the appearance of the page to magnifying to fit the bounding box of the page within the window.
Defines the appearance of a page to magnifying to fit the width of the bounding box of the page within the window and setting the top position of the page to the value of the "top" parameter.
Defines the appearance of a page to magnifying to fit the height of the bounding box of the page within the window and setting the top position of the page to the value of the "top" parameter.
Gets the size of the image of an image object.
Gets the width of the image of an image object.
Gets the height of the image of an image object.
Gets the number of bits used to describe each color component.
Gets the name of the image's color space. It returns the following values
"DeviceGray" "DeviceRGB" "DeviceCMYK" "Indexed"
Sets the transparent color of the image by the RGB range values. The color within the range is displayed as a transparent color. The Image must be RGB color space.
The lower limit of Red. It must be between 0 and 255.
The upper limit of Red. It must be between 0 and 255.
The lower limit of Green. It must be between 0 and 255.
The upper limit of Green. It must be between 0 and 255.
The lower limit of Blue. It must be between 0 and 255.
The upper limit of Blue. It must be between 0 and 255.
Sets the mask image.
$mask_image specify the handle of an image object which is used as image-mask. This image must be 1bit gray-scale color image.
http://libharu.org/
Ilya Butakov, butilw@gmail.com
Copyright (C) 2008 by Ilya Butakov
This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.8 or, at your option, any later version of Perl 5 you may have available.
1 POD Error
The following errors were encountered while parsing the POD:
Non-ASCII character seen before =encoding in '−,'. Assuming UTF-8
To install PDF::Haru, copy and paste the appropriate command in to your terminal.
cpanm
cpanm PDF::Haru
CPAN shell
perl -MCPAN -e shell install PDF::Haru
For more information on module installation, please visit the detailed CPAN module installation guide.