diff --git a/reference/pdf/configure.xml b/reference/pdf/configure.xml index 88d8ac8eff..7f043e6f16 100644 --- a/reference/pdf/configure.xml +++ b/reference/pdf/configure.xml @@ -1,5 +1,5 @@ - +
&reftitle.install; @@ -8,13 +8,14 @@ &url.pecl.package;pdflib. - To get these functions to work in PHP < 4.3.9, you have to compile PHP with - . DIR is the PDFlib - base install directory, defaults to /usr/local. + To get these functions to work in PHP < 4.3.9, you have to compile + PHP with . DIR is + the PDFlib base install directory, defaults to + /usr/local. As of PHP 4.3.9, you must install this extension through PEAR, using the following command: + url="&url.php.pear;">PEAR, using the following command: pear install pdflib.
diff --git a/reference/pdf/functions/pdf-activate-item.xml b/reference/pdf/functions/pdf-activate-item.xml index 2c66c26a34..0c30b8a74f 100644 --- a/reference/pdf/functions/pdf-activate-item.xml +++ b/reference/pdf/functions/pdf-activate-item.xml @@ -1,15 +1,14 @@ - - + - pdf_activate_item + PDF_activate_item Activate structure element or other content item &reftitle.description; - boolpdf_activate_item + boolPDF_activate_item resourcepdfdoc intid diff --git a/reference/pdf/functions/pdf-add-annotation.xml b/reference/pdf/functions/pdf-add-annotation.xml index 1b4650f65f..28ee6042e6 100644 --- a/reference/pdf/functions/pdf-add-annotation.xml +++ b/reference/pdf/functions/pdf-add-annotation.xml @@ -1,15 +1,15 @@ - - + - pdf_add_annotation + PDF_add_annotation Add annotation [deprecated] &reftitle.description; - This function is deprecated, use pdf_create_annotation with type=Text instead. + This function is deprecated, use PDF_create_annotation + with type=Text instead. diff --git a/reference/pdf/functions/pdf-add-bookmark.xml b/reference/pdf/functions/pdf-add-bookmark.xml index b10d7d48ef..9488b1417c 100644 --- a/reference/pdf/functions/pdf-add-bookmark.xml +++ b/reference/pdf/functions/pdf-add-bookmark.xml @@ -1,15 +1,15 @@ - - + - pdf_add_bookmark + PDF_add_bookmark Add bookmark for current page [deprecated] &reftitle.description; - This function is deprecated since PDFlib version 6, use pdf_create_bookmark instead. + This function is deprecated since PDFlib version 6, use + PDF_create_bookmark instead. diff --git a/reference/pdf/functions/pdf-add-bookmark2.xml b/reference/pdf/functions/pdf-add-bookmark2.xml deleted file mode 100644 index e586a5047a..0000000000 --- a/reference/pdf/functions/pdf-add-bookmark2.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - pdf_add_bookmark2 - Add bookmark for current page [deprecated] - - - &reftitle.description; - - This function is deprecated since PDFlib version 6, use - pdf_create_bookmark instead. - - - - - diff --git a/reference/pdf/functions/pdf-add-launchlink.xml b/reference/pdf/functions/pdf-add-launchlink.xml index dd98e68992..80e6a4cfdd 100644 --- a/reference/pdf/functions/pdf-add-launchlink.xml +++ b/reference/pdf/functions/pdf-add-launchlink.xml @@ -1,15 +1,14 @@ - - + - pdf_add_launchlink + PDF_add_launchlink Add launch annotation for current page [deprecated] &reftitle.description; - boolpdf_add_launchlink + boolPDF_add_launchlink resourcepdfdoc floatllx floatlly @@ -18,11 +17,14 @@ stringfilename - Adds a link to a web resource specified by filename. + Adds a link to a web resource. - This function is deprecated since PDFlib version 6, use pdf_create_action with type=Launch and create_annotation with -type=Link instead. + This function is deprecated since PDFlib version 6, + use PDF_create_action with + type=Launch and + PDF_create_annotation with + type=Link instead. diff --git a/reference/pdf/functions/pdf-add-locallink.xml b/reference/pdf/functions/pdf-add-locallink.xml index 33411c1934..bbad07791a 100644 --- a/reference/pdf/functions/pdf-add-locallink.xml +++ b/reference/pdf/functions/pdf-add-locallink.xml @@ -1,15 +1,14 @@ - - + - pdf_add_locallink + PDF_add_locallink Add link annotation for current page [deprecated] &reftitle.description; - boolpdf_add_locallink + boolPDF_add_locallink resourcepdfdoc floatlowerleftx floatlowerlefty @@ -23,13 +22,10 @@ &return.success; - dest is the zoom setting on the destination page, - it can be one of retain, fitpage, - fitwidth, fitheight or - fitbbox. - - - This function is deprecated since PDFlib version 6, use pdf_create_action with type=GoTo and pdf_create_annotation with type=Link instead. + This function is deprecated since PDFlib version 6, use + PDF_create_action with type=GoTo + and PDF_create_annotation with + type=Link instead. diff --git a/reference/pdf/functions/pdf-add-nameddest.xml b/reference/pdf/functions/pdf-add-nameddest.xml index d4a4ccf427..88a0e563d2 100644 --- a/reference/pdf/functions/pdf-add-nameddest.xml +++ b/reference/pdf/functions/pdf-add-nameddest.xml @@ -1,15 +1,14 @@ - - + - pdf_add_nameddest + PDF_add_nameddest Create named destination &reftitle.description; - boolpdf_add_nameddest + boolPDF_add_nameddest resourcepdfdoc stringname stringoptlist diff --git a/reference/pdf/functions/pdf-add-note.xml b/reference/pdf/functions/pdf-add-note.xml index 08cc52ab27..e68907d192 100644 --- a/reference/pdf/functions/pdf-add-note.xml +++ b/reference/pdf/functions/pdf-add-note.xml @@ -1,15 +1,14 @@ - - + - pdf_add_note + PDF_add_note Set annotation for current page [deprecated] &reftitle.description; - boolpdf_add_note + boolPDF_add_note resourcepdfdoc floatllx floatlly @@ -21,15 +20,13 @@ intopen - Sets an annotation for the current page. icon is one of - comment, insert, note, - paragraph, newparagraph, - key, or help. &return.success; + Sets an annotation for the current page. &return.success; + + + This function is deprecated since PDFlib version 6, use + PDF_create_annotation with + type=Text instead. - - This function is deprecated since PDFlib version 6, use - pdf_create_annotation with type=Text instead. - diff --git a/reference/pdf/functions/pdf-add-note2.xml b/reference/pdf/functions/pdf-add-note2.xml deleted file mode 100644 index d3414f1b0e..0000000000 --- a/reference/pdf/functions/pdf-add-note2.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - - - pdf_add_note2 - Set annotation for current page [deprecated] - - - &reftitle.description; - - This function is deprecated since PDFlib version 6, use - pdf_create_annotation with type=Text instead. - - - - - diff --git a/reference/pdf/functions/pdf-add-outline.xml b/reference/pdf/functions/pdf-add-outline.xml index ef7a54c8b0..5e656e0969 100644 --- a/reference/pdf/functions/pdf-add-outline.xml +++ b/reference/pdf/functions/pdf-add-outline.xml @@ -1,15 +1,15 @@ - - + - pdf_add_outline + PDF_add_outline Add bookmark for current page [deprecated] &reftitle.description; - This function is deprecated, use pdf_create_bookmark instead. + This function is deprecated, use PDF_create_bookmark + instead. diff --git a/reference/pdf/functions/pdf-add-pdflink.xml b/reference/pdf/functions/pdf-add-pdflink.xml index 0acdb58fd8..0e86924ba0 100644 --- a/reference/pdf/functions/pdf-add-pdflink.xml +++ b/reference/pdf/functions/pdf-add-pdflink.xml @@ -1,15 +1,14 @@ - - + - pdf_add_pdflink + PDF_add_pdflink Add file link annotation for current page [deprecated] &reftitle.description; - boolpdf_add_pdflink + boolPDF_add_pdflink resourcepdfdoc floatbottom_left_x floatbottom_left_y @@ -20,12 +19,15 @@ stringdest - Add a file link annotation (to a PDF target). + Add a file link annotation to a PDF target. &return.success; - This function is deprecated since PDFlib version 6, use pdf_create_action with type=GoToR and pdf_create_annotation with -type=Link instead. + This function is deprecated since PDFlib version 6, use + PDF_create_action with + type=GoToR and + PDF_create_annotation with + type=Link instead. diff --git a/reference/pdf/functions/pdf-add-thumbnail.xml b/reference/pdf/functions/pdf-add-thumbnail.xml index 1e6235ca31..63557c43f5 100644 --- a/reference/pdf/functions/pdf-add-thumbnail.xml +++ b/reference/pdf/functions/pdf-add-thumbnail.xml @@ -1,21 +1,19 @@ - - + - pdf_add_thumbnail + PDF_add_thumbnail Add thumbnail for current page &reftitle.description; - boolpdf_add_thumbnail + boolPDF_add_thumbnail resourcepdfdoc intimage Adds an existing image as thumbnail for the current page. - Thumbnail images must not be wider or higher than 106 pixels. &return.success; diff --git a/reference/pdf/functions/pdf-add-weblink.xml b/reference/pdf/functions/pdf-add-weblink.xml index 1550f30b4d..da7b664836 100644 --- a/reference/pdf/functions/pdf-add-weblink.xml +++ b/reference/pdf/functions/pdf-add-weblink.xml @@ -1,15 +1,14 @@ - - + - pdf_add_weblink + PDF_add_weblink Add weblink for current page [deprecated] &reftitle.description; - boolpdf_add_weblink + boolPDF_add_weblink resourcepdfdoc floatlowerleftx floatlowerlefty @@ -18,11 +17,15 @@ stringurl - Add a weblink annotation to a target url on the Web. + Adds a weblink annotation to a target url on the Web. &return.success; -This function is deprecated since PDFlib version 6, use pdf_create_action with type=URI and pdf_create_annotation with -type=Link instead. + + This function is deprecated since PDFlib version 6, use + PDF_create_action with type=URI + and PDF_create_annotation with + type=Link instead. + diff --git a/reference/pdf/functions/pdf-arc.xml b/reference/pdf/functions/pdf-arc.xml index 3770bc3e01..7388b735d2 100644 --- a/reference/pdf/functions/pdf-arc.xml +++ b/reference/pdf/functions/pdf-arc.xml @@ -1,15 +1,14 @@ - - + - pdf_arc + PDF_arc Draw a counterclockwise circular arc segment &reftitle.description; - boolpdf_arc + boolPDF_arc resourcep floatx floaty @@ -18,11 +17,7 @@ floatbeta - Add a counterclockwise circular arc from - alpha to beta degrees - with center (x; y) - and radius r. The actual drawing of the circle is performed by - the next stroke or fill operation. + Adds a counterclockwise circular arc. diff --git a/reference/pdf/functions/pdf-arcn.xml b/reference/pdf/functions/pdf-arcn.xml index 2d835fe4fd..a37043cfd1 100644 --- a/reference/pdf/functions/pdf-arcn.xml +++ b/reference/pdf/functions/pdf-arcn.xml @@ -1,15 +1,14 @@ - - + - pdf_arcn + PDF_arcn Draw a clockwise circular arc segment &reftitle.description; - boolpdf_arcn + boolPDF_arcn resourcep floatx floaty @@ -18,9 +17,8 @@ floatbeta - Except for the drawing direction, this function behave exactly like - pdf_arc. In particular, - the angles are still measured counterclockwise from the positive x axis. + Except for the drawing direction, this function behaves exactly like + PDF_arc. diff --git a/reference/pdf/functions/pdf-attach-file.xml b/reference/pdf/functions/pdf-attach-file.xml index b072b0e30a..462e972d4e 100644 --- a/reference/pdf/functions/pdf-attach-file.xml +++ b/reference/pdf/functions/pdf-attach-file.xml @@ -1,15 +1,14 @@ - - + - pdf_attach_file + PDF_attach_file Add file attachment for current page [deprecated] &reftitle.description; - boolpdf_attach_file + boolPDF_attach_file resourcepdfdoc floatllx floatlly @@ -22,12 +21,12 @@ stringicon - Add a file attachment annotation. icon is one of - graph, paperclip, - pushpin, or tag. &return.success; + Adds a file attachment annotation. &return.success; - This function is deprecated since PDFlib version 6, use pdf_create_annotation with type=FileAttachment instead. + This function is deprecated since PDFlib version 6, use + PDF_create_annotation with + type=FileAttachment instead. diff --git a/reference/pdf/functions/pdf-attach-file2.xml b/reference/pdf/functions/pdf-attach-file2.xml deleted file mode 100644 index 7d3182d4c2..0000000000 --- a/reference/pdf/functions/pdf-attach-file2.xml +++ /dev/null @@ -1,36 +0,0 @@ - - - - - - pdf_attach_file2 - Add file attachment for current page [deprecated] - - - &reftitle.description; - - This function is deprecated since PDFlib version 6, use pdf_create_annotation with type=FileAttachment instead. - - - - - diff --git a/reference/pdf/functions/pdf-begin-document.xml b/reference/pdf/functions/pdf-begin-document.xml index 5101aa6c0f..634ac61799 100644 --- a/reference/pdf/functions/pdf-begin-document.xml +++ b/reference/pdf/functions/pdf-begin-document.xml @@ -1,15 +1,14 @@ - - + - pdf_begin_document + PDF_begin_document Create new PDF file &reftitle.description; - intpdf_begin_document + intPDF_begin_document resourcepdfdoc stringfilename stringoptlist diff --git a/reference/pdf/functions/pdf-begin-font.xml b/reference/pdf/functions/pdf-begin-font.xml index 33ea2abf8c..ca07a4764e 100644 --- a/reference/pdf/functions/pdf-begin-font.xml +++ b/reference/pdf/functions/pdf-begin-font.xml @@ -1,15 +1,14 @@ - - + - pdf_begin_font + PDF_begin_font Start a Type 3 font definition &reftitle.description; - boolpdf_begin_font + boolPDF_begin_font resourcepdfdoc stringfilename floata @@ -21,11 +20,7 @@ stringoptlist - Starts a Type 3 font definition using the parameters - a, b, - c, d, - e, and f - as the elements of the font matrix. + Starts a Type 3 font definition. diff --git a/reference/pdf/functions/pdf-begin-glyph.xml b/reference/pdf/functions/pdf-begin-glyph.xml index 782ecfb90e..89b720964a 100644 --- a/reference/pdf/functions/pdf-begin-glyph.xml +++ b/reference/pdf/functions/pdf-begin-glyph.xml @@ -1,15 +1,14 @@ - - + - pdf_begin_glyph + PDF_begin_glyph Start glyph definition for Type 3 font &reftitle.description; - boolpdf_begin_glyph + boolPDF_begin_glyph resourcepdfdoc stringglyphname floatwx @@ -17,14 +16,10 @@ floatlly floaturx floatury + stringoptlist - Starts a glyph definition for a Type 3 font. The parameter - wx is the glyph width and the parameters - llx,lly, - urx and ury specify - the coordinates of the lower left and upper right corners of the bounding - box of the glyph. + Starts a glyph definition for a Type 3 font. diff --git a/reference/pdf/functions/pdf-begin-item.xml b/reference/pdf/functions/pdf-begin-item.xml index a622b7c8cd..424fe1118a 100644 --- a/reference/pdf/functions/pdf-begin-item.xml +++ b/reference/pdf/functions/pdf-begin-item.xml @@ -1,23 +1,21 @@ - - + - pdf_begin_item + PDF_begin_item Open structure element or other content item &reftitle.description; - intpdf_begin_item + intPDF_begin_item resourcepdfdoc stringtag stringoptlist Opens a structure element or other content item with attributes supplied - as options. This function returns an item handle which can be used in - subsequent item-related calls. + as options. diff --git a/reference/pdf/functions/pdf-begin-layer.xml b/reference/pdf/functions/pdf-begin-layer.xml index d2ea988681..1200243e2d 100644 --- a/reference/pdf/functions/pdf-begin-layer.xml +++ b/reference/pdf/functions/pdf-begin-layer.xml @@ -1,22 +1,23 @@ - - + - pdf_begin_layer + PDF_begin_layer Start layer &reftitle.description; - boolpdf_begin_layer + boolPDF_begin_layer resourcepdfdoc intlayer Starts a layer for subsequent output on the page. &return.success; - This function requires PDF 1.5. + + This function requires PDF 1.5. + diff --git a/reference/pdf/functions/pdf-begin-page-ext.xml b/reference/pdf/functions/pdf-begin-page-ext.xml index c7bf038829..c70af0140c 100644 --- a/reference/pdf/functions/pdf-begin-page-ext.xml +++ b/reference/pdf/functions/pdf-begin-page-ext.xml @@ -1,15 +1,14 @@ - - + - pdf_begin_page_ext + PDF_begin_page_ext Start new page &reftitle.description; - boolpdf_begin_page_ext + boolPDF_begin_page_ext resourcepdfdoc floatwidth floatheight diff --git a/reference/pdf/functions/pdf-begin-page.xml b/reference/pdf/functions/pdf-begin-page.xml index 13d420ccab..9ec63b58ed 100644 --- a/reference/pdf/functions/pdf-begin-page.xml +++ b/reference/pdf/functions/pdf-begin-page.xml @@ -1,89 +1,24 @@ - - + - pdf_begin_page + PDF_begin_page Start new page [deprecated] &reftitle.description; - boolpdf_begin_page + boolPDF_begin_page resourcepdfdoc floatwidth floatheight - Add a new page to the document. &return.success; - The width and height are - specified in points, which are 1/72 of an inch. + Adds a new page to the document. &return.success; - This function is deprecated since PDFlib version 6, use pdf_begin_page_ext instead. - - - - Common Page Sizes in Points - - - - name - size - - - - - A0 - 2380✗3368 - - - A1 - 1684✗2380 - - - A2 - 1190✗1684 - - - A3 - 842✗1190 - - - A4 - 595✗842 - - - A5 - 421✗595 - - - A6 - 297✗421 - - - B5 - 501✗709 - - - letter (8.5"✗11") - 612✗792 - - - legal (8.5"✗14") - 612✗1008 - - - ledger (17"✗11") - 1224✗792 - - - 11"✗17" - 792✗1224 - - - -
+ This function is deprecated since PDFlib version 6, use + PDF_begin_page_ext instead. diff --git a/reference/pdf/functions/pdf-begin-pattern.xml b/reference/pdf/functions/pdf-begin-pattern.xml index fa2f3c001e..782b8c1e10 100644 --- a/reference/pdf/functions/pdf-begin-pattern.xml +++ b/reference/pdf/functions/pdf-begin-pattern.xml @@ -1,15 +1,14 @@ - - + - pdf_begin_pattern + PDF_begin_pattern Start pattern definition &reftitle.description; - intpdf_begin_pattern + intPDF_begin_pattern resourcepdfdoc floatwidth floatheight @@ -18,16 +17,7 @@ intpainttype - Starts a new pattern definition and returns a pattern handle. - width, and height - define the bounding box for the pattern. xstep - and ystep give the repeated pattern offsets. - painttype=1 means that the pattern has its - own colour settings whereas a value of 2 indicates that the current - colour is used when the pattern is applied. - - - See also pdf_end_pattern. + Starts a new pattern definition. diff --git a/reference/pdf/functions/pdf-begin-template.xml b/reference/pdf/functions/pdf-begin-template.xml index 6bfd9883c8..3be3211724 100644 --- a/reference/pdf/functions/pdf-begin-template.xml +++ b/reference/pdf/functions/pdf-begin-template.xml @@ -1,15 +1,14 @@ - - + - pdf_begin_template + PDF_begin_template Start template definition &reftitle.description; - intpdf_begin_template + intPDF_begin_template resourcepdfdoc floatwidth floatheight diff --git a/reference/pdf/functions/pdf-circle.xml b/reference/pdf/functions/pdf-circle.xml index b4efcd177e..cfb72f3357 100644 --- a/reference/pdf/functions/pdf-circle.xml +++ b/reference/pdf/functions/pdf-circle.xml @@ -1,28 +1,21 @@ - - + - pdf_circle + PDF_circle Draw a circle &reftitle.description; - boolpdf_circle + boolPDF_circle resourcepdfdoc floatx floaty floatr - Adds a circle with center (x, - y) and radius r - to the current path. The actual drawing of the circle is performed by - the next stroke or fill operation. - - - &return.success; + Adds a circle. &return.success; diff --git a/reference/pdf/functions/pdf-clip.xml b/reference/pdf/functions/pdf-clip.xml index a2a43c83f2..500b04e73a 100644 --- a/reference/pdf/functions/pdf-clip.xml +++ b/reference/pdf/functions/pdf-clip.xml @@ -1,15 +1,14 @@ - - + - pdf_clip + PDF_clip Clip to current path &reftitle.description; - boolpdf_clip + boolPDF_clip resourcep diff --git a/reference/pdf/functions/pdf-close-image.xml b/reference/pdf/functions/pdf-close-image.xml index b01043aa17..c3c415f224 100644 --- a/reference/pdf/functions/pdf-close-image.xml +++ b/reference/pdf/functions/pdf-close-image.xml @@ -1,21 +1,20 @@ - - + - pdf_close_image + PDF_close_image Close image &reftitle.description; - voidpdf_close_image + voidPDF_close_image resourcep intimage Closes an image retrieved with the - pdf_open_image function. + PDF_open_image function. diff --git a/reference/pdf/functions/pdf-close-pdi-page.xml b/reference/pdf/functions/pdf-close-pdi-page.xml index 0f0d3eac7a..d057d75f0a 100644 --- a/reference/pdf/functions/pdf-close-pdi-page.xml +++ b/reference/pdf/functions/pdf-close-pdi-page.xml @@ -1,23 +1,22 @@ - - + - pdf_close_pdi_page - - Close the page handle - + PDF_close_pdi_page + + Close the page handle + &reftitle.description; - - boolpdf_close_pdi_page - resourcep - intpage - - - Closes the page handle, and frees all page-related resources. &return.success; - + + boolPDF_close_pdi_page + resourcep + intpage + + + Closes the page handle, and frees all page-related resources. &return.success; + diff --git a/reference/pdf/functions/pdf-close-pdi.xml b/reference/pdf/functions/pdf-close-pdi.xml index 5c9c9c6393..4a4764d855 100644 --- a/reference/pdf/functions/pdf-close-pdi.xml +++ b/reference/pdf/functions/pdf-close-pdi.xml @@ -1,26 +1,22 @@ - - + - pdf_close_pdi + PDF_close_pdi Close the input PDF document &reftitle.description; - - boolpdf_close_pdi - resourcep - intdoc - - - Closes all open page handles, and closes the input PDF document. &return.success; - - - See also pdf_open_pdi. - + + boolPDF_close_pdi + resourcep + intdoc + + + Closes all open page handles, and closes the input PDF document. &return.success; + diff --git a/reference/pdf/functions/pdf-close.xml b/reference/pdf/functions/pdf-close.xml index 0432f0124f..44bcae640e 100644 --- a/reference/pdf/functions/pdf-close.xml +++ b/reference/pdf/functions/pdf-close.xml @@ -1,23 +1,23 @@ - - + - pdf_close - Closes a pdf resource [deprecated] + PDF_close + Close pdf resource [deprecated] &reftitle.description; - boolpdf_close + boolPDF_close resourcep - Close the generated PDF file, and free all document-related resources. + Closes the generated PDF file, and frees all document-related resources. &return.success; - This function is deprecated since PDFlib version 6, use pdf_end_document instead. + This function is deprecated since PDFlib version 6, use + PDF_end_document instead. diff --git a/reference/pdf/functions/pdf-closepath-fill-stroke.xml b/reference/pdf/functions/pdf-closepath-fill-stroke.xml index 6eaf4d5f35..a11e0554b6 100644 --- a/reference/pdf/functions/pdf-closepath-fill-stroke.xml +++ b/reference/pdf/functions/pdf-closepath-fill-stroke.xml @@ -1,24 +1,19 @@ - - + - pdf_closepath_fill_stroke + PDF_closepath_fill_stroke Close, fill and stroke current path &reftitle.description; - boolpdf_closepath_fill_stroke + boolPDF_closepath_fill_stroke resourcep Closes the path, fills, and strokes it. &return.success; - - See also pdf_closepath and - pdf_closepath_stroke. - diff --git a/reference/pdf/functions/pdf-closepath-stroke.xml b/reference/pdf/functions/pdf-closepath-stroke.xml index ed0645f360..e3fa2c7ce7 100644 --- a/reference/pdf/functions/pdf-closepath-stroke.xml +++ b/reference/pdf/functions/pdf-closepath-stroke.xml @@ -1,24 +1,19 @@ - - + - pdf_closepath_stroke + PDF_closepath_stroke Close and stroke path &reftitle.description; - boolpdf_closepath_stroke + boolPDF_closepath_stroke resourcep Closes the path, and strokes it. &return.success; - - See also pdf_closepath and - pdf_closepath_fill_stroke. - diff --git a/reference/pdf/functions/pdf-closepath.xml b/reference/pdf/functions/pdf-closepath.xml index e05a8f9173..76f974e971 100644 --- a/reference/pdf/functions/pdf-closepath.xml +++ b/reference/pdf/functions/pdf-closepath.xml @@ -1,24 +1,19 @@ - - + - pdf_closepath + PDF_closepath Close current path &reftitle.description; - boolpdf_closepath + boolPDF_closepath resourcep Closes the current path. &return.success; - - See also pdf_closepath_stroke and - pdf_closepath_fil_stroke. - diff --git a/reference/pdf/functions/pdf-concat.xml b/reference/pdf/functions/pdf-concat.xml index 70922d90a2..f98b632ac0 100644 --- a/reference/pdf/functions/pdf-concat.xml +++ b/reference/pdf/functions/pdf-concat.xml @@ -1,15 +1,14 @@ - - + - pdf_concat + PDF_concat Concatenate a matrix to the CTM &reftitle.description; - boolpdf_concat + boolPDF_concat resourcep floata floatb diff --git a/reference/pdf/functions/pdf-continue-text.xml b/reference/pdf/functions/pdf-continue-text.xml index 36700f1d1e..1d3d207a5e 100644 --- a/reference/pdf/functions/pdf-continue-text.xml +++ b/reference/pdf/functions/pdf-continue-text.xml @@ -1,15 +1,14 @@ - - + - pdf_continue_text + PDF_continue_text Output text in next line &reftitle.description; - boolpdf_continue_text + boolPDF_continue_text resourcep stringtext diff --git a/reference/pdf/functions/pdf-create-action.xml b/reference/pdf/functions/pdf-create-action.xml index 45870240c2..a4a1f18e60 100644 --- a/reference/pdf/functions/pdf-create-action.xml +++ b/reference/pdf/functions/pdf-create-action.xml @@ -1,23 +1,20 @@ - - + - pdf_create_action + PDF_create_action Create action for objects or events &reftitle.description; - intpdf_create_action + intPDF_create_action resourcepdfdoc stringtype stringoptlist Creates an action which can be applied to various objects and events. - This function returns an action handle which can be used to attach - actions to objects within the document. diff --git a/reference/pdf/functions/pdf-create-annotation.xml b/reference/pdf/functions/pdf-create-annotation.xml index d15cca91a3..9f8de1c9ec 100644 --- a/reference/pdf/functions/pdf-create-annotation.xml +++ b/reference/pdf/functions/pdf-create-annotation.xml @@ -1,29 +1,24 @@ - - + - pdf_create_annotation + PDF_create_annotation Create rectangular annotation &reftitle.description; - boolpdf_create_annotation + boolPDF_create_annotation resourcepdfdoc - floatllx - floatlly - floaturx + floatllx + floatlly + floaturx floatury stringtype stringoptlist - Creates a rectangular annotation on the current page. The parameters - llx, lly, - urx and ury specify the - x and y coordinates of the lower left and upper right corners of the - annotation rectangle. + Creates a rectangular annotation on the current page. diff --git a/reference/pdf/functions/pdf-create-bookmark.xml b/reference/pdf/functions/pdf-create-bookmark.xml index 3d760c68f8..73c3243b00 100644 --- a/reference/pdf/functions/pdf-create-bookmark.xml +++ b/reference/pdf/functions/pdf-create-bookmark.xml @@ -1,23 +1,20 @@ - - + - pdf_create_bookmark + PDF_create_bookmark Create bookmark &reftitle.description; - intpdf_create_bookmark + intPDF_create_bookmark resourcepdfdoc - stringtext + stringtext stringoptlist - Creates a bookmark subject to various options. This function returns a - handle to the generated bookmark which may be used with the - parent option in subsequent calls. + Creates a bookmark subject to various options. diff --git a/reference/pdf/functions/pdf-create-field.xml b/reference/pdf/functions/pdf-create-field.xml index 4a92765efe..f1592bc714 100644 --- a/reference/pdf/functions/pdf-create-field.xml +++ b/reference/pdf/functions/pdf-create-field.xml @@ -1,19 +1,18 @@ - - + - pdf_create_field + PDF_create_field Create form field &reftitle.description; - boolpdf_create_field + boolPDF_create_field resourcepdfdoc - floatllx - floatlly - floaturx + floatllx + floatlly + floaturx floatury stringname stringtype @@ -21,10 +20,6 @@ Creates a form field on the current page subject to various options. - The parameters llx, lly, - urx and ury specify the - x and y coordinates of the lower left and upper right corners of the - field rectangle. diff --git a/reference/pdf/functions/pdf-create-fieldgroup.xml b/reference/pdf/functions/pdf-create-fieldgroup.xml index 472fe69364..75575e676a 100644 --- a/reference/pdf/functions/pdf-create-fieldgroup.xml +++ b/reference/pdf/functions/pdf-create-fieldgroup.xml @@ -1,17 +1,16 @@ - - + - pdf_create_fieldgroup + PDF_create_fieldgroup Create form field group &reftitle.description; - boolpdf_create_fieldgroup + boolPDF_create_fieldgroup resourcepdfdoc - stringname + stringname stringoptlist diff --git a/reference/pdf/functions/pdf-create-gstate.xml b/reference/pdf/functions/pdf-create-gstate.xml index ca5ac508a5..1e628d0bc1 100644 --- a/reference/pdf/functions/pdf-create-gstate.xml +++ b/reference/pdf/functions/pdf-create-gstate.xml @@ -1,22 +1,19 @@ - - + - pdf_create_gstate + PDF_create_gstate Create graphics state object &reftitle.description; - intpdf_create_gstate + intPDF_create_gstate resourcepdfdoc - stringoptlist + stringoptlist - Creates a graphics state object subject to various options. This function - returns a gstate handle that can be used in subsequent calls to - pdf_set_gstate. + Creates a graphics state object subject to various options. diff --git a/reference/pdf/functions/pdf-create-pvf.xml b/reference/pdf/functions/pdf-create-pvf.xml index 86e49579a4..50a56bb942 100644 --- a/reference/pdf/functions/pdf-create-pvf.xml +++ b/reference/pdf/functions/pdf-create-pvf.xml @@ -1,22 +1,21 @@ - - + - pdf_create_pvf + PDF_create_pvf Create PDFlib virtual file &reftitle.description; - boolpdf_create_pvf + boolPDF_create_pvf resourcepdfdoc - stringfilename - stringdata - stringoptlist + stringfilename + stringdata + stringoptlist - Creates a named virtual read-only file from data provided in memory. + Creates a named virtual read-only file from data provided in memory. diff --git a/reference/pdf/functions/pdf-create-textflow.xml b/reference/pdf/functions/pdf-create-textflow.xml index 77f1bc1485..f66f6ec885 100644 --- a/reference/pdf/functions/pdf-create-textflow.xml +++ b/reference/pdf/functions/pdf-create-textflow.xml @@ -1,25 +1,20 @@ - - + - pdf_create_textflow + PDF_create_textflow Create textflow object &reftitle.description; - intpdf_create_textflow + intPDF_create_textflow resourcepdfdoc stringtext - stringoptlist + stringoptlist - Preprocesses text for later formatting and creates a textflow object. - This function returns a textflow handle which can be used in calls to - pdf_fit_textflow, - pdf_info_textflow, and - pdf_delete_textflow. + Preprocesses text for later formatting and creates a textflow object. diff --git a/reference/pdf/functions/pdf-curveto.xml b/reference/pdf/functions/pdf-curveto.xml index 71f59406dd..daebf108d0 100644 --- a/reference/pdf/functions/pdf-curveto.xml +++ b/reference/pdf/functions/pdf-curveto.xml @@ -1,15 +1,14 @@ - - + - pdf_curveto + PDF_curveto Draw Bezier curve &reftitle.description; - boolpdf_curveto + boolPDF_curveto resourcep floatx1 floaty1 diff --git a/reference/pdf/functions/pdf-define-layer.xml b/reference/pdf/functions/pdf-define-layer.xml index 80ffb7e54f..e81d0d570d 100644 --- a/reference/pdf/functions/pdf-define-layer.xml +++ b/reference/pdf/functions/pdf-define-layer.xml @@ -1,24 +1,24 @@ - - + - pdf_define_layer + PDF_define_layer Create layer definition &reftitle.description; - intpdf_define_layer + intPDF_define_layer resourcepdfdoc stringname stringoptlist - Creates a new layer definition. This function returns a layer handle - which can be used in calls to pdf_begin_layer and set_layer_dependency. + Creates a new layer definition. + + + This function requires PDF 1.5. - This function requires PDF 1.5. diff --git a/reference/pdf/functions/pdf-delete-pvf.xml b/reference/pdf/functions/pdf-delete-pvf.xml index 5e4e96385a..48bdf02e66 100644 --- a/reference/pdf/functions/pdf-delete-pvf.xml +++ b/reference/pdf/functions/pdf-delete-pvf.xml @@ -1,18 +1,17 @@ - - + - pdf_delete_pvf + PDF_delete_pvf Delete PDFlib virtual file &reftitle.description; - intpdf_delete_pvf + intPDF_delete_pvf resourcepdfdoc - stringfilename - + stringfilename + Deletes a named virtual file and frees its data structures (but not the contents). diff --git a/reference/pdf/functions/pdf-delete-textflow.xml b/reference/pdf/functions/pdf-delete-textflow.xml index 6dfce6e515..c06e57366a 100644 --- a/reference/pdf/functions/pdf-delete-textflow.xml +++ b/reference/pdf/functions/pdf-delete-textflow.xml @@ -1,15 +1,14 @@ - - + - pdf_delete_textflow + PDF_delete_textflow Delete textflow object &reftitle.description; - boolpdf_delete_textflow + intPDF_delete_textflow resourcepdfdoc inttextflow diff --git a/reference/pdf/functions/pdf-delete.xml b/reference/pdf/functions/pdf-delete.xml index d763478ed1..7239bce9fc 100644 --- a/reference/pdf/functions/pdf-delete.xml +++ b/reference/pdf/functions/pdf-delete.xml @@ -1,15 +1,14 @@ - - + - pdf_delete + PDF_delete Delete PDFlib object &reftitle.description; - boolpdf_delete + boolPDF_delete resourcepdfdoc diff --git a/reference/pdf/functions/pdf-encoding-set-char.xml b/reference/pdf/functions/pdf-encoding-set-char.xml index e4c19e59cd..18fd404160 100644 --- a/reference/pdf/functions/pdf-encoding-set-char.xml +++ b/reference/pdf/functions/pdf-encoding-set-char.xml @@ -1,21 +1,20 @@ - - + - pdf_encoding_set_char + PDF_encoding_set_char Add glyph name and/or Unicode value &reftitle.description; - boolpdf_encoding_set_char + boolPDF_encoding_set_char resourcepdfdoc stringencoding - intslot - stringglyphname - intuv - + intslot + stringglyphname + intuv + Adds a glyph name and/or Unicode value to a custom encoding. diff --git a/reference/pdf/functions/pdf-end-document.xml b/reference/pdf/functions/pdf-end-document.xml index 3d02501f4b..c94ff916ec 100644 --- a/reference/pdf/functions/pdf-end-document.xml +++ b/reference/pdf/functions/pdf-end-document.xml @@ -1,15 +1,14 @@ - - + - pdf_end_document + PDF_end_document Close PDF file &reftitle.description; - boolpdf_end_document + boolPDF_end_document resourcepdfdoc stringoptlist diff --git a/reference/pdf/functions/pdf-end-font.xml b/reference/pdf/functions/pdf-end-font.xml index 8e4a316d6a..5eafe8d79a 100644 --- a/reference/pdf/functions/pdf-end-font.xml +++ b/reference/pdf/functions/pdf-end-font.xml @@ -1,15 +1,14 @@ - - + - pdf_end_font + PDF_end_font Terminate Type 3 font definition &reftitle.description; - boolpdf_end_font + boolPDF_end_font resourcepdfdoc diff --git a/reference/pdf/functions/pdf-end-glyph.xml b/reference/pdf/functions/pdf-end-glyph.xml index f42a4d9dab..a63eb7f459 100644 --- a/reference/pdf/functions/pdf-end-glyph.xml +++ b/reference/pdf/functions/pdf-end-glyph.xml @@ -1,15 +1,14 @@ - - + - pdf_end_glyph + PDF_end_glyph Terminate glyph definition for Type 3 font &reftitle.description; - boolpdf_end_glyph + boolPDF_end_glyph resourcepdfdoc diff --git a/reference/pdf/functions/pdf-end-item.xml b/reference/pdf/functions/pdf-end-item.xml index c2858800bb..ea22df3f89 100644 --- a/reference/pdf/functions/pdf-end-item.xml +++ b/reference/pdf/functions/pdf-end-item.xml @@ -1,15 +1,14 @@ - - + - pdf_end_item + PDF_end_item Close structure element or other content item &reftitle.description; - boolpdf_end_item + boolPDF_end_item resourcepdfdoc intid diff --git a/reference/pdf/functions/pdf-end-layer.xml b/reference/pdf/functions/pdf-end-layer.xml index b4f1d66263..dffad91fd9 100644 --- a/reference/pdf/functions/pdf-end-layer.xml +++ b/reference/pdf/functions/pdf-end-layer.xml @@ -1,21 +1,22 @@ - - + - pdf_end_layer + PDF_end_layer Deactivate all active layers &reftitle.description; - boolpdf_end_layer + boolPDF_end_layer resourcepdfdoc Deactivates all active layers. &return.success; - This function requires PDF 1.5. + + This function requires PDF 1.5. + diff --git a/reference/pdf/functions/pdf-end-page-ext.xml b/reference/pdf/functions/pdf-end-page-ext.xml index 36a0d0a780..c4ff35fa3d 100644 --- a/reference/pdf/functions/pdf-end-page-ext.xml +++ b/reference/pdf/functions/pdf-end-page-ext.xml @@ -1,15 +1,14 @@ - - + - pdf_end_page_ext + PDF_end_page_ext Finish page &reftitle.description; - boolpdf_end_page_ext + boolPDF_end_page_ext resourcepdfdoc stringoptlist diff --git a/reference/pdf/functions/pdf-end-page.xml b/reference/pdf/functions/pdf-end-page.xml index 50e4f3dd3e..cc01aed384 100644 --- a/reference/pdf/functions/pdf-end-page.xml +++ b/reference/pdf/functions/pdf-end-page.xml @@ -1,23 +1,19 @@ - - + - pdf_end_page + PDF_end_page Finish page &reftitle.description; - boolpdf_end_page + boolPDF_end_page resourcep Finishes the page. &return.success; - - See also pdf_begin_page_ext. - diff --git a/reference/pdf/functions/pdf-end-pattern.xml b/reference/pdf/functions/pdf-end-pattern.xml index ab3213cea8..9266024094 100644 --- a/reference/pdf/functions/pdf-end-pattern.xml +++ b/reference/pdf/functions/pdf-end-pattern.xml @@ -1,23 +1,19 @@ - - + - pdf_end_pattern + PDF_end_pattern Finish pattern &reftitle.description; - boolpdf_end_pattern + boolPDF_end_pattern resourcep Finishes the pattern definition. &return.success; - - See also pdf_begin_pattern. - diff --git a/reference/pdf/functions/pdf-end-template.xml b/reference/pdf/functions/pdf-end-template.xml index 094d45f424..57afedbc00 100644 --- a/reference/pdf/functions/pdf-end-template.xml +++ b/reference/pdf/functions/pdf-end-template.xml @@ -1,15 +1,14 @@ - - + - pdf_end_template + PDF_end_template Finish template &reftitle.description; - boolpdf_end_template + boolPDF_end_template resourcep diff --git a/reference/pdf/functions/pdf-endpath.xml b/reference/pdf/functions/pdf-endpath.xml index e17cdb834e..08132fcc9d 100644 --- a/reference/pdf/functions/pdf-endpath.xml +++ b/reference/pdf/functions/pdf-endpath.xml @@ -1,9 +1,8 @@ - - + - pdf_endpath + PDF_endpath End current path diff --git a/reference/pdf/functions/pdf-fill-imageblock.xml b/reference/pdf/functions/pdf-fill-imageblock.xml index 4c75cfe3f8..21f58b9b96 100644 --- a/reference/pdf/functions/pdf-fill-imageblock.xml +++ b/reference/pdf/functions/pdf-fill-imageblock.xml @@ -1,27 +1,27 @@ - - + - pdf_fill_imageblock + PDF_fill_imageblock Fill image block with variable data &reftitle.description; - intpdf_fill_imageblock + intPDF_fill_imageblock resourcepdfdoc intpage stringblockname - intimage + intimage stringoptlist Fills an image block with variable data according to its properties. - - This function is only available in the PDFlib Personalization Server (PPS). - + + This function is only available in the PDFlib Personalization + Server (PPS). + diff --git a/reference/pdf/functions/pdf-fill-pdfblock.xml b/reference/pdf/functions/pdf-fill-pdfblock.xml index 651353f854..81c32eb05e 100644 --- a/reference/pdf/functions/pdf-fill-pdfblock.xml +++ b/reference/pdf/functions/pdf-fill-pdfblock.xml @@ -1,27 +1,27 @@ - - + - pdf_fill_pdfblock - Fill image block with variable data + PDF_fill_pdfblock + Fill PDF block with variable data &reftitle.description; - intpdf_fill_pdfblock + intPDF_fill_pdfblock resourcepdfdoc intpage stringblockname - intcontents + intcontents stringoptlist Fills a PDF block with variable data according to its properties. - This function is only available in the PDFlib Personalization Server (PPS). - + This function is only available in the PDFlib Personalization + Server (PPS). + diff --git a/reference/pdf/functions/pdf-fill-stroke.xml b/reference/pdf/functions/pdf-fill-stroke.xml index 31f144edb9..eb621177d4 100644 --- a/reference/pdf/functions/pdf-fill-stroke.xml +++ b/reference/pdf/functions/pdf-fill-stroke.xml @@ -1,24 +1,20 @@ - - + - pdf_fill_stroke + PDF_fill_stroke Fill and stroke path &reftitle.description; - boolpdf_fill_stroke + boolPDF_fill_stroke resourcep Fills and strokes the current path with the current fill and stroke color. &return.success; - - See also pdf_setcolor. - diff --git a/reference/pdf/functions/pdf-fill-textblock.xml b/reference/pdf/functions/pdf-fill-textblock.xml index a1baf09997..81ddf6b3b7 100644 --- a/reference/pdf/functions/pdf-fill-textblock.xml +++ b/reference/pdf/functions/pdf-fill-textblock.xml @@ -1,27 +1,27 @@ - - + - pdf_fill_textblock + PDF_fill_textblock Fill text block with variable data &reftitle.description; - intpdf_fill_textblock + intPDF_fill_textblock resourcepdfdoc intpage - stringblockname - stringtext + stringblockname + stringtext stringoptlist Fills a text block with variable data according to its properties. - This function is only available in the PDFlib Personalization Server (PPS). - + This function is only available in the PDFlib Personalization + Server (PPS). + diff --git a/reference/pdf/functions/pdf-fill.xml b/reference/pdf/functions/pdf-fill.xml index d35acd8ab5..d18c305711 100644 --- a/reference/pdf/functions/pdf-fill.xml +++ b/reference/pdf/functions/pdf-fill.xml @@ -1,24 +1,20 @@ - - + - pdf_fill + PDF_fill Fill current path &reftitle.description; - boolpdf_fill + boolPDF_fill resourcep Fills the interior of the current path with the current fill color. &return.success; - - See also pdf_setcolor. - diff --git a/reference/pdf/functions/pdf-findfont.xml b/reference/pdf/functions/pdf-findfont.xml index 98e3d96916..e63945ba49 100644 --- a/reference/pdf/functions/pdf-findfont.xml +++ b/reference/pdf/functions/pdf-findfont.xml @@ -1,22 +1,21 @@ - - + - pdf_findfont + PDF_findfont Prepare font for later use [deprecated] &reftitle.description; - intpdf_findfont + intPDF_findfont resourcep stringfontname stringencoding intembed - Search for a font and prepare it for later use with pdf_setfont. + Search for a font and prepare it for later use with PDF_setfont. The metrics will be loaded, and if embed is nonzero, the font file will be checked, but not yet used. encoding is one of builtin, @@ -28,7 +27,7 @@ This function is deprecated since PDFlib version 5, use - pdf_load_font instead. + PDF_load_font instead. diff --git a/reference/pdf/functions/pdf-fit-image.xml b/reference/pdf/functions/pdf-fit-image.xml index c18f1df74c..e7b39acfe6 100644 --- a/reference/pdf/functions/pdf-fit-image.xml +++ b/reference/pdf/functions/pdf-fit-image.xml @@ -1,24 +1,22 @@ - - + - pdf_fit_image + PDF_fit_image Place image or template &reftitle.description; - boolpdf_fit_image + boolPDF_fit_image resourcepdfdoc - intimage - floatx - floaty + intimage + floatx + floaty stringoptlist - Places an image or template at position (x, - y) on the page, subject to various options. + Places an image or template on the page, subject to various options. &return.success; diff --git a/reference/pdf/functions/pdf-fit-pdi-page.xml b/reference/pdf/functions/pdf-fit-pdi-page.xml index 1d30f0b5ff..6f0e10dcdc 100644 --- a/reference/pdf/functions/pdf-fit-pdi-page.xml +++ b/reference/pdf/functions/pdf-fit-pdi-page.xml @@ -1,19 +1,18 @@ - - + - pdf_fit_pdi_page + PDF_fit_pdi_page Place imported PDF page &reftitle.description; - boolpdf_fit_pdi_page + boolPDF_fit_pdi_page resourcepdfdoc - intpage - floatx - floaty + intpage + floatx + floaty stringoptlist diff --git a/reference/pdf/functions/pdf-fit-textflow.xml b/reference/pdf/functions/pdf-fit-textflow.xml index 8c1a01f481..7d0fe419d6 100644 --- a/reference/pdf/functions/pdf-fit-textflow.xml +++ b/reference/pdf/functions/pdf-fit-textflow.xml @@ -1,21 +1,20 @@ - - + - pdf_fit_textflow + PDF_fit_textflow Format textflow in rectangular area &reftitle.description; - stringpdf_fit_textflow + stringPDF_fit_textflow resourcepdfdoc - inttextflow - floatllx - floatlly - floaturx - floatury + inttextflow + floatllx + floatlly + floaturx + floatury stringoptlist diff --git a/reference/pdf/functions/pdf-fit-textline.xml b/reference/pdf/functions/pdf-fit-textline.xml index e2bc226459..9bd8a2edd4 100644 --- a/reference/pdf/functions/pdf-fit-textline.xml +++ b/reference/pdf/functions/pdf-fit-textline.xml @@ -1,24 +1,22 @@ - - + - pdf_fit_textline + PDF_fit_textline Place single line of text &reftitle.description; - boolpdf_fit_textline + boolPDF_fit_textline resourcepdfdoc - stringtext + inttext floatx floaty stringoptlist - Places a single line of text at position (x, - y) on the page, subject to various options. &return.success; + Places a single line of texton the page, subject to various options. &return.success; diff --git a/reference/pdf/functions/pdf-get-apiname.xml b/reference/pdf/functions/pdf-get-apiname.xml index 6acdf09795..a009ab794a 100644 --- a/reference/pdf/functions/pdf-get-apiname.xml +++ b/reference/pdf/functions/pdf-get-apiname.xml @@ -1,15 +1,14 @@ - - + - pdf_get_apiname + PDF_get_apiname Get name of unsuccessfull API function &reftitle.description; - stringpdf_get_apiname + stringPDF_get_apiname resourcepdfdoc diff --git a/reference/pdf/functions/pdf-get-buffer.xml b/reference/pdf/functions/pdf-get-buffer.xml index e4888986f9..2c5111bf04 100644 --- a/reference/pdf/functions/pdf-get-buffer.xml +++ b/reference/pdf/functions/pdf-get-buffer.xml @@ -1,20 +1,18 @@ - - + - pdf_get_buffer + PDF_get_buffer Get PDF output buffer &reftitle.description; - stringpdf_get_buffer + stringPDF_get_buffer resourcep - Fetches the buffer containing the generated PDF data. The result must be - used by the client before calling any other PDFlib function. + Fetches the buffer containing the generated PDF data. diff --git a/reference/pdf/functions/pdf-get-errmsg.xml b/reference/pdf/functions/pdf-get-errmsg.xml index 4c9953d8da..05fd83979d 100644 --- a/reference/pdf/functions/pdf-get-errmsg.xml +++ b/reference/pdf/functions/pdf-get-errmsg.xml @@ -1,15 +1,14 @@ - - + - pdf_get_errmsg + PDF_get_errmsg Get error text &reftitle.description; - stringpdf_get_errmsg + stringPDF_get_errmsg resourcepdfdoc diff --git a/reference/pdf/functions/pdf-get-errnum.xml b/reference/pdf/functions/pdf-get-errnum.xml index d8e1633649..68736e6a05 100644 --- a/reference/pdf/functions/pdf-get-errnum.xml +++ b/reference/pdf/functions/pdf-get-errnum.xml @@ -1,20 +1,19 @@ - - + - pdf_get_errnum + PDF_get_errnum Get error number &reftitle.description; - intpdf_get_errnum + intPDF_get_errnum resourcepdfdoc Gets the number of the last thrown exception or the reason for a failed - function call. + function call. diff --git a/reference/pdf/functions/pdf-get-font.xml b/reference/pdf/functions/pdf-get-font.xml index 9b32ef7999..67c44ef09a 100644 --- a/reference/pdf/functions/pdf-get-font.xml +++ b/reference/pdf/functions/pdf-get-font.xml @@ -1,16 +1,15 @@ - - + - pdf_get_font + PDF_get_font Get font [deprecated] &reftitle.description; This function is deprecated since PDFlib version 3, - use pdf_get_value with the parameter + use PDF_get_value with the parameter font instead. diff --git a/reference/pdf/functions/pdf-get-fontname.xml b/reference/pdf/functions/pdf-get-fontname.xml index 23d8a976d2..15028d21fd 100644 --- a/reference/pdf/functions/pdf-get-fontname.xml +++ b/reference/pdf/functions/pdf-get-fontname.xml @@ -1,16 +1,15 @@ - - + - pdf_get_fontname + PDF_get_fontname Get font name [deprecated] &reftitle.description; This function is deprecated since PDFlib version 3, use - pdf_get_parameter with the parameter + PDF_get_parameter with the parameter fontname instead. diff --git a/reference/pdf/functions/pdf-get-fontsize.xml b/reference/pdf/functions/pdf-get-fontsize.xml index 2ff6bcc754..2f668c601a 100644 --- a/reference/pdf/functions/pdf-get-fontsize.xml +++ b/reference/pdf/functions/pdf-get-fontsize.xml @@ -1,16 +1,15 @@ - - + - pdf_get_fontsize + PDF_get_fontsize Font handling [deprecated] &reftitle.description; This function is deprecated since PDFlib version 3, use - pdf_get_value with the parameter + PDF_get_value with the parameter fontsizeinstead. diff --git a/reference/pdf/functions/pdf-get-image-height.xml b/reference/pdf/functions/pdf-get-image-height.xml index 46c61e386f..b1b4a0a2c7 100644 --- a/reference/pdf/functions/pdf-get-image-height.xml +++ b/reference/pdf/functions/pdf-get-image-height.xml @@ -1,17 +1,16 @@ - - + - pdf_get_image_height + PDF_get_image_height Get image height [deprecated] &reftitle.description; This function is deprecated since PDFlib version 3, use - pdf_get_value with the parameter - imageheight instead. + PDF_get_value with the parameter + imageheight instead. diff --git a/reference/pdf/functions/pdf-get-image-width.xml b/reference/pdf/functions/pdf-get-image-width.xml index f1671e5222..11e735b10f 100644 --- a/reference/pdf/functions/pdf-get-image-width.xml +++ b/reference/pdf/functions/pdf-get-image-width.xml @@ -1,16 +1,15 @@ - - + - pdf_get_image_width + PDF_get_image_width Get image width [deprecated] &reftitle.description; This function is deprecated since PDFlib version 3, use - pdf_get_value with the parameter + PDF_get_value with the parameter imagewidth instead. diff --git a/reference/pdf/functions/pdf-get-majorversion.xml b/reference/pdf/functions/pdf-get-majorversion.xml index 3357a4715e..4c1d39af68 100644 --- a/reference/pdf/functions/pdf-get-majorversion.xml +++ b/reference/pdf/functions/pdf-get-majorversion.xml @@ -1,23 +1,19 @@ - - + - pdf_get_majorversion + PDF_get_majorversion Get major version number [deprecated] &reftitle.description; - intpdf_get_majorversion + intPDF_get_majorversion - - Returns the major version number of the PDFlib version. - This function is deprecated since PDFlib version 5, use - pdf_get_value with the parameter + PDF_get_value with the parameter major instead. diff --git a/reference/pdf/functions/pdf-get-minorversion.xml b/reference/pdf/functions/pdf-get-minorversion.xml index 6e06d66d16..2acb37d1c3 100644 --- a/reference/pdf/functions/pdf-get-minorversion.xml +++ b/reference/pdf/functions/pdf-get-minorversion.xml @@ -1,15 +1,14 @@ - - + - pdf_get_minorversion + PDF_get_minorversion Get minor version number [deprecated] &reftitle.description; - intpdf_get_minorversion + intPDF_get_minorversion @@ -17,7 +16,7 @@ This function is deprecated since PDFlib version 5, use - pdf_get_value with the parameter + PDF_get_value with the parameter minor instead. diff --git a/reference/pdf/functions/pdf-get-parameter.xml b/reference/pdf/functions/pdf-get-parameter.xml index b76db2a846..2c5591636c 100644 --- a/reference/pdf/functions/pdf-get-parameter.xml +++ b/reference/pdf/functions/pdf-get-parameter.xml @@ -1,15 +1,14 @@ - - + - pdf_get_parameter + PDF_get_parameter Get string parameter &reftitle.description; - stringpdf_get_parameter + stringPDF_get_parameter resourcep stringkey floatmodifier diff --git a/reference/pdf/functions/pdf-get-pdi-parameter.xml b/reference/pdf/functions/pdf-get-pdi-parameter.xml index 3d0715dca9..61511e0936 100644 --- a/reference/pdf/functions/pdf-get-pdi-parameter.xml +++ b/reference/pdf/functions/pdf-get-pdi-parameter.xml @@ -1,15 +1,14 @@ - - + - pdf_get_pdi_parameter + PDF_get_pdi_parameter Get PDI string parameter &reftitle.description; - stringpdf_get_pdi_parameter + stringPDF_get_pdi_parameter resourcep stringkey intdoc diff --git a/reference/pdf/functions/pdf-get-pdi-value.xml b/reference/pdf/functions/pdf-get-pdi-value.xml index 1744c59b9b..986ae62989 100644 --- a/reference/pdf/functions/pdf-get-pdi-value.xml +++ b/reference/pdf/functions/pdf-get-pdi-value.xml @@ -1,15 +1,14 @@ - - + - pdf_get_pdi_value + PDF_get_pdi_value Get PDI numerical parameter &reftitle.description; - floatpdf_get_pdi_value + floatPDF_get_pdi_value resourcep stringkey intdoc diff --git a/reference/pdf/functions/pdf-get-value.xml b/reference/pdf/functions/pdf-get-value.xml index 36f9e86e6e..92debf8b62 100644 --- a/reference/pdf/functions/pdf-get-value.xml +++ b/reference/pdf/functions/pdf-get-value.xml @@ -1,15 +1,14 @@ - - + - pdf_get_value + PDF_get_value Get numerical parameter &reftitle.description; - floatpdf_get_value + floatPDF_get_value resourcep stringkey floatmodifier diff --git a/reference/pdf/functions/pdf-info-textflow.xml b/reference/pdf/functions/pdf-info-textflow.xml index 8371d1219e..2ad6544f64 100644 --- a/reference/pdf/functions/pdf-info-textflow.xml +++ b/reference/pdf/functions/pdf-info-textflow.xml @@ -1,22 +1,20 @@ - - + - pdf_info_textflow + PDF_info_textflow Query textflow state &reftitle.description; - floatpdf_info_textflow + floatPDF_info_textflow resourcepdfdoc - inttextflow - stringkeyword + inttextflow + stringkeyword - Queries the current state of a textflow. This function returns the value - of some textflow parameter as requested by keyword. + Queries the current state of a textflow. diff --git a/reference/pdf/functions/pdf-initgraphics.xml b/reference/pdf/functions/pdf-initgraphics.xml index e075d86473..a4bf5df98a 100644 --- a/reference/pdf/functions/pdf-initgraphics.xml +++ b/reference/pdf/functions/pdf-initgraphics.xml @@ -1,15 +1,14 @@ - - + - pdf_initgraphics + PDF_initgraphics Reset graphic state &reftitle.description; - boolpdf_initgraphics + boolPDF_initgraphics resourcep diff --git a/reference/pdf/functions/pdf-lineto.xml b/reference/pdf/functions/pdf-lineto.xml index 99a282124f..e833b26789 100644 --- a/reference/pdf/functions/pdf-lineto.xml +++ b/reference/pdf/functions/pdf-lineto.xml @@ -1,22 +1,20 @@ - - + - pdf_lineto + PDF_lineto Draw a line &reftitle.description; - boolpdf_lineto + boolPDF_lineto resourcep floatx floaty - Draws a line from the current point to (x, - y). &return.success; + Draws a line from the current point to another point. &return.success; diff --git a/reference/pdf/functions/pdf-load-font.xml b/reference/pdf/functions/pdf-load-font.xml index b31f664b03..5a9d0bb23a 100644 --- a/reference/pdf/functions/pdf-load-font.xml +++ b/reference/pdf/functions/pdf-load-font.xml @@ -1,23 +1,21 @@ - - + - pdf_load_font + PDF_load_font Search and prepare font &reftitle.description; - intpdf_load_font + intPDF_load_font resourcepdfdoc - stringfontname - stringencoding - stringoptlist + stringfontname + stringencoding + stringoptlist - Searches for a font and prepares it for later use. This function returns - a font handle for later use with pdf_setfont. + Searches for a font and prepares it for later use. diff --git a/reference/pdf/functions/pdf-load-iccprofile.xml b/reference/pdf/functions/pdf-load-iccprofile.xml index 47b6fb937b..07cc0fb4cd 100644 --- a/reference/pdf/functions/pdf-load-iccprofile.xml +++ b/reference/pdf/functions/pdf-load-iccprofile.xml @@ -1,22 +1,20 @@ - - + - pdf_load_iccprofile + PDF_load_iccprofile Search and prepare ICC profile &reftitle.description; - intpdf_load_iccprofile + intPDF_load_iccprofile resourcepdfdoc - stringprofilename - stringoptlist + stringprofilename + stringoptlist - Searches for an ICC profile, and prepares it for later use. This function - returns a profile handle which can be used in subsequent calls to pdf_load_image or for setting profile-related parameters. + Searches for an ICC profile, and prepares it for later use. diff --git a/reference/pdf/functions/pdf-load-image.xml b/reference/pdf/functions/pdf-load-image.xml index 172077d1ea..af04436dbd 100644 --- a/reference/pdf/functions/pdf-load-image.xml +++ b/reference/pdf/functions/pdf-load-image.xml @@ -1,24 +1,21 @@ - - + - pdf_load_image + PDF_load_image Open image file &reftitle.description; - intpdf_load_image + intPDF_load_image resourcepdfdoc - stringimagetype - stringfilename - stringoptlist + stringimagetype + stringfilename + stringoptlist - Opens a disk-based or virtual image file subject to various options. This - function returns an image handle which can be used in subsequent - image-related calls. + Opens a disk-based or virtual image file subject to various options. diff --git a/reference/pdf/functions/pdf-makespotcolor.xml b/reference/pdf/functions/pdf-makespotcolor.xml index 30e6156f5e..71dc189a13 100644 --- a/reference/pdf/functions/pdf-makespotcolor.xml +++ b/reference/pdf/functions/pdf-makespotcolor.xml @@ -1,15 +1,14 @@ - - + - pdf_makespotcolor + PDF_makespotcolor Make spot color &reftitle.description; - intpdf_makespotcolor + intPDF_makespotcolor resourcep stringspotname @@ -17,9 +16,6 @@ Finds a built-in spot color name, or makes a named spot color from the current fill color. &return.success; - - See also pdf_setcolor. - diff --git a/reference/pdf/functions/pdf-moveto.xml b/reference/pdf/functions/pdf-moveto.xml index 02a9abd3b2..f8759fae97 100644 --- a/reference/pdf/functions/pdf-moveto.xml +++ b/reference/pdf/functions/pdf-moveto.xml @@ -1,30 +1,21 @@ - - + - pdf_moveto + PDF_moveto Set current point &reftitle.description; - boolpdf_moveto + boolPDF_moveto resourcep floatx floaty - Sets the current point for graphics output to (x, - y. &return.success; + Sets the current point for graphics output. &return.success; - - - The current point for graphics and the current text output position are - maintained separately. See pdf_set_text_pos to set - the text output position. - - diff --git a/reference/pdf/functions/pdf-new.xml b/reference/pdf/functions/pdf-new.xml index a44d752730..660f350ee5 100644 --- a/reference/pdf/functions/pdf-new.xml +++ b/reference/pdf/functions/pdf-new.xml @@ -1,20 +1,18 @@ - - + - pdf_new + PDF_new Create PDFlib object &reftitle.description; - resourcepdf_new + resourcePDF_new - Creates a new PDFlib object with default settings, using PDFlib's - internal default error handling and memory allocation routines. + Creates a new PDFlib object with default settings. diff --git a/reference/pdf/functions/pdf-open-ccitt.xml b/reference/pdf/functions/pdf-open-ccitt.xml index 3dc95e1638..7f0b01d982 100644 --- a/reference/pdf/functions/pdf-open-ccitt.xml +++ b/reference/pdf/functions/pdf-open-ccitt.xml @@ -1,15 +1,14 @@ - - + - pdf_open_ccitt + PDF_open_ccitt Open raw CCITT image [deprecated] &reftitle.description; - intpdf_open_ccitt + intPDF_open_ccitt resourcepdfdoc stringfilename intwidth @@ -19,12 +18,11 @@ intBlackls1 - Opens a raw CCITT image. - + Opens a raw CCITT image. + This function is deprecated since PDFlib version 5, - use pdf_load_image instead. - - + use PDF_load_image instead. + diff --git a/reference/pdf/functions/pdf-open-file.xml b/reference/pdf/functions/pdf-open-file.xml index ecebbd9a2b..6db611c57f 100644 --- a/reference/pdf/functions/pdf-open-file.xml +++ b/reference/pdf/functions/pdf-open-file.xml @@ -1,31 +1,24 @@ - - + - pdf_open_file + PDF_open_file Create PDF file [deprecated] &reftitle.description; - boolpdf_open_file + boolPDF_open_file resourcep stringfilename Creates a new PDF file using the supplied file name. - If filename is empty the PDF document - will be generated in memory instead of on file. The result - must be fetched by the client with the - pdf_get_buffer function. - Parameter filename is optional before - PHP 4.3.5 or with PDFlib less than 5. &return.success; - + This function is deprecated since PDFlib version 6, use - pdf_begin_document instead. + PDF_begin_document instead. diff --git a/reference/pdf/functions/pdf-open-gif.xml b/reference/pdf/functions/pdf-open-gif.xml index 977c0ec811..faad48990f 100644 --- a/reference/pdf/functions/pdf-open-gif.xml +++ b/reference/pdf/functions/pdf-open-gif.xml @@ -1,16 +1,15 @@ - - + - pdf_open_gif + PDF_open_gif Open GIF image [deprecated] &reftitle.description; This function is deprecated since PDFlib version 3, use - pdf_load_image instead. + PDF_load_image instead. diff --git a/reference/pdf/functions/pdf-open-image-file.xml b/reference/pdf/functions/pdf-open-image-file.xml index b1e1b0ad48..ab8e48aa48 100644 --- a/reference/pdf/functions/pdf-open-image-file.xml +++ b/reference/pdf/functions/pdf-open-image-file.xml @@ -1,15 +1,14 @@ - - + - pdf_open_image_file + PDF_open_image_file Read image from file [deprecated] &reftitle.description; - intpdf_open_image_file + intPDF_open_image_file resourcep stringimagetype stringfilename @@ -17,21 +16,13 @@ intintparam - Opens an image file. Supported types are jpeg, - tiff, gif, and png. - stringparam is either empty, - mask, masked, or - page. - intparam is either 0, the image id - of the applied mask, or the page. - Parameters stringparam and - intparam are optional before PHP 4.3.5 or with - PDFlib less than 5. + Opens an image file. - + This function is deprecated since PDFlib version 5, use - pdf_load_image instead. - + PDF_load_image with the colorize, ignoremask, + invert, mask, masked, and page options instead. + diff --git a/reference/pdf/functions/pdf-open-image.xml b/reference/pdf/functions/pdf-open-image.xml index 247c33894c..73910b96a8 100644 --- a/reference/pdf/functions/pdf-open-image.xml +++ b/reference/pdf/functions/pdf-open-image.xml @@ -1,15 +1,14 @@ - - + - pdf_open_image + PDF_open_image Use image data [deprecated] &reftitle.description; - intpdf_open_image + intPDF_open_image resourcep stringimagetype stringsource @@ -22,17 +21,12 @@ stringparams - Uses image data from a variety of data sources. Supported types are - jpeg, ccitt, raw. - Supported sources are memory, fileref, - url. len is only used when type is - raw, params is only used when type - is ccitt. + Uses image data from a variety of data sources. + + + This function is deprecated since PDFlib version 5, use virtual files + and PDF_load_image instead. - - This function is deprecated since PDFlib version 5, use virtual files - and pdf_load_image instead. - diff --git a/reference/pdf/functions/pdf-open-jpeg.xml b/reference/pdf/functions/pdf-open-jpeg.xml index 6a1634e591..3e5d922152 100644 --- a/reference/pdf/functions/pdf-open-jpeg.xml +++ b/reference/pdf/functions/pdf-open-jpeg.xml @@ -1,17 +1,16 @@ - - + - pdf_open_jpeg + PDF_open_jpeg Open JPEG image [deprecated] &reftitle.description; - - This function is deprecated since PDFlib version 3, use - pdf_load_image instead. - + + This function is deprecated since PDFlib version 3, use + PDF_load_image instead. + diff --git a/reference/pdf/functions/pdf-open-memory-image.xml b/reference/pdf/functions/pdf-open-memory-image.xml index 14f8c154f1..e3fc4b5c4a 100644 --- a/reference/pdf/functions/pdf-open-memory-image.xml +++ b/reference/pdf/functions/pdf-open-memory-image.xml @@ -1,15 +1,14 @@ - - + - pdf_open_memory_image + PDF_open_memory_image Open image created with PHP's image functions [not supported] &reftitle.description; - intpdf_open_memory_image + intPDF_open_memory_image resourcep resourceimage diff --git a/reference/pdf/functions/pdf-open-pdi-page.xml b/reference/pdf/functions/pdf-open-pdi-page.xml index 78b84c8900..3c90bc5497 100644 --- a/reference/pdf/functions/pdf-open-pdi-page.xml +++ b/reference/pdf/functions/pdf-open-pdi-page.xml @@ -1,9 +1,8 @@ - - + - pdf_open_pdi_page + PDF_open_pdi_page Prepare a page @@ -11,14 +10,14 @@ &reftitle.description; - intpdf_open_pdi_page + intPDF_open_pdi_page resourcep intdoc intpagenumber stringoptlist - Prepares a page for later use with pdf_fit_pdi_page. + Prepares a page for later use with PDF_fit_pdi_page. diff --git a/reference/pdf/functions/pdf-open-pdi.xml b/reference/pdf/functions/pdf-open-pdi.xml index 8ccbc878f5..76e58f3bdd 100644 --- a/reference/pdf/functions/pdf-open-pdi.xml +++ b/reference/pdf/functions/pdf-open-pdi.xml @@ -1,26 +1,21 @@ - - + - pdf_open_pdi + PDF_open_pdi Open PDF file &reftitle.description; - - intpdf_open_pdi - resourcepdfdoc - stringfilename - stringoptlist - intlen - - - Opens a disk-based or virtual PDF document and prepares it for later use. - - - See also pdf_close_pdi. - + + intPDF_open_pdi + resourcepdfdoc + stringfilename + stringoptlist + + + Opens a disk-based or virtual PDF document and prepares it for later use. + diff --git a/reference/pdf/functions/pdf-open-tiff.xml b/reference/pdf/functions/pdf-open-tiff.xml index aaad44224c..f953eac06c 100644 --- a/reference/pdf/functions/pdf-open-tiff.xml +++ b/reference/pdf/functions/pdf-open-tiff.xml @@ -1,16 +1,15 @@ - - + - pdf_open_tiff + PDF_open_tiff Open TIFF image [deprecated] &reftitle.description; This function is deprecated since PDFlib version 3, use - pdf_load_image instead. + PDF_load_image instead. diff --git a/reference/pdf/functions/pdf-place-image.xml b/reference/pdf/functions/pdf-place-image.xml index 31d54aa01d..20deed2a68 100644 --- a/reference/pdf/functions/pdf-place-image.xml +++ b/reference/pdf/functions/pdf-place-image.xml @@ -1,15 +1,14 @@ - - + - pdf_place_image + PDF_place_image Place image on the page [deprecated] &reftitle.description; - boolpdf_place_image + boolPDF_place_image resourcepdfdoc intimage floatx @@ -17,13 +16,12 @@ floatscale - Places an image with the lower left corner at (x, - y), and scales it. &return.success; + Places an image and scales it. &return.success; - + This function is deprecated since PDFlib version 5, use - pdf_fit_image instead. - + PDF_fit_image instead. + diff --git a/reference/pdf/functions/pdf-place-pdi-page.xml b/reference/pdf/functions/pdf-place-pdi-page.xml index b8e92de776..1538bfd526 100644 --- a/reference/pdf/functions/pdf-place-pdi-page.xml +++ b/reference/pdf/functions/pdf-place-pdi-page.xml @@ -1,15 +1,14 @@ - - + - pdf_place_pdi_page + PDF_place_pdi_page Place PDF page [deprecated] &reftitle.description; - boolpdf_place_pdi_page + boolPDF_place_pdi_page resourcepdfdoc intpage floatx @@ -18,13 +17,12 @@ floatsy - Places a PDF page with the lower left corner at (x, - y), and scales it. &return.success; + Places a PDF page and scales it. &return.success; + + + This function is deprecated since PDFlib version 5, use + PDF_fit_pdi_page instead. - - This function is deprecated since PDFlib version 5, use - pdf_fit_pdi_page instead. - diff --git a/reference/pdf/functions/pdf-process-pdi.xml b/reference/pdf/functions/pdf-process-pdi.xml index 21b82856ff..bc2b3e308a 100644 --- a/reference/pdf/functions/pdf-process-pdi.xml +++ b/reference/pdf/functions/pdf-process-pdi.xml @@ -1,23 +1,22 @@ - - + - pdf_process_pdi - Process imported PDF document + PDF_process_pdi + Process imported PDF document &reftitle.description; - - intpdf_process_pdi - resourcepdfdoc - intdoc - intpage - stringoptlist - - - Processes certain elements of an imported PDF document. - + + intPDF_process_pdi + resourcepdfdoc + intdoc + intpage + stringoptlist + + + Processes certain elements of an imported PDF document. + diff --git a/reference/pdf/functions/pdf-rect.xml b/reference/pdf/functions/pdf-rect.xml index 5528eef1e6..d1ab2c5425 100644 --- a/reference/pdf/functions/pdf-rect.xml +++ b/reference/pdf/functions/pdf-rect.xml @@ -1,15 +1,14 @@ - - + - pdf_rect + PDF_rect Draw rectangle &reftitle.description; - boolpdf_rect + boolPDF_rect resourcep floatx floaty @@ -17,9 +16,7 @@ floatheight - Draws a (width * height) - rectangle at lower left (x, y). - &return.success; + Draws a rectangle. &return.success; diff --git a/reference/pdf/functions/pdf-restore.xml b/reference/pdf/functions/pdf-restore.xml index 7d3892da86..42776c12a1 100644 --- a/reference/pdf/functions/pdf-restore.xml +++ b/reference/pdf/functions/pdf-restore.xml @@ -1,15 +1,14 @@ - - + - pdf_restore + PDF_restore Restore graphics state &reftitle.description; - boolpdf_restore + boolPDF_restore resourcep diff --git a/reference/pdf/functions/pdf-resume-page.xml b/reference/pdf/functions/pdf-resume-page.xml index 90e8b3712c..70d032f01d 100644 --- a/reference/pdf/functions/pdf-resume-page.xml +++ b/reference/pdf/functions/pdf-resume-page.xml @@ -1,24 +1,19 @@ - - + - pdf_resume_page + PDF_resume_page Resume page &reftitle.description; - boolpdf_resume_page + boolPDF_resume_page resourcepdfdoc - stringoptlist + stringoptlist - Resumes a page to add more content to it. The page must have been - suspended with pdf_suspend_page. It will be - opened again so that more content can be added. All suspended pages - must be resumed before they can be closed, even if no more content has - been added. + Resumes a page to add more content to it. diff --git a/reference/pdf/functions/pdf-rotate.xml b/reference/pdf/functions/pdf-rotate.xml index 9274442129..4ce9e7f4f3 100644 --- a/reference/pdf/functions/pdf-rotate.xml +++ b/reference/pdf/functions/pdf-rotate.xml @@ -1,21 +1,19 @@ - - + - pdf_rotate + PDF_rotate Rotate coordinate system &reftitle.description; - boolpdf_rotate + boolPDF_rotate resourcep floatphi - Rotates the coordinate system by phi degrees. - &return.success; + Rotates the coordinate system. &return.success; diff --git a/reference/pdf/functions/pdf-save.xml b/reference/pdf/functions/pdf-save.xml index fd59c11e75..8676666484 100644 --- a/reference/pdf/functions/pdf-save.xml +++ b/reference/pdf/functions/pdf-save.xml @@ -1,15 +1,14 @@ - - + - pdf_save + PDF_save Save graphics state &reftitle.description; - boolpdf_save + boolPDF_save resourcep diff --git a/reference/pdf/functions/pdf-scale.xml b/reference/pdf/functions/pdf-scale.xml index b75e711de0..224ad3f727 100644 --- a/reference/pdf/functions/pdf-scale.xml +++ b/reference/pdf/functions/pdf-scale.xml @@ -1,22 +1,20 @@ - - + - pdf_scale + PDF_scale Scale coordinate system &reftitle.description; - boolpdf_scale + boolPDF_scale resourcep floatsx floatsy - Scales the coordinate system by sx in x direction - and sy in y direction. &return.success; + Scales the coordinate system. &return.success; diff --git a/reference/pdf/functions/pdf-set-border-color.xml b/reference/pdf/functions/pdf-set-border-color.xml index c8c7786b91..be260e7681 100644 --- a/reference/pdf/functions/pdf-set-border-color.xml +++ b/reference/pdf/functions/pdf-set-border-color.xml @@ -1,15 +1,14 @@ - - + - pdf_set_border_color + PDF_set_border_color Set border color of annotations [deprecated] &reftitle.description; - boolpdf_set_border_color + boolPDF_set_border_color resourcep floatred floatgreen @@ -18,11 +17,11 @@ Sets the border color for all kinds of annotations. &return.success; - - This function is deprecated since PDFlib version 6, use - the option annotcolor in - pdf_create_annotation instead. - + + This function is deprecated since PDFlib version 6, use + the option annotcolor in + PDF_create_annotation instead. + diff --git a/reference/pdf/functions/pdf-set-border-dash.xml b/reference/pdf/functions/pdf-set-border-dash.xml index b8cfd75008..2542efe0d8 100644 --- a/reference/pdf/functions/pdf-set-border-dash.xml +++ b/reference/pdf/functions/pdf-set-border-dash.xml @@ -1,15 +1,14 @@ - - + - pdf_set_border_dash + PDF_set_border_dash Set border dash style of annotations [deprecated] &reftitle.description; - boolpdf_set_border_dash + boolPDF_set_border_dash resourcepdfdoc floatblack floatwhite @@ -19,8 +18,8 @@ This function is deprecated since PDFlib version 6, use - the option dasharray in - pdf_create_annotation instead. + the option dasharray in + PDF_create_annotation instead. diff --git a/reference/pdf/functions/pdf-set-border-style.xml b/reference/pdf/functions/pdf-set-border-style.xml index a591a70ab9..88728a0e81 100644 --- a/reference/pdf/functions/pdf-set-border-style.xml +++ b/reference/pdf/functions/pdf-set-border-style.xml @@ -1,30 +1,27 @@ - - + - pdf_set_border_style + PDF_set_border_style Set border style of annotations [deprecated] &reftitle.description; - boolpdf_set_border_style + boolPDF_set_border_style resourcepdfdoc stringstyle floatwidth - Sets the border style for all kinds of annotations. - style is solid or - dashed. &return.success; + Sets the border style for all kinds of annotations. &return.success; - This function is deprecated since PDFlib version 6, use - the options borderstyle and - linewidth in - pdf_create_annotation instead. - + This function is deprecated since PDFlib version 6, use + the options borderstyle and + linewidth in + PDF_create_annotation instead. + diff --git a/reference/pdf/functions/pdf-set-char-spacing.xml b/reference/pdf/functions/pdf-set-char-spacing.xml index 2e5634c6ce..6567cfbf8b 100644 --- a/reference/pdf/functions/pdf-set-char-spacing.xml +++ b/reference/pdf/functions/pdf-set-char-spacing.xml @@ -1,16 +1,15 @@ - - + - pdf_set_char_spacing + PDF_set_char_spacing Set character spacing [deprecated] &reftitle.description; This function is deprecated since PDFlib version 3, use - pdf_set_value with parameter + PDF_set_value with parameter charspacing instead. diff --git a/reference/pdf/functions/pdf-set-duration.xml b/reference/pdf/functions/pdf-set-duration.xml index 9ff818e2ff..f1feaf2de6 100644 --- a/reference/pdf/functions/pdf-set-duration.xml +++ b/reference/pdf/functions/pdf-set-duration.xml @@ -1,17 +1,17 @@ - - + - pdf_set_duration + PDF_set_duration Set duration between pages [deprecated] &reftitle.description; This function is deprecated since PDFlib version 3, use - pdf_set_value with duration - instead. + the duration option in + PDF_begin_page_ext or + PDF_end_page_ext instead. diff --git a/reference/pdf/functions/pdf-set-gstate.xml b/reference/pdf/functions/pdf-set-gstate.xml index aeafb37489..982b901d7a 100644 --- a/reference/pdf/functions/pdf-set-gstate.xml +++ b/reference/pdf/functions/pdf-set-gstate.xml @@ -1,17 +1,16 @@ - - + - pdf_set_gstate + PDF_set_gstate Activate graphics state object &reftitle.description; - boolpdf_set_gstate + boolPDF_set_gstate resourcepdfdoc - intgstate + intgstate Activates a graphics state object. diff --git a/reference/pdf/functions/pdf-set-horiz-scaling.xml b/reference/pdf/functions/pdf-set-horiz-scaling.xml index ab77d99834..cb6a0644ac 100644 --- a/reference/pdf/functions/pdf-set-horiz-scaling.xml +++ b/reference/pdf/functions/pdf-set-horiz-scaling.xml @@ -1,16 +1,15 @@ - - + - pdf_set_horiz_scaling + PDF_set_horiz_scaling Set horizontal text scaling [deprecated] &reftitle.description; This function is deprecated since PDFlib version 3, use - pdf_set_value with parameter + PDF_set_value with parameter horizscaling instead. diff --git a/reference/pdf/functions/pdf-set-info-author.xml b/reference/pdf/functions/pdf-set-info-author.xml index 161a55e313..a4b8e96579 100644 --- a/reference/pdf/functions/pdf-set-info-author.xml +++ b/reference/pdf/functions/pdf-set-info-author.xml @@ -1,18 +1,15 @@ - - + - pdf_set_info_author - - Fill the author document info field [deprecated] - + PDF_set_info_author + Fill the author document info field [deprecated] &reftitle.description; This function is deprecated since PDFlib version 3, use - pdf_set_info instead. + PDF_set_info instead. diff --git a/reference/pdf/functions/pdf-set-info-creator.xml b/reference/pdf/functions/pdf-set-info-creator.xml index 87158c9009..bf7d08b346 100644 --- a/reference/pdf/functions/pdf-set-info-creator.xml +++ b/reference/pdf/functions/pdf-set-info-creator.xml @@ -1,9 +1,8 @@ - - + - pdf_set_info_creator + PDF_set_info_creator Fill the creator document info field [deprecated] @@ -12,7 +11,7 @@ &reftitle.description; This function is deprecated since PDFlib version 3, use - pdf_set_info instead. + PDF_set_info instead. diff --git a/reference/pdf/functions/pdf-set-info-keywords.xml b/reference/pdf/functions/pdf-set-info-keywords.xml index 7e7712bfb8..76817849bf 100644 --- a/reference/pdf/functions/pdf-set-info-keywords.xml +++ b/reference/pdf/functions/pdf-set-info-keywords.xml @@ -1,9 +1,8 @@ - - + - pdf_set_info_keywords + PDF_set_info_keywords Fill the keywords document info field [deprecated] @@ -12,7 +11,7 @@ &reftitle.description; This function is deprecated since PDFlib version 3, use - pdf_set_info instead. + PDF_set_info instead. diff --git a/reference/pdf/functions/pdf-set-info-subject.xml b/reference/pdf/functions/pdf-set-info-subject.xml index e04b890484..850f9e0ea9 100644 --- a/reference/pdf/functions/pdf-set-info-subject.xml +++ b/reference/pdf/functions/pdf-set-info-subject.xml @@ -1,9 +1,8 @@ - - + - pdf_set_info_subject + PDF_set_info_subject Fill the subject document info field [deprecated] @@ -12,7 +11,7 @@ &reftitle.description; This function is deprecated since PDFlib version 3, use - pdf_set_info instead. + PDF_set_info instead. diff --git a/reference/pdf/functions/pdf-set-info-title.xml b/reference/pdf/functions/pdf-set-info-title.xml index 1edc2e8394..2715deae93 100644 --- a/reference/pdf/functions/pdf-set-info-title.xml +++ b/reference/pdf/functions/pdf-set-info-title.xml @@ -1,9 +1,8 @@ - - + - pdf_set_info_title + PDF_set_info_title Fill the title document info field [deprecated] @@ -12,7 +11,7 @@ &reftitle.description; This function is deprecated since PDFlib version 3, use - pdf_set_info instead. + PDF_set_info instead. diff --git a/reference/pdf/functions/pdf-set-info.xml b/reference/pdf/functions/pdf-set-info.xml index d0617442ad..4b34c58156 100644 --- a/reference/pdf/functions/pdf-set-info.xml +++ b/reference/pdf/functions/pdf-set-info.xml @@ -1,15 +1,14 @@ - - + - pdf_set_info + PDF_set_info Fill document info field &reftitle.description; - boolpdf_set_info + boolPDF_set_info resourcep stringkey stringvalue diff --git a/reference/pdf/functions/pdf-set-layer-dependency.xml b/reference/pdf/functions/pdf-set-layer-dependency.xml index b86b20fdc7..467c1a361c 100644 --- a/reference/pdf/functions/pdf-set-layer-dependency.xml +++ b/reference/pdf/functions/pdf-set-layer-dependency.xml @@ -1,23 +1,24 @@ - - + - pdf_set_layer_dependency + PDF_set_layer_dependency Define relationships among layers &reftitle.description; - boolpdf_set_layer_dependency + boolPDF_set_layer_dependency resourcepdfdoc stringtype - stringoptlist + stringoptlist Defines hierarchical and group relationships among layers. &return.success; - This function requires PDF 1.5. + + This function requires PDF 1.5. + diff --git a/reference/pdf/functions/pdf-set-leading.xml b/reference/pdf/functions/pdf-set-leading.xml index 59cec9dee0..b251380d5e 100644 --- a/reference/pdf/functions/pdf-set-leading.xml +++ b/reference/pdf/functions/pdf-set-leading.xml @@ -1,16 +1,15 @@ - - - + + - pdf_set_leading + PDF_set_leading Set distance between text lines [deprecated] &reftitle.description; This function is deprecated since PDFlib version 3, use - pdf_set_value with the parameter + PDF_set_value with the parameter leading instead. diff --git a/reference/pdf/functions/pdf-set-parameter.xml b/reference/pdf/functions/pdf-set-parameter.xml index 7cde769df2..4245e8e294 100644 --- a/reference/pdf/functions/pdf-set-parameter.xml +++ b/reference/pdf/functions/pdf-set-parameter.xml @@ -1,15 +1,14 @@ - - + - pdf_set_parameter + PDF_set_parameter Set string parameter &reftitle.description; - boolpdf_set_parameter + boolPDF_set_parameter resourcep stringkey stringvalue @@ -17,9 +16,6 @@ Sets some PDFlib parameter with string type. &return.success; - - See also pdf_set_value. - diff --git a/reference/pdf/functions/pdf-set-text-matrix.xml b/reference/pdf/functions/pdf-set-text-matrix.xml index d5ed6a8b42..e8cd6e1a0b 100644 --- a/reference/pdf/functions/pdf-set-text-matrix.xml +++ b/reference/pdf/functions/pdf-set-text-matrix.xml @@ -1,17 +1,16 @@ - - + - pdf_set_text_matrix + PDF_set_text_matrix Set text matrix [deprecated] &reftitle.description; This function is deprecated since PDFlib version 3, use - pdf_scale, pdf_translate, - pdf_rotate, or pdf_skew instead. + PDF_scale, PDF_translate, + PDF_rotate, or PDF_skew instead. diff --git a/reference/pdf/functions/pdf-set-text-pos.xml b/reference/pdf/functions/pdf-set-text-pos.xml index 075a0c1f94..5262514947 100644 --- a/reference/pdf/functions/pdf-set-text-pos.xml +++ b/reference/pdf/functions/pdf-set-text-pos.xml @@ -1,22 +1,20 @@ - - + - pdf_set_text_pos + PDF_set_text_pos Set text position &reftitle.description; - boolpdf_set_text_pos + boolPDF_set_text_pos resourcep floatx floaty - Sets the position for text output on the page, specified by - x and y. &return.success; + Sets the position for text output on the page. &return.success; diff --git a/reference/pdf/functions/pdf-set-text-rendering.xml b/reference/pdf/functions/pdf-set-text-rendering.xml index ba9fb63be1..63817ef86f 100644 --- a/reference/pdf/functions/pdf-set-text-rendering.xml +++ b/reference/pdf/functions/pdf-set-text-rendering.xml @@ -1,16 +1,15 @@ - - + - pdf_set_text_rendering + PDF_set_text_rendering Determine text rendering [deprecated] &reftitle.description; This function is deprecated since PDFlib version 3, use - pdf_set_value with the + PDF_set_value with the textrendering parameter instead. diff --git a/reference/pdf/functions/pdf-set-text-rise.xml b/reference/pdf/functions/pdf-set-text-rise.xml index 281bfd64ec..be23fd2dc2 100644 --- a/reference/pdf/functions/pdf-set-text-rise.xml +++ b/reference/pdf/functions/pdf-set-text-rise.xml @@ -1,16 +1,15 @@ - - + - pdf_set_text_rise + PDF_set_text_rise Set text rise [deprecated] &reftitle.description; This function is deprecated since PDFlib version 3, use - pdf_set_value with the textrise + PDF_set_value with the textrise parameter instead. diff --git a/reference/pdf/functions/pdf-set-value.xml b/reference/pdf/functions/pdf-set-value.xml index f9a3fc0ad8..ad0de62f96 100644 --- a/reference/pdf/functions/pdf-set-value.xml +++ b/reference/pdf/functions/pdf-set-value.xml @@ -1,15 +1,14 @@ - - + - pdf_set_value + PDF_set_value Set numerical parameter &reftitle.description; - boolpdf_set_value + boolPDF_set_value resourcep stringkey floatvalue @@ -17,9 +16,6 @@ Sets the value of some PDFlib parameter with numerical type. &return.success; - - See also pdf_set_parameter. - diff --git a/reference/pdf/functions/pdf-set-word-spacing.xml b/reference/pdf/functions/pdf-set-word-spacing.xml index a4cb2d7a4a..dc3a43d56b 100644 --- a/reference/pdf/functions/pdf-set-word-spacing.xml +++ b/reference/pdf/functions/pdf-set-word-spacing.xml @@ -1,16 +1,15 @@ - - + - pdf_set_word_spacing + PDF_set_word_spacing Set spacing between words [deprecated] &reftitle.description; This function is deprecated since PDFlib version 3, use - pdf_set_value with the wordspacing + PDF_set_value with the wordspacing parameter instead. diff --git a/reference/pdf/functions/pdf-setcolor.xml b/reference/pdf/functions/pdf-setcolor.xml index cc991900ac..eabd088a76 100644 --- a/reference/pdf/functions/pdf-setcolor.xml +++ b/reference/pdf/functions/pdf-setcolor.xml @@ -1,15 +1,14 @@ - - + - pdf_setcolor + PDF_setcolor Set fill and stroke color &reftitle.description; - boolpdf_setcolor + boolPDF_setcolor resourcep stringfstype stringcolorspace diff --git a/reference/pdf/functions/pdf-setdash.xml b/reference/pdf/functions/pdf-setdash.xml index fdab309f51..fac7644023 100644 --- a/reference/pdf/functions/pdf-setdash.xml +++ b/reference/pdf/functions/pdf-setdash.xml @@ -1,15 +1,14 @@ - - + - pdf_setdash + PDF_setdash Set simple dash pattern &reftitle.description; - boolpdf_setdash + boolPDF_setdash resourcepdfdoc floatb floatw diff --git a/reference/pdf/functions/pdf-setdashpattern.xml b/reference/pdf/functions/pdf-setdashpattern.xml index 846612deca..93e6c77c9a 100644 --- a/reference/pdf/functions/pdf-setdashpattern.xml +++ b/reference/pdf/functions/pdf-setdashpattern.xml @@ -1,15 +1,14 @@ - - + - pdf_setdashpattern + PDF_setdashpattern Set dash pattern &reftitle.description; - boolpdf_setdashpattern + boolPDF_setdashpattern resourcepdfdoc stringoptlist diff --git a/reference/pdf/functions/pdf-setflat.xml b/reference/pdf/functions/pdf-setflat.xml index 014b91b203..136115fbfd 100644 --- a/reference/pdf/functions/pdf-setflat.xml +++ b/reference/pdf/functions/pdf-setflat.xml @@ -1,15 +1,14 @@ - - + - pdf_setflat + PDF_setflat Set flatness &reftitle.description; - boolpdf_setflat + boolPDF_setflat resourcepdfdoc floatflatness diff --git a/reference/pdf/functions/pdf-setfont.xml b/reference/pdf/functions/pdf-setfont.xml index 77fab94a53..dcf6c034ca 100644 --- a/reference/pdf/functions/pdf-setfont.xml +++ b/reference/pdf/functions/pdf-setfont.xml @@ -1,27 +1,23 @@ - - + - pdf_setfont + PDF_setfont Set font &reftitle.description; - boolpdf_setfont + boolPDF_setfont resourcepdfdoc intfont floatfontsize Sets the current font in the specified size, using a - font handle returned by pdf_load_font. + font handle returned by PDF_load_font. &return.success; - - See also pdf_load_font. - diff --git a/reference/pdf/functions/pdf-setgray-fill.xml b/reference/pdf/functions/pdf-setgray-fill.xml index 7aa992eed4..0b3a6c4a90 100644 --- a/reference/pdf/functions/pdf-setgray-fill.xml +++ b/reference/pdf/functions/pdf-setgray-fill.xml @@ -1,15 +1,14 @@ - - + - pdf_setgray_fill + PDF_setgray_fill Set fill color to gray [deprecated] &reftitle.description; - boolpdf_setgray_fill + boolPDF_setgray_fill resourcep floatg @@ -17,12 +16,10 @@ Sets the current fill color to a gray value between 0 and 1 inclusive. &return.success; - - - This function is deprecated since PDFlib version 4, use - pdf_setcolor instead. - - + + This function is deprecated since PDFlib version 4, use + PDF_setcolor instead. + diff --git a/reference/pdf/functions/pdf-setgray-stroke.xml b/reference/pdf/functions/pdf-setgray-stroke.xml index 1bd6700a64..4ed4a78127 100644 --- a/reference/pdf/functions/pdf-setgray-stroke.xml +++ b/reference/pdf/functions/pdf-setgray-stroke.xml @@ -1,15 +1,14 @@ - - + - pdf_setgray_stroke + PDF_setgray_stroke Set stroke color to gray [deprecated] &reftitle.description; - boolpdf_setgray_stroke + boolPDF_setgray_stroke resourcep floatg @@ -19,7 +18,7 @@ This function is deprecated since PDFlib version 4, use - pdf_setcolor instead. + PDF_setcolor instead. diff --git a/reference/pdf/functions/pdf-setgray.xml b/reference/pdf/functions/pdf-setgray.xml index 7f911a379c..2ca65928ad 100644 --- a/reference/pdf/functions/pdf-setgray.xml +++ b/reference/pdf/functions/pdf-setgray.xml @@ -1,27 +1,24 @@ - - + - pdf_setgray + PDF_setgray Set color to gray [deprecated] &reftitle.description; - boolpdf_setgray + boolPDF_setgray resourcep floatg Sets the current fill and stroke color to a gray value between 0 and 1 inclusive. &return.success; - - + This function is deprecated since PDFlib version 4, use - pdf_setcolor instead. + PDF_setcolor instead. - diff --git a/reference/pdf/functions/pdf-setlinecap.xml b/reference/pdf/functions/pdf-setlinecap.xml index e2dcd7804f..aff76544b1 100644 --- a/reference/pdf/functions/pdf-setlinecap.xml +++ b/reference/pdf/functions/pdf-setlinecap.xml @@ -1,15 +1,14 @@ - - + - pdf_setlinecap + PDF_setlinecap Set linecap parameter &reftitle.description; - boolpdf_setlinecap + boolPDF_setlinecap resourcep intlinecap diff --git a/reference/pdf/functions/pdf-setlinejoin.xml b/reference/pdf/functions/pdf-setlinejoin.xml index 5caf7a96a6..24a6f65467 100644 --- a/reference/pdf/functions/pdf-setlinejoin.xml +++ b/reference/pdf/functions/pdf-setlinejoin.xml @@ -1,15 +1,14 @@ - - + - pdf_setlinejoin + PDF_setlinejoin Set linejoin parameter &reftitle.description; - boolpdf_setlinejoin + boolPDF_setlinejoin resourcep intvalue diff --git a/reference/pdf/functions/pdf-setlinewidth.xml b/reference/pdf/functions/pdf-setlinewidth.xml index 5ddd783f03..95f0e41d8e 100644 --- a/reference/pdf/functions/pdf-setlinewidth.xml +++ b/reference/pdf/functions/pdf-setlinewidth.xml @@ -1,20 +1,19 @@ - - + - pdf_setlinewidth + PDF_setlinewidth Set line width &reftitle.description; - boolpdf_setlinewidth + boolPDF_setlinewidth resourcep floatwidth - Sets the current line width to width. &return.success; + Sets the current line width. &return.success; diff --git a/reference/pdf/functions/pdf-setmatrix.xml b/reference/pdf/functions/pdf-setmatrix.xml index 7882842e2b..6bdd3629c1 100644 --- a/reference/pdf/functions/pdf-setmatrix.xml +++ b/reference/pdf/functions/pdf-setmatrix.xml @@ -1,15 +1,14 @@ - - + - pdf_setmatrix + PDF_setmatrix Set current transformation matrix &reftitle.description; - boolpdf_setmatrix + boolPDF_setmatrix resourcep floata floatb diff --git a/reference/pdf/functions/pdf-setmiterlimit.xml b/reference/pdf/functions/pdf-setmiterlimit.xml index 876dcbb228..473b59c1dd 100644 --- a/reference/pdf/functions/pdf-setmiterlimit.xml +++ b/reference/pdf/functions/pdf-setmiterlimit.xml @@ -1,15 +1,14 @@ - - + - pdf_setmiterlimit + PDF_setmiterlimit Set miter limit &reftitle.description; - boolpdf_setmiterlimit + boolPDF_setmiterlimit resourcepdfdoc floatmiter diff --git a/reference/pdf/functions/pdf-setpolydash.xml b/reference/pdf/functions/pdf-setpolydash.xml index fbc17d8e84..aeb99b1b2c 100644 --- a/reference/pdf/functions/pdf-setpolydash.xml +++ b/reference/pdf/functions/pdf-setpolydash.xml @@ -1,16 +1,15 @@ - - + - pdf_setpolydash + PDF_setpolydash Set complicated dash pattern [deprecated] &reftitle.description; This function is deprecated since PDFlib version 5, use - pdf_setdashpattern instead. + PDF_setdashpattern instead. diff --git a/reference/pdf/functions/pdf-setrgbcolor-fill.xml b/reference/pdf/functions/pdf-setrgbcolor-fill.xml index f4bb5ccbd2..178ef6527f 100644 --- a/reference/pdf/functions/pdf-setrgbcolor-fill.xml +++ b/reference/pdf/functions/pdf-setrgbcolor-fill.xml @@ -1,15 +1,14 @@ - - + - pdf_setrgbcolor_fill + PDF_setrgbcolor_fill Set fill rgb color values [deprecated] &reftitle.description; - boolpdf_setrgbcolor_fill + boolPDF_setrgbcolor_fill resourcep floatred floatgreen @@ -20,7 +19,7 @@ This function is deprecated since PDFlib version 4, use - pdf_setcolor instead. + PDF_setcolor instead. diff --git a/reference/pdf/functions/pdf-setrgbcolor-stroke.xml b/reference/pdf/functions/pdf-setrgbcolor-stroke.xml index 8b775c41f9..d80e511640 100644 --- a/reference/pdf/functions/pdf-setrgbcolor-stroke.xml +++ b/reference/pdf/functions/pdf-setrgbcolor-stroke.xml @@ -1,15 +1,14 @@ - - + - pdf_setrgbcolor_stroke + PDF_setrgbcolor_stroke Set stroke rgb color values [deprecated] &reftitle.description; - boolpdf_setrgbcolor_stroke + boolPDF_setrgbcolor_stroke resourcep floatred floatgreen @@ -20,7 +19,7 @@ This function is deprecated since PDFlib version 4, use - pdf_setcolor instead. + PDF_setcolor instead. diff --git a/reference/pdf/functions/pdf-setrgbcolor.xml b/reference/pdf/functions/pdf-setrgbcolor.xml index e79af61bf9..5f04232a02 100644 --- a/reference/pdf/functions/pdf-setrgbcolor.xml +++ b/reference/pdf/functions/pdf-setrgbcolor.xml @@ -1,15 +1,14 @@ - - + - pdf_setrgbcolor + PDF_setrgbcolor Set fill and stroke rgb color values [deprecated] &reftitle.description; - boolpdf_setrgbcolor + boolPDF_setrgbcolor resourcep floatred floatgreen @@ -21,7 +20,7 @@ This function is deprecated since PDFlib version 4, use - pdf_setcolor instead. + PDF_setcolor instead. diff --git a/reference/pdf/functions/pdf-shading-pattern.xml b/reference/pdf/functions/pdf-shading-pattern.xml index a70020bd40..1c34154c60 100644 --- a/reference/pdf/functions/pdf-shading-pattern.xml +++ b/reference/pdf/functions/pdf-shading-pattern.xml @@ -1,23 +1,20 @@ - - + - pdf_shading_pattern + PDF_shading_pattern Define shading pattern &reftitle.description; - intpdf_shading_pattern + intPDF_shading_pattern resourcepdfdoc - intshading - stringoptlist + intshading + stringoptlist - Defines a shading pattern using a shading object. This function returns - a pattern handle that can be used in subsequent calls to - pdf_setcolor. + Defines a shading pattern using a shading object. This function requires PDF 1.4 or above. diff --git a/reference/pdf/functions/pdf-shading.xml b/reference/pdf/functions/pdf-shading.xml index 69853339ce..b09fba7900 100644 --- a/reference/pdf/functions/pdf-shading.xml +++ b/reference/pdf/functions/pdf-shading.xml @@ -1,15 +1,14 @@ - - + - pdf_shading + PDF_shading Define blend &reftitle.description; - intpdf_shading + intPDF_shading resourcepdfdoc stringshtype floatx0 @@ -20,22 +19,9 @@ floatc2 floatc3 floatc4 - stringoptlist Defines a blend from the current fill color to another color. - For axial shadings, (x0, y0) - and (x1, y1) are the - coordinates of the starting and ending points of the shading. For radial - shadings these points specify the centers of the starting and ending - circles. c1, c2, - c3, and c4 are the color - values of the shading endpoint, interpreted in the current fill color - space in the same way as the color parameters in - pdf_setcolor. - - - This function returns a shading handle that can be used in subsequent calls to pdf_shading_pattern and pdf_shfill. This function requires PDF 1.4 or above. diff --git a/reference/pdf/functions/pdf-shfill.xml b/reference/pdf/functions/pdf-shfill.xml index eea280ee32..6465eb3678 100644 --- a/reference/pdf/functions/pdf-shfill.xml +++ b/reference/pdf/functions/pdf-shfill.xml @@ -1,18 +1,17 @@ - - + - pdf_shfill + PDF_shfill Fill area with shading &reftitle.description; - boolpdf_shfill + boolPDF_shfill resourcepdfdoc - intshading - + intshading + Fills an area with a shading, based on a shading object. diff --git a/reference/pdf/functions/pdf-show-boxed.xml b/reference/pdf/functions/pdf-show-boxed.xml index 563e97e738..7272f00621 100644 --- a/reference/pdf/functions/pdf-show-boxed.xml +++ b/reference/pdf/functions/pdf-show-boxed.xml @@ -1,15 +1,14 @@ - - + - pdf_show_boxed + PDF_show_boxed Output text in a box [deprecated] &reftitle.description; - intpdf_show_boxed + intPDF_show_boxed resourcep stringtext floatleft @@ -19,28 +18,12 @@ stringmode stringfeature - This function is deprecated since PDFlib version 6, use - pdf_fit_textline for single lines, or the - PDF_*_textflow functions for multi-line formatting instead. - - - Format text in the current font and size into the - supplied text box according to the requested formatting - mode, which must be one of left, - right, center, justify - or fulljustify. - If width and height are 0, - only a single line is placed at the point (left, - top) in the requested mode. - Parameter feature is optional before PHP 4.3.5 or - with PDFlib less than 5. + + This function is deprecated since PDFlib version 6, use + PDF_fit_textline for single lines, or the + PDF_*_textflow functions for multi-line formatting + instead. - - Returns the number of characters that did not fit in the specified - box. Returns 0 if all characters fit or the - width and height - parameters were set to 0 for single-line formatting. - diff --git a/reference/pdf/functions/pdf-show-xy.xml b/reference/pdf/functions/pdf-show-xy.xml index d34eb194a8..5594b1126b 100644 --- a/reference/pdf/functions/pdf-show-xy.xml +++ b/reference/pdf/functions/pdf-show-xy.xml @@ -1,23 +1,21 @@ - - + - pdf_show_xy + PDF_show_xy Output text at given position &reftitle.description; - boolpdf_show_xy + boolPDF_show_xy resourcep stringtext floatx floaty - Prints text in the current font at ( - x, y). &return.success; + Prints text in the current font. &return.success; diff --git a/reference/pdf/functions/pdf-show.xml b/reference/pdf/functions/pdf-show.xml index 943a8672f1..f8eff13d10 100644 --- a/reference/pdf/functions/pdf-show.xml +++ b/reference/pdf/functions/pdf-show.xml @@ -1,15 +1,14 @@ - - + - pdf_show + PDF_show Output text at current position &reftitle.description; - boolpdf_show + boolPDF_show resourcepdfdoc stringtext diff --git a/reference/pdf/functions/pdf-skew.xml b/reference/pdf/functions/pdf-skew.xml index a3f338466b..0a39906adb 100644 --- a/reference/pdf/functions/pdf-skew.xml +++ b/reference/pdf/functions/pdf-skew.xml @@ -1,15 +1,14 @@ - - + - pdf_skew + PDF_skew Skew the coordinate system &reftitle.description; - boolpdf_skew + boolPDF_skew resourcep floatalpha floatbeta diff --git a/reference/pdf/functions/pdf-stringwidth.xml b/reference/pdf/functions/pdf-stringwidth.xml index b6240e3e88..998bf51db7 100644 --- a/reference/pdf/functions/pdf-stringwidth.xml +++ b/reference/pdf/functions/pdf-stringwidth.xml @@ -1,29 +1,22 @@ - - + - pdf_stringwidth + PDF_stringwidth Return width of text &reftitle.description; - floatpdf_stringwidth + floatPDF_stringwidth resourcep stringtext intfont floatfontsize - Returns the width of text in an arbitrary font, using the parameters - font and fontsize. - font is a font handle returned - by pdf_load_font. + Returns the width of text in an arbitrary font. - - See also pdf_load_font. - diff --git a/reference/pdf/functions/pdf-stroke.xml b/reference/pdf/functions/pdf-stroke.xml index c99a66fd00..25006a695c 100644 --- a/reference/pdf/functions/pdf-stroke.xml +++ b/reference/pdf/functions/pdf-stroke.xml @@ -1,15 +1,14 @@ - - + - pdf_stroke + PDF_stroke Stroke path &reftitle.description; - boolpdf_stroke + boolPDF_stroke resourcep diff --git a/reference/pdf/functions/pdf-suspend-page.xml b/reference/pdf/functions/pdf-suspend-page.xml index f2339a1122..a95a4cd508 100644 --- a/reference/pdf/functions/pdf-suspend-page.xml +++ b/reference/pdf/functions/pdf-suspend-page.xml @@ -1,20 +1,20 @@ - - + - pdf_suspend_page + PDF_suspend_page Suspend page &reftitle.description; - boolpdf_suspend_page + boolPDF_suspend_page resourcepdfdoc - stringoptlist + stringoptlist - Suspend the current page so that it can later be resumed with pdf_resume_page. + Suspends the current page so that it can later be resumed with + PDF_resume_page. diff --git a/reference/pdf/functions/pdf-translate.xml b/reference/pdf/functions/pdf-translate.xml index 6d7b3ec22d..7c33ec76a4 100644 --- a/reference/pdf/functions/pdf-translate.xml +++ b/reference/pdf/functions/pdf-translate.xml @@ -1,15 +1,14 @@ - - + - pdf_translate + PDF_translate Set origin of coordinate system &reftitle.description; - boolpdf_translate + boolPDF_translate resourcep floattx floatty diff --git a/reference/pdf/functions/pdf-utf16-to-utf8.xml b/reference/pdf/functions/pdf-utf16-to-utf8.xml index 3fec27db1d..d6f2d10f7c 100644 --- a/reference/pdf/functions/pdf-utf16-to-utf8.xml +++ b/reference/pdf/functions/pdf-utf16-to-utf8.xml @@ -1,21 +1,19 @@ - - + - pdf_utf16_to_utf8 + PDF_utf16_to_utf8 Convert string from UTF-16 to UTF-8 &reftitle.description; - stringpdf_utf16_to_utf8 + stringPDF_utf16_to_utf8 resourcepdfdoc - stringutf16string - + stringutf16string + - Converts a string from UTF-16 format to UTF-8. This function returns the - converted UTF-8 string which will start with a BOM (\xEF\xBB\xBF). + Converts a string from UTF-16 format to UTF-8. diff --git a/reference/pdf/functions/pdf-utf8-to-utf16.xml b/reference/pdf/functions/pdf-utf8-to-utf16.xml index 7b10a7b9d7..62b54187eb 100644 --- a/reference/pdf/functions/pdf-utf8-to-utf16.xml +++ b/reference/pdf/functions/pdf-utf8-to-utf16.xml @@ -1,22 +1,20 @@ - - + - pdf_utf8_to_utf16 + PDF_utf8_to_utf16 Convert string from UTF-8 to UTF-16 &reftitle.description; - stringpdf_utf8_to_utf16 + stringPDF_utf8_to_utf16 resourcepdfdoc - stringutf8string + stringutf8string stringordering - + - Converts a string from UTF-8 format to UTF-16. This function returns the - converted UTF-16 string. + Converts a string from UTF-8 format to UTF-16. diff --git a/reference/pdf/functions/pdf-xshow.xml b/reference/pdf/functions/pdf-xshow.xml deleted file mode 100644 index 7c03eb1e17..0000000000 --- a/reference/pdf/functions/pdf-xshow.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - pdf_xshow - Output text at current position - - - &reftitle.description; - - boolpdf_xshow - resourcepdfdoc - stringtext - - - Prints text in the current font and size at - the current position. &return.success; - - - - - diff --git a/reference/pdf/reference.xml b/reference/pdf/reference.xml index da40cbc175..12cfe6d49b 100644 --- a/reference/pdf/reference.xml +++ b/reference/pdf/reference.xml @@ -1,5 +1,5 @@ - + @@ -12,42 +12,48 @@ &reftitle.intro; The PDF functions in PHP can create PDF files using the PDFlib - library created by Thomas Merz. + library which was initially created by Thomas Merz and is now + maintained by PDFlib GmbH. The documentation in this section is only meant to be an overview of the available functions in the PDFlib library and should not be considered an exhaustive reference. For the full and detailed - explanation of each function, consult the PDFlib Reference Manual - which is included in all PDFlib packages distributed by PDFlib GmbH. + explanation of each function, consult the PDFlib Reference Manual + which is included in all PDFlib packages distributed by PDFlib GmbH. It provides a very good overview of what PDFlib is capable of doing and contains the most up-to-date documentation of all functions. - All of the functions in PDFlib and the PHP module have identical - function names and parameters. You will need to understand some - of the basic concepts of PDF and PostScript to efficiently use - this extension. All lengths and coordinates are measured in - PostScript points. There are generally 72 PostScript points to an - inch, but this depends on the output resolution. Please see the - PDFlib Reference Manual included in the PDFlib distribution for a more - thorough explanation of the coordinate system used. + For a jump start we urge you to take a look at the programming samples + which are contained in all PDFlib distribution packages. These samples + demonstrate basic text, vector, and graphics output as well as + higher-level functions, such as the PDF import facility (PDI). - With version 6, PDFlib offers an object oriented API for PHP 5 in - addition to the function oriented API for PHP 4. The main difference is + All of the functions in PDFlib and the PHP module have identical + function names and parameters. Unless configured otherwise, all + lengths and coordinates are measured in PostScript points. There are + generally 72 PostScript points to an inch, but this depends on the + output resolution. Please see the PDFlib Reference Manual + included in the PDFlib distribution for a more thorough explanation + of the coordinate system used. + + + With version 6, PDFlib offers an object-oriented API for PHP 5 in + addition to the function-oriented API for PHP 4. The main difference is the following: - + - In PHP 4, first a PDF resource has to be retrieved - with a function call like + In PHP 4, first a PDF resource has to be retrieved with a function call + like $p = PDF_new(). - This PDF resource is used as the first parameter in all further function calls, such - as in + This PDF resource is used as the first parameter in all further function + calls, such as in PDF_begin_document($p, "", ""). @@ -56,21 +62,21 @@ In PHP 5 however, a PDFlib object is created with - $p = new PDFlib(). + $p = new PDFlib(). This object offers all PDFlib API functions as methods, e.g. as with - + $p->begin_document("", ""). In addition, exceptions have been introduced in PHP 5 which are supported by PDFlib 6 and later as well. - + Please see the examples below for - more information. + more information. @@ -79,20 +85,17 @@ this related FAQ. - - - This extension has been moved to PECL as - of PHP 4.3.9. - -
&reftitle.required; - PDFlib is available for download at &url.pdf;, but requires that you purchase - a license for commercial use. + PDFlib Lite is available as open source. However, the + PDFlib Lite license allows free use only under certain conditions. + PDFlib Lite supports a subset of PDFlib's functionality; please see the + PDFlib web site for details. The full version of PDFlib is available for + download at &url.pdf;, but requires that + you purchase a license for commercial use.
@@ -119,15 +122,15 @@ Starting with PHP 4.0.5, the PHP extension for PDFlib is officially supported by PDFlib GmbH. This means that all the - functions described in the PDFlib Reference Manual (PDFlib V3.0 or higher) are + functions described in the PDFlib Reference Manual are supported by PHP 4 with exactly the same meaning and the same - parameters. However, with PDFlib V5.0.4 or higher all parameters - have to be specified. For compatibility reasons, - this binding for PDFlib still supports most of the deprecated functions, but they + parameters. However, with PDFlib Version 5.0.4 or higher all parameters + have to be specified. For compatibility reasons, this binding for PDFlib + still supports most of the deprecated functions, but they should be replaced by their new versions. PDFlib GmbH will not support any problems arising from the use of these deprecated functions. The documentation in this section indicates old functions as - "Deprecated" and gives the replacement function to be used instead. + "Deprecated" and gives the replacement function to be used instead. @@ -138,8 +141,8 @@ is probably creating your first PDF document. The following example should help to get you started. It is developed for PHP 4 and creates the file hello.pdf with one page. - It defines some document info field contents, loads the Helvetica-Bold - font and outputs the text "Hello world! (says PHP)". + It defines some document info field contents, loads the Helvetica-Bold + font and outputs the text "Hello world! (says PHP)". @@ -184,13 +187,13 @@ PDF_delete($p); - + The following example comes with the PDFlib distribution for PHP 5. - It uses the new exception handling and object encapsulation features - available in PHP 5. It creates the file hello.pdf with one page. - It defines some document info field contents, loads the Helvetica-Bold - font and outputs the text "Hello world! (says PHP)". + It uses the new exception handling and object encapsulation features + available in PHP 5. It creates the file hello.pdf + with one page. It defines some document info field contents, loads the + Helvetica-Bold font and outputs the text "Hello world! (says PHP)". @@ -233,8 +236,8 @@ try { } catch (PDFlibException $e) { die("PDFlib exception occurred in hello sample:\n" . - "[" . $e->get_errnum() . "] " . $e->get_apiname() . ": " . - $e->get_errmsg() . "\n"); + "[" . $e->get_errnum() . "] " . $e->get_apiname() . ": " . + $e->get_errmsg() . "\n"); } catch (Exception $e) { die($e); @@ -271,3 +274,4 @@ vim600: syn=xml fen fdm=syntax fdl=2 si vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> +