From 3e355eb0ad02e34f3f388c29912b4247c307ff87 Mon Sep 17 00:00:00 2001 From: Mehdi Achour Date: Fri, 2 Feb 2007 02:11:07 +0000 Subject: [PATCH] WS, prepare for new doc style git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@228715 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/pdf/functions/pdf-activate-item.xml | 38 ++-- .../pdf/functions/pdf-add-annotation.xml | 28 +-- reference/pdf/functions/pdf-add-bookmark.xml | 28 +-- .../pdf/functions/pdf-add-launchlink.xml | 58 +++--- reference/pdf/functions/pdf-add-locallink.xml | 60 +++---- reference/pdf/functions/pdf-add-nameddest.xml | 40 ++--- reference/pdf/functions/pdf-add-note.xml | 60 +++---- reference/pdf/functions/pdf-add-outline.xml | 26 +-- reference/pdf/functions/pdf-add-pdflink.xml | 64 +++---- reference/pdf/functions/pdf-add-thumbnail.xml | 38 ++-- reference/pdf/functions/pdf-add-weblink.xml | 58 +++--- reference/pdf/functions/pdf-arc.xml | 44 ++--- reference/pdf/functions/pdf-arcn.xml | 46 ++--- reference/pdf/functions/pdf-attach-file.xml | 62 +++---- .../pdf/functions/pdf-begin-document.xml | 38 ++-- reference/pdf/functions/pdf-begin-font.xml | 50 +++--- reference/pdf/functions/pdf-begin-glyph.xml | 46 ++--- reference/pdf/functions/pdf-begin-item.xml | 40 ++--- reference/pdf/functions/pdf-begin-layer.xml | 42 ++--- .../pdf/functions/pdf-begin-page-ext.xml | 170 +++++++++--------- reference/pdf/functions/pdf-begin-page.xml | 46 ++--- reference/pdf/functions/pdf-begin-pattern.xml | 44 ++--- .../pdf/functions/pdf-begin-template.xml | 38 ++-- reference/pdf/functions/pdf-circle.xml | 40 ++--- reference/pdf/functions/pdf-clip.xml | 34 ++-- reference/pdf/functions/pdf-close-image.xml | 38 ++-- .../pdf/functions/pdf-close-pdi-page.xml | 38 ++-- reference/pdf/functions/pdf-close-pdi.xml | 38 ++-- reference/pdf/functions/pdf-close.xml | 44 ++--- .../functions/pdf-closepath-fill-stroke.xml | 34 ++-- .../pdf/functions/pdf-closepath-stroke.xml | 34 ++-- reference/pdf/functions/pdf-closepath.xml | 34 ++-- reference/pdf/functions/pdf-concat.xml | 46 ++--- reference/pdf/functions/pdf-continue-text.xml | 36 ++-- reference/pdf/functions/pdf-create-action.xml | 38 ++-- .../pdf/functions/pdf-create-annotation.xml | 46 ++--- .../pdf/functions/pdf-create-bookmark.xml | 38 ++-- reference/pdf/functions/pdf-create-field.xml | 48 ++--- .../pdf/functions/pdf-create-fieldgroup.xml | 38 ++-- reference/pdf/functions/pdf-create-gstate.xml | 36 ++-- reference/pdf/functions/pdf-create-pvf.xml | 40 ++--- .../pdf/functions/pdf-create-textflow.xml | 38 ++-- reference/pdf/functions/pdf-curveto.xml | 48 ++--- reference/pdf/functions/pdf-define-layer.xml | 44 ++--- reference/pdf/functions/pdf-delete-pvf.xml | 38 ++-- .../pdf/functions/pdf-delete-textflow.xml | 36 ++-- reference/pdf/functions/pdf-delete.xml | 34 ++-- .../pdf/functions/pdf-encoding-set-char.xml | 42 ++--- reference/pdf/functions/pdf-end-document.xml | 36 ++-- reference/pdf/functions/pdf-end-font.xml | 34 ++-- reference/pdf/functions/pdf-end-glyph.xml | 34 ++-- reference/pdf/functions/pdf-end-item.xml | 36 ++-- reference/pdf/functions/pdf-end-layer.xml | 40 ++--- reference/pdf/functions/pdf-end-page-ext.xml | 36 ++-- reference/pdf/functions/pdf-end-page.xml | 34 ++-- reference/pdf/functions/pdf-end-pattern.xml | 34 ++-- reference/pdf/functions/pdf-end-template.xml | 34 ++-- reference/pdf/functions/pdf-endpath.xml | 26 +-- .../pdf/functions/pdf-fill-imageblock.xml | 50 +++--- reference/pdf/functions/pdf-fill-pdfblock.xml | 48 ++--- reference/pdf/functions/pdf-fill-stroke.xml | 36 ++-- .../pdf/functions/pdf-fill-textblock.xml | 50 +++--- reference/pdf/functions/pdf-fill.xml | 36 ++-- reference/pdf/functions/pdf-findfont.xml | 64 +++---- reference/pdf/functions/pdf-fit-image.xml | 44 ++--- reference/pdf/functions/pdf-fit-pdi-page.xml | 44 ++--- reference/pdf/functions/pdf-fit-textflow.xml | 46 ++--- reference/pdf/functions/pdf-fit-textline.xml | 42 ++--- reference/pdf/functions/pdf-get-apiname.xml | 34 ++-- reference/pdf/functions/pdf-get-buffer.xml | 34 ++-- reference/pdf/functions/pdf-get-errmsg.xml | 36 ++-- reference/pdf/functions/pdf-get-errnum.xml | 36 ++-- reference/pdf/functions/pdf-get-font.xml | 30 ++-- reference/pdf/functions/pdf-get-fontname.xml | 30 ++-- reference/pdf/functions/pdf-get-fontsize.xml | 30 ++-- .../pdf/functions/pdf-get-image-height.xml | 30 ++-- .../pdf/functions/pdf-get-image-width.xml | 30 ++-- .../pdf/functions/pdf-get-majorversion.xml | 38 ++-- .../pdf/functions/pdf-get-minorversion.xml | 44 ++--- reference/pdf/functions/pdf-get-parameter.xml | 38 ++-- .../pdf/functions/pdf-get-pdi-parameter.xml | 42 ++--- reference/pdf/functions/pdf-get-pdi-value.xml | 42 ++--- reference/pdf/functions/pdf-get-value.xml | 38 ++-- reference/pdf/functions/pdf-info-textflow.xml | 38 ++-- reference/pdf/functions/pdf-initgraphics.xml | 36 ++-- reference/pdf/functions/pdf-lineto.xml | 38 ++-- reference/pdf/functions/pdf-load-font.xml | 40 ++--- .../pdf/functions/pdf-load-iccprofile.xml | 38 ++-- reference/pdf/functions/pdf-load-image.xml | 40 ++--- reference/pdf/functions/pdf-makespotcolor.xml | 38 ++-- reference/pdf/functions/pdf-moveto.xml | 38 ++-- reference/pdf/functions/pdf-new.xml | 34 ++-- reference/pdf/functions/pdf-open-ccitt.xml | 52 +++--- reference/pdf/functions/pdf-open-file.xml | 46 ++--- reference/pdf/functions/pdf-open-gif.xml | 28 +-- .../pdf/functions/pdf-open-image-file.xml | 52 +++--- reference/pdf/functions/pdf-open-image.xml | 60 +++---- reference/pdf/functions/pdf-open-jpeg.xml | 28 +-- .../pdf/functions/pdf-open-memory-image.xml | 34 ++-- reference/pdf/functions/pdf-open-pdi-page.xml | 42 +++-- reference/pdf/functions/pdf-open-pdi.xml | 38 ++-- reference/pdf/functions/pdf-open-tiff.xml | 28 +-- reference/pdf/functions/pdf-place-image.xml | 50 +++--- .../pdf/functions/pdf-place-pdi-page.xml | 52 +++--- reference/pdf/functions/pdf-process-pdi.xml | 40 ++--- reference/pdf/functions/pdf-rect.xml | 42 ++--- reference/pdf/functions/pdf-restore.xml | 34 ++-- reference/pdf/functions/pdf-resume-page.xml | 36 ++-- reference/pdf/functions/pdf-rotate.xml | 36 ++-- reference/pdf/functions/pdf-save.xml | 34 ++-- reference/pdf/functions/pdf-scale.xml | 38 ++-- .../pdf/functions/pdf-set-border-color.xml | 50 +++--- .../pdf/functions/pdf-set-border-dash.xml | 48 ++--- .../pdf/functions/pdf-set-border-style.xml | 50 +++--- .../pdf/functions/pdf-set-char-spacing.xml | 30 ++-- reference/pdf/functions/pdf-set-duration.xml | 32 ++-- reference/pdf/functions/pdf-set-gstate.xml | 36 ++-- .../pdf/functions/pdf-set-horiz-scaling.xml | 30 ++-- .../pdf/functions/pdf-set-info-author.xml | 28 +-- .../pdf/functions/pdf-set-info-creator.xml | 30 ++-- .../pdf/functions/pdf-set-info-keywords.xml | 30 ++-- .../pdf/functions/pdf-set-info-subject.xml | 30 ++-- .../pdf/functions/pdf-set-info-title.xml | 30 ++-- reference/pdf/functions/pdf-set-info.xml | 40 ++--- .../functions/pdf-set-layer-dependency.xml | 44 ++--- reference/pdf/functions/pdf-set-leading.xml | 30 ++-- reference/pdf/functions/pdf-set-parameter.xml | 38 ++-- .../pdf/functions/pdf-set-text-matrix.xml | 30 ++-- reference/pdf/functions/pdf-set-text-pos.xml | 38 ++-- .../pdf/functions/pdf-set-text-rendering.xml | 30 ++-- reference/pdf/functions/pdf-set-text-rise.xml | 30 ++-- reference/pdf/functions/pdf-set-value.xml | 38 ++-- .../pdf/functions/pdf-set-word-spacing.xml | 30 ++-- reference/pdf/functions/pdf-setcolor.xml | 46 ++--- reference/pdf/functions/pdf-setdash.xml | 40 ++--- .../pdf/functions/pdf-setdashpattern.xml | 36 ++-- reference/pdf/functions/pdf-setflat.xml | 36 ++-- reference/pdf/functions/pdf-setfont.xml | 42 ++--- reference/pdf/functions/pdf-setgray-fill.xml | 46 ++--- .../pdf/functions/pdf-setgray-stroke.xml | 46 ++--- reference/pdf/functions/pdf-setgray.xml | 44 ++--- reference/pdf/functions/pdf-setlinecap.xml | 38 ++-- reference/pdf/functions/pdf-setlinejoin.xml | 38 ++-- reference/pdf/functions/pdf-setlinewidth.xml | 36 ++-- reference/pdf/functions/pdf-setmatrix.xml | 46 ++--- reference/pdf/functions/pdf-setmiterlimit.xml | 36 ++-- reference/pdf/functions/pdf-setpolydash.xml | 28 +-- .../pdf/functions/pdf-setrgbcolor-fill.xml | 48 ++--- .../pdf/functions/pdf-setrgbcolor-stroke.xml | 48 ++--- reference/pdf/functions/pdf-setrgbcolor.xml | 50 +++--- .../pdf/functions/pdf-shading-pattern.xml | 44 ++--- reference/pdf/functions/pdf-shading.xml | 60 +++---- reference/pdf/functions/pdf-shfill.xml | 42 ++--- reference/pdf/functions/pdf-show-boxed.xml | 54 +++--- reference/pdf/functions/pdf-show-xy.xml | 40 ++--- reference/pdf/functions/pdf-show.xml | 38 ++-- reference/pdf/functions/pdf-skew.xml | 40 ++--- reference/pdf/functions/pdf-stringwidth.xml | 40 ++--- reference/pdf/functions/pdf-stroke.xml | 36 ++-- reference/pdf/functions/pdf-suspend-page.xml | 38 ++-- reference/pdf/functions/pdf-translate.xml | 38 ++-- reference/pdf/functions/pdf-utf16-to-utf8.xml | 36 ++-- reference/pdf/functions/pdf-utf8-to-utf16.xml | 38 ++-- 163 files changed, 3299 insertions(+), 3311 deletions(-) diff --git a/reference/pdf/functions/pdf-activate-item.xml b/reference/pdf/functions/pdf-activate-item.xml index 0c30b8a74f..9441227ee8 100644 --- a/reference/pdf/functions/pdf-activate-item.xml +++ b/reference/pdf/functions/pdf-activate-item.xml @@ -1,23 +1,23 @@ - - - - PDF_activate_item - Activate structure element or other content item - - - &reftitle.description; - - boolPDF_activate_item - resourcepdfdoc - intid - - - Activates a previously created structure element or other content item. - &return.success; - - - + + + + PDF_activate_item + Activate structure element or other content item + + + &reftitle.description; + + boolPDF_activate_item + resourcepdfdoc + intid + + + Activates a previously created structure element or other content item. + &return.success; + + + - - - PDF_add_annotation - Add annotation [deprecated] - - - &reftitle.description; - - This function is deprecated, use PDF_create_annotation - with type=Text instead. - - - + + + + PDF_add_annotation + Add annotation [deprecated] + + + &reftitle.description; + + This function is deprecated, use PDF_create_annotation + with type=Text instead. + + + - - - PDF_add_bookmark - Add bookmark for current page [deprecated] - - - &reftitle.description; - - This function is deprecated since PDFlib version 6, use - PDF_create_bookmark instead. - - - + + + + PDF_add_bookmark + Add bookmark for current page [deprecated] + + + &reftitle.description; + + This function is deprecated since PDFlib version 6, use + PDF_create_bookmark instead. + + + - - - PDF_add_launchlink - Add launch annotation for current page [deprecated] - - - &reftitle.description; - - boolPDF_add_launchlink - resourcepdfdoc - floatllx - floatlly - floaturx - floatury - stringfilename - - - Adds a link to a web resource. - - - This function is deprecated since PDFlib version 6, - use PDF_create_action with - type=Launch and - PDF_create_annotation with - type=Link instead. - - - + + + + PDF_add_launchlink + Add launch annotation for current page [deprecated] + + + &reftitle.description; + + boolPDF_add_launchlink + resourcepdfdoc + floatllx + floatlly + floaturx + floatury + stringfilename + + + Adds a link to a web resource. + + + This function is deprecated since PDFlib version 6, + use PDF_create_action with + type=Launch and + PDF_create_annotation with + type=Link instead. + + + - - - PDF_add_locallink - Add link annotation for current page [deprecated] - - - &reftitle.description; - - boolPDF_add_locallink - resourcepdfdoc - floatlowerleftx - floatlowerlefty - floatupperrightx - floatupperrighty - intpage - stringdest - - - Add a link annotation to a target within the current PDF file. - &return.success; - - - This function is deprecated since PDFlib version 6, use - PDF_create_action with type=GoTo - and PDF_create_annotation with - type=Link instead. - - - + + + + PDF_add_locallink + Add link annotation for current page [deprecated] + + + &reftitle.description; + + boolPDF_add_locallink + resourcepdfdoc + floatlowerleftx + floatlowerlefty + floatupperrightx + floatupperrighty + intpage + stringdest + + + Add a link annotation to a target within the current PDF file. + &return.success; + + + This function is deprecated since PDFlib version 6, use + PDF_create_action with type=GoTo + and PDF_create_annotation with + type=Link instead. + + + - - - PDF_add_nameddest - Create named destination - - - &reftitle.description; - - boolPDF_add_nameddest - resourcepdfdoc - stringname - stringoptlist - - - Creates a named destination on an arbitrary page in the current document. - &return.success; - - - + + + + PDF_add_nameddest + Create named destination + + + &reftitle.description; + + boolPDF_add_nameddest + resourcepdfdoc + stringname + stringoptlist + + + Creates a named destination on an arbitrary page in the current document. + &return.success; + + + - - - PDF_add_note - Set annotation for current page [deprecated] - - - &reftitle.description; - - boolPDF_add_note - resourcepdfdoc - floatllx - floatlly - floaturx - floatury - stringcontents - stringtitle - stringicon - intopen - - - 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. - - - + + + + PDF_add_note + Set annotation for current page [deprecated] + + + &reftitle.description; + + boolPDF_add_note + resourcepdfdoc + floatllx + floatlly + floaturx + floatury + stringcontents + stringtitle + stringicon + intopen + + + 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. + + + - - - PDF_add_outline - Add bookmark for current page [deprecated] - - - &reftitle.description; - - This function is deprecated, use PDF_create_bookmark + + + + PDF_add_outline + Add bookmark for current page [deprecated] + + + &reftitle.description; + + This function is deprecated, use PDF_create_bookmark instead. - - - + + + - - - PDF_add_pdflink - Add file link annotation for current page [deprecated] - - - &reftitle.description; - - boolPDF_add_pdflink - resourcepdfdoc - floatbottom_left_x - floatbottom_left_y - floatup_right_x - floatup_right_y - stringfilename - intpage - stringdest - - - 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. - - - + + + + PDF_add_pdflink + Add file link annotation for current page [deprecated] + + + &reftitle.description; + + boolPDF_add_pdflink + resourcepdfdoc + floatbottom_left_x + floatbottom_left_y + floatup_right_x + floatup_right_y + stringfilename + intpage + stringdest + + + 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. + + + - - - PDF_add_thumbnail - Add thumbnail for current page - - - &reftitle.description; - - boolPDF_add_thumbnail - resourcepdfdoc - intimage - - - Adds an existing image as thumbnail for the current page. - &return.success; - - - + + + + PDF_add_thumbnail + Add thumbnail for current page + + + &reftitle.description; + + boolPDF_add_thumbnail + resourcepdfdoc + intimage + + + Adds an existing image as thumbnail for the current page. + &return.success; + + + - - - PDF_add_weblink - Add weblink for current page [deprecated] - - - &reftitle.description; - - boolPDF_add_weblink - resourcepdfdoc - floatlowerleftx - floatlowerlefty - floatupperrightx - floatupperrighty - stringurl - - - 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. - - - + + + + PDF_add_weblink + Add weblink for current page [deprecated] + + + &reftitle.description; + + boolPDF_add_weblink + resourcepdfdoc + floatlowerleftx + floatlowerlefty + floatupperrightx + floatupperrighty + stringurl + + + 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. + + + - - - PDF_arc - Draw a counterclockwise circular arc segment - - - &reftitle.description; - - boolPDF_arc - resourcep - floatx - floaty - floatr - floatalpha - floatbeta - - - Adds a counterclockwise circular arc. - - - + + + + PDF_arc + Draw a counterclockwise circular arc segment + + + &reftitle.description; + + boolPDF_arc + resourcep + floatx + floaty + floatr + floatalpha + floatbeta + + + Adds a counterclockwise circular arc. + + + - - - PDF_arcn - Draw a clockwise circular arc segment - - - &reftitle.description; - - boolPDF_arcn - resourcep - floatx - floaty - floatr - floatalpha - floatbeta - - - Except for the drawing direction, this function behaves exactly like - PDF_arc. - - - + + + + PDF_arcn + Draw a clockwise circular arc segment + + + &reftitle.description; + + boolPDF_arcn + resourcep + floatx + floaty + floatr + floatalpha + floatbeta + + + Except for the drawing direction, this function behaves exactly like + PDF_arc. + + + - - - PDF_attach_file - Add file attachment for current page [deprecated] - - - &reftitle.description; - - boolPDF_attach_file - resourcepdfdoc - floatllx - floatlly - floaturx - floatury - stringfilename - stringdescription - stringauthor - stringmimetype - stringicon - - - Adds a file attachment annotation. &return.success; - - - This function is deprecated since PDFlib version 6, use - PDF_create_annotation with - type=FileAttachment instead. - - - + + + + PDF_attach_file + Add file attachment for current page [deprecated] + + + &reftitle.description; + + boolPDF_attach_file + resourcepdfdoc + floatllx + floatlly + floaturx + floatury + stringfilename + stringdescription + stringauthor + stringmimetype + stringicon + + + Adds a file attachment annotation. &return.success; + + + This function is deprecated since PDFlib version 6, use + PDF_create_annotation with + type=FileAttachment instead. + + + - - - PDF_begin_document - Create new PDF file - - - &reftitle.description; - - intPDF_begin_document - resourcepdfdoc - stringfilename - stringoptlist - - - Creates a new PDF file subject to various options. - - - + + + + PDF_begin_document + Create new PDF file + + + &reftitle.description; + + intPDF_begin_document + resourcepdfdoc + stringfilename + stringoptlist + + + Creates a new PDF file subject to various options. + + + - - - PDF_begin_font - Start a Type 3 font definition - - - &reftitle.description; - - boolPDF_begin_font - resourcepdfdoc - stringfilename - floata - floatb - floatc - floatd - floate - floatf - stringoptlist - - - Starts a Type 3 font definition. - - - + + + + PDF_begin_font + Start a Type 3 font definition + + + &reftitle.description; + + boolPDF_begin_font + resourcepdfdoc + stringfilename + floata + floatb + floatc + floatd + floate + floatf + stringoptlist + + + Starts a Type 3 font definition. + + + - - - PDF_begin_glyph - Start glyph definition for Type 3 font - - - &reftitle.description; - - boolPDF_begin_glyph - resourcepdfdoc - stringglyphname - floatwx - floatllx - floatlly - floaturx - floatury - - - Starts a glyph definition for a Type 3 font. - - - + + + + PDF_begin_glyph + Start glyph definition for Type 3 font + + + &reftitle.description; + + boolPDF_begin_glyph + resourcepdfdoc + stringglyphname + floatwx + floatllx + floatlly + floaturx + floatury + + + Starts a glyph definition for a Type 3 font. + + + - - - PDF_begin_item - Open structure element or other content item - - - &reftitle.description; - - intPDF_begin_item - resourcepdfdoc - stringtag - stringoptlist - - - Opens a structure element or other content item with attributes supplied - as options. - - - + + + + PDF_begin_item + Open structure element or other content item + + + &reftitle.description; + + intPDF_begin_item + resourcepdfdoc + stringtag + stringoptlist + + + Opens a structure element or other content item with attributes supplied + as options. + + + - - - PDF_begin_layer - Start layer - - - &reftitle.description; - - boolPDF_begin_layer - resourcepdfdoc - intlayer - - - Starts a layer for subsequent output on the page. &return.success; - - - This function requires PDF 1.5. - - - + + + + PDF_begin_layer + Start layer + + + &reftitle.description; + + boolPDF_begin_layer + resourcepdfdoc + intlayer + + + Starts a layer for subsequent output on the page. &return.success; + + + This function requires PDF 1.5. + + + - - - PDF_begin_page_ext - Start new page - - - &reftitle.description; - - boolPDF_begin_page_ext - resourcepdfdoc - floatwidth - floatheight - stringoptlist - - - Adds a new page to the document, and specifies various options. - The parameters width and height - are the dimensions of the new page in points. &return.success; - - - - 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 - - - -
-
-
-
+ + + + PDF_begin_page_ext + Start new page + + + &reftitle.description; + + boolPDF_begin_page_ext + resourcepdfdoc + floatwidth + floatheight + stringoptlist + + + Adds a new page to the document, and specifies various options. + The parameters width and height + are the dimensions of the new page in points. &return.success; + + + + 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 + + + +
+
+
+
- - - PDF_begin_page - Start new page [deprecated] - - - &reftitle.description; - - boolPDF_begin_page - resourcepdfdoc - floatwidth - floatheight - - - Adds a new page to the document. &return.success; - - - This function is deprecated since PDFlib version 6, use - PDF_begin_page_ext instead. - - - + + + + PDF_begin_page + Start new page [deprecated] + + + &reftitle.description; + + boolPDF_begin_page + resourcepdfdoc + floatwidth + floatheight + + + Adds a new page to the document. &return.success; + + + This function is deprecated since PDFlib version 6, use + PDF_begin_page_ext instead. + + + - - - PDF_begin_pattern - Start pattern definition - - - &reftitle.description; - - intPDF_begin_pattern - resourcepdfdoc - floatwidth - floatheight - floatxstep - floatystep - intpainttype - - - Starts a new pattern definition. - - - + + + + PDF_begin_pattern + Start pattern definition + + + &reftitle.description; + + intPDF_begin_pattern + resourcepdfdoc + floatwidth + floatheight + floatxstep + floatystep + intpainttype + + + Starts a new pattern definition. + + + - - - PDF_begin_template - Start template definition - - - &reftitle.description; - - intPDF_begin_template - resourcepdfdoc - floatwidth - floatheight - - - Starts a new template definition. - - - + + + + PDF_begin_template + Start template definition + + + &reftitle.description; + + intPDF_begin_template + resourcepdfdoc + floatwidth + floatheight + + + Starts a new template definition. + + + - - - PDF_circle - Draw a circle - - - &reftitle.description; - - boolPDF_circle - resourcepdfdoc - floatx - floaty - floatr - - - Adds a circle. &return.success; - - - + + + + PDF_circle + Draw a circle + + + &reftitle.description; + + boolPDF_circle + resourcepdfdoc + floatx + floaty + floatr + + + Adds a circle. &return.success; + + + - - - PDF_clip - Clip to current path - - - &reftitle.description; - - boolPDF_clip - resourcep - - - Uses the current path as clipping path, and terminate the path. &return.success; - - - + + + + PDF_clip + Clip to current path + + + &reftitle.description; + + boolPDF_clip + resourcep + + + Uses the current path as clipping path, and terminate the path. &return.success; + + + - - - PDF_close_image - Close image - - - &reftitle.description; - - voidPDF_close_image - resourcep - intimage - - - Closes an image retrieved with the - PDF_open_image function. - - - + + + + PDF_close_image + Close image + + + &reftitle.description; + + voidPDF_close_image + resourcep + intimage + + + Closes an image retrieved with the + PDF_open_image function. + + + - - - 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; - - - + + + + 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; + + + - - - 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; - - - + + + + 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; + + + - - - PDF_close - Close pdf resource [deprecated] - - - &reftitle.description; - - boolPDF_close - resourcep - - - 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. - - - + + + + PDF_close + Close pdf resource [deprecated] + + + &reftitle.description; + + boolPDF_close + resourcep + + + 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. + + + - - - PDF_closepath_fill_stroke - Close, fill and stroke current path - - - &reftitle.description; - - boolPDF_closepath_fill_stroke - resourcep - - - Closes the path, fills, and strokes it. &return.success; - - - + + + + PDF_closepath_fill_stroke + Close, fill and stroke current path + + + &reftitle.description; + + boolPDF_closepath_fill_stroke + resourcep + + + Closes the path, fills, and strokes it. &return.success; + + + - - - PDF_closepath_stroke - Close and stroke path - - - &reftitle.description; - - boolPDF_closepath_stroke - resourcep - - - Closes the path, and strokes it. &return.success; - - - + + + + PDF_closepath_stroke + Close and stroke path + + + &reftitle.description; + + boolPDF_closepath_stroke + resourcep + + + Closes the path, and strokes it. &return.success; + + + - - - PDF_closepath - Close current path - - - &reftitle.description; - - boolPDF_closepath - resourcep - - - Closes the current path. &return.success; - - - + + + + PDF_closepath + Close current path + + + &reftitle.description; + + boolPDF_closepath + resourcep + + + Closes the current path. &return.success; + + + - - - PDF_concat - Concatenate a matrix to the CTM - - - &reftitle.description; - - boolPDF_concat - resourcep - floata - floatb - floatc - floatd - floate - floatf - - - Concatenates a matrix to the current transformation matrix (CTM). &return.success; - - - + + + + PDF_concat + Concatenate a matrix to the CTM + + + &reftitle.description; + + boolPDF_concat + resourcep + floata + floatb + floatc + floatd + floate + floatf + + + Concatenates a matrix to the current transformation matrix (CTM). &return.success; + + + - - - PDF_continue_text - Output text in next line - - - &reftitle.description; - - boolPDF_continue_text - resourcep - stringtext - - - Prints text at the next line. &return.success; - - - + + + + PDF_continue_text + Output text in next line + + + &reftitle.description; + + boolPDF_continue_text + resourcep + stringtext + + + Prints text at the next line. &return.success; + + + - - - PDF_create_action - Create action for objects or events - - - &reftitle.description; - - intPDF_create_action - resourcepdfdoc - stringtype - stringoptlist - - - Creates an action which can be applied to various objects and events. - - - + + + + PDF_create_action + Create action for objects or events + + + &reftitle.description; + + intPDF_create_action + resourcepdfdoc + stringtype + stringoptlist + + + Creates an action which can be applied to various objects and events. + + + - - - PDF_create_annotation - Create rectangular annotation - - - &reftitle.description; - - boolPDF_create_annotation - resourcepdfdoc - floatllx - floatlly - floaturx - floatury - stringtype - stringoptlist - - - Creates a rectangular annotation on the current page. - - - + + + + PDF_create_annotation + Create rectangular annotation + + + &reftitle.description; + + boolPDF_create_annotation + resourcepdfdoc + floatllx + floatlly + floaturx + floatury + stringtype + stringoptlist + + + Creates a rectangular annotation on the current page. + + + - - - PDF_create_bookmark - Create bookmark - - - &reftitle.description; - - intPDF_create_bookmark - resourcepdfdoc - stringtext - stringoptlist - - - Creates a bookmark subject to various options. - - - + + + + PDF_create_bookmark + Create bookmark + + + &reftitle.description; + + intPDF_create_bookmark + resourcepdfdoc + stringtext + stringoptlist + + + Creates a bookmark subject to various options. + + + - - - PDF_create_field - Create form field - - - &reftitle.description; - - boolPDF_create_field - resourcepdfdoc - floatllx - floatlly - floaturx - floatury - stringname - stringtype - stringoptlist - - - Creates a form field on the current page subject to various options. - - - + + + + PDF_create_field + Create form field + + + &reftitle.description; + + boolPDF_create_field + resourcepdfdoc + floatllx + floatlly + floaturx + floatury + stringname + stringtype + stringoptlist + + + Creates a form field on the current page subject to various options. + + + - - - PDF_create_fieldgroup - Create form field group - - - &reftitle.description; - - boolPDF_create_fieldgroup - resourcepdfdoc - stringname - stringoptlist - - - Creates a form field group subject to various options. - - - + + + + PDF_create_fieldgroup + Create form field group + + + &reftitle.description; + + boolPDF_create_fieldgroup + resourcepdfdoc + stringname + stringoptlist + + + Creates a form field group subject to various options. + + + - - - PDF_create_gstate - Create graphics state object - - - &reftitle.description; - - intPDF_create_gstate - resourcepdfdoc - stringoptlist - - - Creates a graphics state object subject to various options. - - - + + + + PDF_create_gstate + Create graphics state object + + + &reftitle.description; + + intPDF_create_gstate + resourcepdfdoc + stringoptlist + + + Creates a graphics state object subject to various options. + + + - - - PDF_create_pvf - Create PDFlib virtual file - - - &reftitle.description; - - boolPDF_create_pvf - resourcepdfdoc - stringfilename - stringdata - stringoptlist - - - Creates a named virtual read-only file from data provided in memory. - - - + + + + PDF_create_pvf + Create PDFlib virtual file + + + &reftitle.description; + + boolPDF_create_pvf + resourcepdfdoc + stringfilename + stringdata + stringoptlist + + + Creates a named virtual read-only file from data provided in memory. + + + - - - PDF_create_textflow - Create textflow object - - - &reftitle.description; - - intPDF_create_textflow - resourcepdfdoc - stringtext - stringoptlist - - - Preprocesses text for later formatting and creates a textflow object. - - - + + + + PDF_create_textflow + Create textflow object + + + &reftitle.description; + + intPDF_create_textflow + resourcepdfdoc + stringtext + stringoptlist + + + Preprocesses text for later formatting and creates a textflow object. + + + - - - PDF_curveto - Draw Bezier curve - - - &reftitle.description; - - boolPDF_curveto - resourcep - floatx1 - floaty1 - floatx2 - floaty2 - floatx3 - floaty3 - - - Draws a Bezier curve from the current point, using 3 more control points. - &return.success; - - - + + + + PDF_curveto + Draw Bezier curve + + + &reftitle.description; + + boolPDF_curveto + resourcep + floatx1 + floaty1 + floatx2 + floaty2 + floatx3 + floaty3 + + + Draws a Bezier curve from the current point, using 3 more control points. + &return.success; + + + - - - PDF_define_layer - Create layer definition - - - &reftitle.description; - - intPDF_define_layer - resourcepdfdoc - stringname - stringoptlist - - - Creates a new layer definition. - - - This function requires PDF 1.5. - - - + + + + PDF_define_layer + Create layer definition + + + &reftitle.description; + + intPDF_define_layer + resourcepdfdoc + stringname + stringoptlist + + + Creates a new layer definition. + + + This function requires PDF 1.5. + + + - - - PDF_delete_pvf - Delete PDFlib virtual file - - - &reftitle.description; - - intPDF_delete_pvf - resourcepdfdoc - stringfilename - - - Deletes a named virtual file and frees its data structures (but not - the contents). - - - + + + + PDF_delete_pvf + Delete PDFlib virtual file + + + &reftitle.description; + + intPDF_delete_pvf + resourcepdfdoc + stringfilename + + + Deletes a named virtual file and frees its data structures (but not + the contents). + + + - - - PDF_delete_textflow - Delete textflow object - - - &reftitle.description; - - boolPDF_delete_textflow - resourcepdfdoc - inttextflow - - - Deletes a textflow and the associated data structures. - - - + + + + PDF_delete_textflow + Delete textflow object + + + &reftitle.description; + + boolPDF_delete_textflow + resourcepdfdoc + inttextflow + + + Deletes a textflow and the associated data structures. + + + - - - PDF_delete - Delete PDFlib object - - - &reftitle.description; - - boolPDF_delete - resourcepdfdoc - - - Deletes a PDFlib object, and frees all internal resources. &return.success; - - - + + + + PDF_delete + Delete PDFlib object + + + &reftitle.description; + + boolPDF_delete + resourcepdfdoc + + + Deletes a PDFlib object, and frees all internal resources. &return.success; + + + - - - PDF_encoding_set_char - Add glyph name and/or Unicode value - - - &reftitle.description; - - boolPDF_encoding_set_char - resourcepdfdoc - stringencoding - intslot - stringglyphname - intuv - - - Adds a glyph name and/or Unicode value to a custom encoding. - - - + + + + PDF_encoding_set_char + Add glyph name and/or Unicode value + + + &reftitle.description; + + boolPDF_encoding_set_char + resourcepdfdoc + stringencoding + intslot + stringglyphname + intuv + + + Adds a glyph name and/or Unicode value to a custom encoding. + + + - - - PDF_end_document - Close PDF file - - - &reftitle.description; - - boolPDF_end_document - resourcepdfdoc - stringoptlist - - - Closes the generated PDF file and applies various options. - - - + + + + PDF_end_document + Close PDF file + + + &reftitle.description; + + boolPDF_end_document + resourcepdfdoc + stringoptlist + + + Closes the generated PDF file and applies various options. + + + - - - PDF_end_font - Terminate Type 3 font definition - - - &reftitle.description; - - boolPDF_end_font - resourcepdfdoc - - - Terminates a Type 3 font definition. - - - + + + + PDF_end_font + Terminate Type 3 font definition + + + &reftitle.description; + + boolPDF_end_font + resourcepdfdoc + + + Terminates a Type 3 font definition. + + + - - - PDF_end_glyph - Terminate glyph definition for Type 3 font - - - &reftitle.description; - - boolPDF_end_glyph - resourcepdfdoc - - - Terminates a glyph definition for a Type 3 font. - - - + + + + PDF_end_glyph + Terminate glyph definition for Type 3 font + + + &reftitle.description; + + boolPDF_end_glyph + resourcepdfdoc + + + Terminates a glyph definition for a Type 3 font. + + + - - - PDF_end_item - Close structure element or other content item - - - &reftitle.description; - - boolPDF_end_item - resourcepdfdoc - intid - - - Closes a structure element or other content item. - - - + + + + PDF_end_item + Close structure element or other content item + + + &reftitle.description; + + boolPDF_end_item + resourcepdfdoc + intid + + + Closes a structure element or other content item. + + + - - - PDF_end_layer - Deactivate all active layers - - - &reftitle.description; - - boolPDF_end_layer - resourcepdfdoc - - - Deactivates all active layers. &return.success; - - - This function requires PDF 1.5. - - - + + + + PDF_end_layer + Deactivate all active layers + + + &reftitle.description; + + boolPDF_end_layer + resourcepdfdoc + + + Deactivates all active layers. &return.success; + + + This function requires PDF 1.5. + + + - - - PDF_end_page_ext - Finish page - - - &reftitle.description; - - boolPDF_end_page_ext - resourcepdfdoc - stringoptlist - - - Finishes a page, and applies various options. &return.success; - - - + + + + PDF_end_page_ext + Finish page + + + &reftitle.description; + + boolPDF_end_page_ext + resourcepdfdoc + stringoptlist + + + Finishes a page, and applies various options. &return.success; + + + - - - PDF_end_page - Finish page - - - &reftitle.description; - - boolPDF_end_page - resourcep - - - Finishes the page. &return.success; - - - + + + + PDF_end_page + Finish page + + + &reftitle.description; + + boolPDF_end_page + resourcep + + + Finishes the page. &return.success; + + + - - - PDF_end_pattern - Finish pattern - - - &reftitle.description; - - boolPDF_end_pattern - resourcep - - - Finishes the pattern definition. &return.success; - - - + + + + PDF_end_pattern + Finish pattern + + + &reftitle.description; + + boolPDF_end_pattern + resourcep + + + Finishes the pattern definition. &return.success; + + + - - - PDF_end_template - Finish template - - - &reftitle.description; - - boolPDF_end_template - resourcep - - - Finishes a template definition. &return.success; - - - + + + + PDF_end_template + Finish template + + + &reftitle.description; + + boolPDF_end_template + resourcep + + + Finishes a template definition. &return.success; + + + - - - PDF_endpath - End current path - - - &reftitle.description; - - Ends the current path without filling or stroking it. - - - + + + + PDF_endpath + End current path + + + &reftitle.description; + + Ends the current path without filling or stroking it. + + + - - - PDF_fill_imageblock - Fill image block with variable data - - - &reftitle.description; - - intPDF_fill_imageblock - resourcepdfdoc - intpage - stringblockname - intimage - stringoptlist - - - Fills an image block with variable data according to its properties. - - - This function is only available in the PDFlib Personalization - Server (PPS). - - - + + + + PDF_fill_imageblock + Fill image block with variable data + + + &reftitle.description; + + intPDF_fill_imageblock + resourcepdfdoc + intpage + stringblockname + intimage + stringoptlist + + + Fills an image block with variable data according to its properties. + + + This function is only available in the PDFlib Personalization + Server (PPS). + + + - - - PDF_fill_pdfblock - Fill PDF block with variable data - - - &reftitle.description; - - intPDF_fill_pdfblock - resourcepdfdoc - intpage + + + + PDF_fill_pdfblock + Fill PDF block with variable data + + + &reftitle.description; + + intPDF_fill_pdfblock + resourcepdfdoc + intpage stringblockname - intcontents - stringoptlist - - - Fills a PDF block with variable data according to its properties. - - - This function is only available in the PDFlib Personalization - Server (PPS). - - - + intcontents + stringoptlist + + + Fills a PDF block with variable data according to its properties. + + + This function is only available in the PDFlib Personalization + Server (PPS). + + + - - - PDF_fill_stroke - Fill and stroke path - - - &reftitle.description; - - boolPDF_fill_stroke - resourcep - - - Fills and strokes the current path with the current fill and stroke color. - &return.success; - - - + + + + PDF_fill_stroke + Fill and stroke path + + + &reftitle.description; + + boolPDF_fill_stroke + resourcep + + + Fills and strokes the current path with the current fill and stroke color. + &return.success; + + + - - - PDF_fill_textblock - Fill text block with variable data - - - &reftitle.description; - - intPDF_fill_textblock - resourcepdfdoc - intpage - 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). - - - + + + + PDF_fill_textblock + Fill text block with variable data + + + &reftitle.description; + + intPDF_fill_textblock + resourcepdfdoc + intpage + 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). + + + - - - PDF_fill - Fill current path - - - &reftitle.description; - - boolPDF_fill - resourcep - - - Fills the interior of the current path with the current fill color. - &return.success; - - - + + + + PDF_fill + Fill current path + + + &reftitle.description; + + boolPDF_fill + resourcep + + + Fills the interior of the current path with the current fill color. + &return.success; + + + - - - PDF_findfont - Prepare font for later use [deprecated] - - - &reftitle.description; - - intPDF_findfont - resourcep - stringfontname - stringencoding - intembed - - - 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, - macroman, winansi, - host, a user-defined encoding name or the name of - a CMap. - Parameter embed is optional before PHP 4.3.5 or - with PDFlib less than 5. - - - This function is deprecated since PDFlib version 5, use - PDF_load_font instead. - - - + + + + PDF_findfont + Prepare font for later use [deprecated] + + + &reftitle.description; + + intPDF_findfont + resourcep + stringfontname + stringencoding + intembed + + + 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, + macroman, winansi, + host, a user-defined encoding name or the name of + a CMap. + Parameter embed is optional before PHP 4.3.5 or + with PDFlib less than 5. + + + This function is deprecated since PDFlib version 5, use + PDF_load_font instead. + + + - - - PDF_fit_image - Place image or template - - - &reftitle.description; - - boolPDF_fit_image - resourcepdfdoc - intimage - floatx - floaty - stringoptlist - - - Places an image or template on the page, subject to various options. - &return.success; - - - + + + + PDF_fit_image + Place image or template + + + &reftitle.description; + + boolPDF_fit_image + resourcepdfdoc + intimage + floatx + floaty + stringoptlist + + + Places an image or template on the page, subject to various options. + &return.success; + + + - - - PDF_fit_pdi_page - Place imported PDF page - - - &reftitle.description; - - boolPDF_fit_pdi_page - resourcepdfdoc - intpage - floatx - floaty - stringoptlist - - - Places an imported PDF page on the page, subject to various options. - &return.success; - - - + + + + PDF_fit_pdi_page + Place imported PDF page + + + &reftitle.description; + + boolPDF_fit_pdi_page + resourcepdfdoc + intpage + floatx + floaty + stringoptlist + + + Places an imported PDF page on the page, subject to various options. + &return.success; + + + - - - PDF_fit_textflow - Format textflow in rectangular area - - - &reftitle.description; - - stringPDF_fit_textflow - resourcepdfdoc - inttextflow - floatllx - floatlly - floaturx - floatury - stringoptlist - - - Formats the next portion of a textflow into a rectangular area. - - - + + + + PDF_fit_textflow + Format textflow in rectangular area + + + &reftitle.description; + + stringPDF_fit_textflow + resourcepdfdoc + inttextflow + floatllx + floatlly + floaturx + floatury + stringoptlist + + + Formats the next portion of a textflow into a rectangular area. + + + - - - PDF_fit_textline - Place single line of text - - - &reftitle.description; - - boolPDF_fit_textline - resourcepdfdoc - stringtext - floatx - floaty - stringoptlist - - - Places a single line of text on the page, subject to various options. &return.success; - - - + + + + PDF_fit_textline + Place single line of text + + + &reftitle.description; + + boolPDF_fit_textline + resourcepdfdoc + stringtext + floatx + floaty + stringoptlist + + + Places a single line of text on the page, subject to various options. &return.success; + + + - - - PDF_get_apiname - Get name of unsuccessfull API function - - - &reftitle.description; - - stringPDF_get_apiname - resourcepdfdoc - - - Gets the name of the API function which threw the last exception or failed. - - - + + + + PDF_get_apiname + Get name of unsuccessfull API function + + + &reftitle.description; + + stringPDF_get_apiname + resourcepdfdoc + + + Gets the name of the API function which threw the last exception or failed. + + + - - - PDF_get_buffer - Get PDF output buffer - - - &reftitle.description; - - stringPDF_get_buffer - resourcep - - - Fetches the buffer containing the generated PDF data. - - - + + + + PDF_get_buffer + Get PDF output buffer + + + &reftitle.description; + + stringPDF_get_buffer + resourcep + + + Fetches the buffer containing the generated PDF data. + + + - - - PDF_get_errmsg - Get error text - - - &reftitle.description; - - stringPDF_get_errmsg - resourcepdfdoc - - - Gets the text of the last thrown exception or the reason for a failed - function call. - - - + + + + PDF_get_errmsg + Get error text + + + &reftitle.description; + + stringPDF_get_errmsg + resourcepdfdoc + + + Gets the text of the last thrown exception or the reason for a failed + function call. + + + - - - PDF_get_errnum - Get error number - - - &reftitle.description; - - intPDF_get_errnum - resourcepdfdoc - - - Gets the number of the last thrown exception or the reason for a failed - function call. - - - + + + + PDF_get_errnum + Get error number + + + &reftitle.description; + + intPDF_get_errnum + resourcepdfdoc + + + Gets the number of the last thrown exception or the reason for a failed + function call. + + + - - - PDF_get_font - Get font [deprecated] - - - &reftitle.description; - - This function is deprecated since PDFlib version 3, - use PDF_get_value with the parameter - font instead. - - - + + + + PDF_get_font + Get font [deprecated] + + + &reftitle.description; + + This function is deprecated since PDFlib version 3, + use PDF_get_value with the parameter + font instead. + + + - - - PDF_get_fontname - Get font name [deprecated] - - - &reftitle.description; - - This function is deprecated since PDFlib version 3, use - PDF_get_parameter with the parameter - fontname instead. - - - + + + + PDF_get_fontname + Get font name [deprecated] + + + &reftitle.description; + + This function is deprecated since PDFlib version 3, use + PDF_get_parameter with the parameter + fontname instead. + + + - - - PDF_get_fontsize - Font handling [deprecated] - - - &reftitle.description; - - This function is deprecated since PDFlib version 3, use - PDF_get_value with the parameter - fontsizeinstead. - - - + + + + PDF_get_fontsize + Font handling [deprecated] + + + &reftitle.description; + + This function is deprecated since PDFlib version 3, use + PDF_get_value with the parameter + fontsizeinstead. + + + - - - 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_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_image_width - Get image width [deprecated] - - - &reftitle.description; - - This function is deprecated since PDFlib version 3, use - PDF_get_value with the parameter - imagewidth instead. - - - + + + + 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 + imagewidth instead. + + + - - - PDF_get_majorversion - Get major version number [deprecated] - - - &reftitle.description; - - intPDF_get_majorversion - - - - This function is deprecated since PDFlib version 5, use - PDF_get_value with the parameter - major instead. - - - + + + + PDF_get_majorversion + Get major version number [deprecated] + + + &reftitle.description; + + intPDF_get_majorversion + + + + This function is deprecated since PDFlib version 5, use + PDF_get_value with the parameter + major instead. + + + - - - PDF_get_minorversion - Get minor version number [deprecated] - - - &reftitle.description; - - intPDF_get_minorversion - - - - Returns the minor version number of the PDFlib version. - - - This function is deprecated since PDFlib version 5, use - PDF_get_value with the parameter - minor instead. - - - + + + + PDF_get_minorversion + Get minor version number [deprecated] + + + &reftitle.description; + + intPDF_get_minorversion + + + + Returns the minor version number of the PDFlib version. + + + This function is deprecated since PDFlib version 5, use + PDF_get_value with the parameter + minor instead. + + + - - - PDF_get_parameter - Get string parameter - - - &reftitle.description; - - stringPDF_get_parameter - resourcep - stringkey - floatmodifier - - - Gets the contents of some PDFlib parameter with string type. - - - + + + + PDF_get_parameter + Get string parameter + + + &reftitle.description; + + stringPDF_get_parameter + resourcep + stringkey + floatmodifier + + + Gets the contents of some PDFlib parameter with string type. + + + - - - PDF_get_pdi_parameter - Get PDI string parameter - - - &reftitle.description; - - stringPDF_get_pdi_parameter - resourcep - stringkey - intdoc - intpage - intreserved - - - Gets the contents of a PDI document parameter with string type. - - - + + + + PDF_get_pdi_parameter + Get PDI string parameter + + + &reftitle.description; + + stringPDF_get_pdi_parameter + resourcep + stringkey + intdoc + intpage + intreserved + + + Gets the contents of a PDI document parameter with string type. + + + - - - PDF_get_pdi_value - Get PDI numerical parameter - - - &reftitle.description; - - floatPDF_get_pdi_value - resourcep - stringkey - intdoc - intpage - intreserved - - - Gets the contents of a PDI document parameter with numerical type. - - - + + + + PDF_get_pdi_value + Get PDI numerical parameter + + + &reftitle.description; + + floatPDF_get_pdi_value + resourcep + stringkey + intdoc + intpage + intreserved + + + Gets the contents of a PDI document parameter with numerical type. + + + - - - PDF_get_value - Get numerical parameter - - - &reftitle.description; - - floatPDF_get_value - resourcep - stringkey - floatmodifier - - - Gets the value of some PDFlib parameter with numerical type. - - - + + + + PDF_get_value + Get numerical parameter + + + &reftitle.description; + + floatPDF_get_value + resourcep + stringkey + floatmodifier + + + Gets the value of some PDFlib parameter with numerical type. + + + - - - PDF_info_textflow - Query textflow state - - - &reftitle.description; - - floatPDF_info_textflow - resourcepdfdoc - inttextflow - stringkeyword - - - Queries the current state of a textflow. - - - + + + + PDF_info_textflow + Query textflow state + + + &reftitle.description; + + floatPDF_info_textflow + resourcepdfdoc + inttextflow + stringkeyword + + + Queries the current state of a textflow. + + + - - - PDF_initgraphics - Reset graphic state - - - &reftitle.description; - - boolPDF_initgraphics - resourcep - - - Reset all color and graphics state parameters to their defaults. - &return.success; - - - + + + + PDF_initgraphics + Reset graphic state + + + &reftitle.description; + + boolPDF_initgraphics + resourcep + + + Reset all color and graphics state parameters to their defaults. + &return.success; + + + - - - PDF_lineto - Draw a line - - - &reftitle.description; - - boolPDF_lineto - resourcep - floatx - floaty - - - Draws a line from the current point to another point. &return.success; - - - + + + + PDF_lineto + Draw a line + + + &reftitle.description; + + boolPDF_lineto + resourcep + floatx + floaty + + + Draws a line from the current point to another point. &return.success; + + + - - - PDF_load_font - Search and prepare font - - - &reftitle.description; - - intPDF_load_font - resourcepdfdoc - stringfontname - stringencoding - stringoptlist - - - Searches for a font and prepares it for later use. - - - + + + + PDF_load_font + Search and prepare font + + + &reftitle.description; + + intPDF_load_font + resourcepdfdoc + stringfontname + stringencoding + stringoptlist + + + Searches for a font and prepares it for later use. + + + - - - PDF_load_iccprofile - Search and prepare ICC profile - - - &reftitle.description; - - intPDF_load_iccprofile - resourcepdfdoc - stringprofilename - stringoptlist - - - Searches for an ICC profile, and prepares it for later use. - - - + + + + PDF_load_iccprofile + Search and prepare ICC profile + + + &reftitle.description; + + intPDF_load_iccprofile + resourcepdfdoc + stringprofilename + stringoptlist + + + Searches for an ICC profile, and prepares it for later use. + + + - - - PDF_load_image - Open image file - - - &reftitle.description; - - intPDF_load_image - resourcepdfdoc - stringimagetype - stringfilename - stringoptlist - - - Opens a disk-based or virtual image file subject to various options. - - - + + + + PDF_load_image + Open image file + + + &reftitle.description; + + intPDF_load_image + resourcepdfdoc + stringimagetype + stringfilename + stringoptlist + + + Opens a disk-based or virtual image file subject to various options. + + + - - - PDF_makespotcolor - Make spot color - - - &reftitle.description; - - intPDF_makespotcolor - resourcep - stringspotname - - - Finds a built-in spot color name, or makes a named spot color from the - current fill color. &return.success; - - - + + + + PDF_makespotcolor + Make spot color + + + &reftitle.description; + + intPDF_makespotcolor + resourcep + stringspotname + + + Finds a built-in spot color name, or makes a named spot color from the + current fill color. &return.success; + + + - - - PDF_moveto - Set current point - - - &reftitle.description; - - boolPDF_moveto - resourcep - floatx - floaty - - - Sets the current point for graphics output. &return.success; - - - + + + + PDF_moveto + Set current point + + + &reftitle.description; + + boolPDF_moveto + resourcep + floatx + floaty + + + Sets the current point for graphics output. &return.success; + + + - - - PDF_new - Create PDFlib object - - - &reftitle.description; - - resourcePDF_new - - - - Creates a new PDFlib object with default settings. - - - + + + + PDF_new + Create PDFlib object + + + &reftitle.description; + + resourcePDF_new + + + + Creates a new PDFlib object with default settings. + + + - - - PDF_open_ccitt - Open raw CCITT image [deprecated] - - - &reftitle.description; - - intPDF_open_ccitt - resourcepdfdoc - stringfilename - intwidth - intheight - intBitReverse - intk - intBlackls1 - - - Opens a raw CCITT image. - - This function is deprecated since PDFlib version 5, - use PDF_load_image instead. - - - + + + + PDF_open_ccitt + Open raw CCITT image [deprecated] + + + &reftitle.description; + + intPDF_open_ccitt + resourcepdfdoc + stringfilename + intwidth + intheight + intBitReverse + intk + intBlackls1 + + + Opens a raw CCITT image. + + This function is deprecated since PDFlib version 5, + use PDF_load_image instead. + + + - - - PDF_open_file - Create PDF file [deprecated] - - - &reftitle.description; - - boolPDF_open_file - resourcep - stringfilename - - - Creates a new PDF file using the supplied file name. - &return.success; - - - This function is deprecated since PDFlib version 6, use - PDF_begin_document instead. - - - + + + + PDF_open_file + Create PDF file [deprecated] + + + &reftitle.description; + + boolPDF_open_file + resourcep + stringfilename + + + Creates a new PDF file using the supplied file name. + &return.success; + + + This function is deprecated since PDFlib version 6, use + PDF_begin_document instead. + + + - - - PDF_open_gif - Open GIF image [deprecated] - - - &reftitle.description; - - This function is deprecated since PDFlib version 3, use - PDF_load_image instead. - - - + + + + PDF_open_gif + Open GIF image [deprecated] + + + &reftitle.description; + + This function is deprecated since PDFlib version 3, use + PDF_load_image instead. + + + - - - PDF_open_image_file - Read image from file [deprecated] - - - &reftitle.description; - - intPDF_open_image_file - resourcep - stringimagetype - stringfilename - stringstringparam - intintparam - - - Opens an image file. - - - This function is deprecated since PDFlib version 5, use - PDF_load_image with the colorize, ignoremask, - invert, mask, masked, and page options instead. - - - + + + + PDF_open_image_file + Read image from file [deprecated] + + + &reftitle.description; + + intPDF_open_image_file + resourcep + stringimagetype + stringfilename + stringstringparam + intintparam + + + Opens an image file. + + + This function is deprecated since PDFlib version 5, use + PDF_load_image with the colorize, ignoremask, + invert, mask, masked, and page options instead. + + + - - - PDF_open_image - Use image data [deprecated] - - - &reftitle.description; - - intPDF_open_image - resourcep - stringimagetype - stringsource - stringdata - intlength - intwidth - intheight - intcomponents - intbpc - stringparams - - - 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. - - - + + + + PDF_open_image + Use image data [deprecated] + + + &reftitle.description; + + intPDF_open_image + resourcep + stringimagetype + stringsource + stringdata + intlength + intwidth + intheight + intcomponents + intbpc + stringparams + + + 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. + + + - - - PDF_open_jpeg - Open JPEG image [deprecated] - - - &reftitle.description; - - This function is deprecated since PDFlib version 3, use - PDF_load_image instead. - - - + + + + PDF_open_jpeg + Open JPEG image [deprecated] + + + &reftitle.description; + + This function is deprecated since PDFlib version 3, use + PDF_load_image instead. + + + - - - PDF_open_memory_image - Open image created with PHP's image functions [not supported] - - - &reftitle.description; - - intPDF_open_memory_image - resourcep - resourceimage - - This function is not supported by PDFlib GmbH. - - + + + + PDF_open_memory_image + Open image created with PHP's image functions [not supported] + + + &reftitle.description; + + intPDF_open_memory_image + resourcep + resourceimage + + + This function is not supported by PDFlib GmbH. + + + - - - PDF_open_pdi_page - - Prepare a page - - - - &reftitle.description; - - intPDF_open_pdi_page - resourcep - intdoc - intpagenumber - stringoptlist - - - Prepares a page for later use with PDF_fit_pdi_page. - - - + + + + PDF_open_pdi_page + Prepare a page + + + &reftitle.description; + + intPDF_open_pdi_page + resourcep + intdoc + intpagenumber + stringoptlist + + + Prepares a page for later use with PDF_fit_pdi_page. + + + - - - PDF_open_pdi - Open PDF file - - - &reftitle.description; - - intPDF_open_pdi - resourcepdfdoc - stringfilename - stringoptlist - - - Opens a disk-based or virtual PDF document and prepares it for later use. - - - + + + + PDF_open_pdi + Open PDF file + + + &reftitle.description; + + intPDF_open_pdi + resourcepdfdoc + stringfilename + stringoptlist + + + Opens a disk-based or virtual PDF document and prepares it for later use. + + + - - - PDF_open_tiff - Open TIFF image [deprecated] - - - &reftitle.description; - - This function is deprecated since PDFlib version 3, use - PDF_load_image instead. - - - + + + + PDF_open_tiff + Open TIFF image [deprecated] + + + &reftitle.description; + + This function is deprecated since PDFlib version 3, use + PDF_load_image instead. + + + - - - PDF_place_image - Place image on the page [deprecated] - - - &reftitle.description; - - boolPDF_place_image - resourcepdfdoc - intimage - floatx - floaty - floatscale - - - Places an image and scales it. &return.success; - - - This function is deprecated since PDFlib version 5, use - PDF_fit_image instead. - - - + + + + PDF_place_image + Place image on the page [deprecated] + + + &reftitle.description; + + boolPDF_place_image + resourcepdfdoc + intimage + floatx + floaty + floatscale + + + Places an image and scales it. &return.success; + + + This function is deprecated since PDFlib version 5, use + PDF_fit_image instead. + + + - - - PDF_place_pdi_page - Place PDF page [deprecated] - - - &reftitle.description; - - boolPDF_place_pdi_page - resourcepdfdoc - intpage - floatx - floaty - floatsx - floatsy - - - Places a PDF page and scales it. &return.success; - - - This function is deprecated since PDFlib version 5, use - PDF_fit_pdi_page instead. - - - + + + + PDF_place_pdi_page + Place PDF page [deprecated] + + + &reftitle.description; + + boolPDF_place_pdi_page + resourcepdfdoc + intpage + floatx + floaty + floatsx + floatsy + + + Places a PDF page and scales it. &return.success; + + + This function is deprecated since PDFlib version 5, use + PDF_fit_pdi_page instead. + + + - - - PDF_process_pdi - Process imported PDF document - - - &reftitle.description; - - intPDF_process_pdi - resourcepdfdoc - intdoc - intpage - stringoptlist - - - Processes certain elements of an 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. + + + - - - PDF_rect - Draw rectangle - - - &reftitle.description; - - boolPDF_rect - resourcep - floatx - floaty - floatwidth - floatheight - - - Draws a rectangle. &return.success; - - - + + + + PDF_rect + Draw rectangle + + + &reftitle.description; + + boolPDF_rect + resourcep + floatx + floaty + floatwidth + floatheight + + + Draws a rectangle. &return.success; + + + - - - PDF_restore - Restore graphics state - - - &reftitle.description; - - boolPDF_restore - resourcep - - - Restores the most recently saved graphics state. &return.success; - - - + + + + PDF_restore + Restore graphics state + + + &reftitle.description; + + boolPDF_restore + resourcep + + + Restores the most recently saved graphics state. &return.success; + + + - - - PDF_resume_page - Resume page - - - &reftitle.description; - - boolPDF_resume_page - resourcepdfdoc - stringoptlist - - - Resumes a page to add more content to it. - - - + + + + PDF_resume_page + Resume page + + + &reftitle.description; + + boolPDF_resume_page + resourcepdfdoc + stringoptlist + + + Resumes a page to add more content to it. + + + - - - PDF_rotate - Rotate coordinate system - - - &reftitle.description; - - boolPDF_rotate - resourcep - floatphi - - - Rotates the coordinate system. &return.success; - - - + + + + PDF_rotate + Rotate coordinate system + + + &reftitle.description; + + boolPDF_rotate + resourcep + floatphi + + + Rotates the coordinate system. &return.success; + + + - - - PDF_save - Save graphics state - - - &reftitle.description; - - boolPDF_save - resourcep - - - Saves the current graphics state. &return.success; - - - + + + + PDF_save + Save graphics state + + + &reftitle.description; + + boolPDF_save + resourcep + + + Saves the current graphics state. &return.success; + + + - - - PDF_scale - Scale coordinate system - - - &reftitle.description; - - boolPDF_scale - resourcep - floatsx - floatsy - - - Scales the coordinate system. &return.success; - - - + + + + PDF_scale + Scale coordinate system + + + &reftitle.description; + + boolPDF_scale + resourcep + floatsx + floatsy + + + Scales the coordinate system. &return.success; + + + - - - PDF_set_border_color - Set border color of annotations [deprecated] - - - &reftitle.description; - - boolPDF_set_border_color - resourcep - floatred - floatgreen - floatblue - - - 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. - - - + + + + PDF_set_border_color + Set border color of annotations [deprecated] + + + &reftitle.description; + + boolPDF_set_border_color + resourcep + floatred + floatgreen + floatblue + + + 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. + + + - - - PDF_set_border_dash - Set border dash style of annotations [deprecated] - - - &reftitle.description; - - boolPDF_set_border_dash - resourcepdfdoc - floatblack - floatwhite - - - Sets the border dash style for all kinds of annotations. &return.success; - - - This function is deprecated since PDFlib version 6, use - the option dasharray in - PDF_create_annotation instead. - - - + + + + PDF_set_border_dash + Set border dash style of annotations [deprecated] + + + &reftitle.description; + + boolPDF_set_border_dash + resourcepdfdoc + floatblack + floatwhite + + + Sets the border dash style for all kinds of annotations. &return.success; + + + This function is deprecated since PDFlib version 6, use + the option dasharray in + PDF_create_annotation instead. + + + - - - PDF_set_border_style - Set border style of annotations [deprecated] - - - &reftitle.description; - - boolPDF_set_border_style - resourcepdfdoc - stringstyle - floatwidth - - - 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. - - - + + + + PDF_set_border_style + Set border style of annotations [deprecated] + + + &reftitle.description; + + boolPDF_set_border_style + resourcepdfdoc + stringstyle + floatwidth + + + 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. + + + - - - PDF_set_char_spacing - Set character spacing [deprecated] - - - &reftitle.description; - - This function is deprecated since PDFlib version 3, use - PDF_set_value with parameter - charspacing instead. - - - + + + + PDF_set_char_spacing + Set character spacing [deprecated] + + + &reftitle.description; + + This function is deprecated since PDFlib version 3, use + PDF_set_value with parameter + charspacing instead. + + + - - - PDF_set_duration - Set duration between pages [deprecated] - - - &reftitle.description; - - This function is deprecated since PDFlib version 3, use - the duration option in - PDF_begin_page_ext or - PDF_end_page_ext instead. - - - + + + + PDF_set_duration + Set duration between pages [deprecated] + + + &reftitle.description; + + This function is deprecated since PDFlib version 3, use + the duration option in + PDF_begin_page_ext or + PDF_end_page_ext instead. + + + - - - PDF_set_gstate - Activate graphics state object - - - &reftitle.description; - - boolPDF_set_gstate - resourcepdfdoc - intgstate - - - Activates a graphics state object. - - - + + + + PDF_set_gstate + Activate graphics state object + + + &reftitle.description; + + boolPDF_set_gstate + resourcepdfdoc + intgstate + + + Activates a graphics state object. + + + - - - 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 - horizscaling instead. - - - + + + + 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 + horizscaling instead. + + + - - - 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_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_creator - - Fill the creator document info field [deprecated] - - - - &reftitle.description; - - This function is deprecated since PDFlib version 3, use - PDF_set_info instead. - - - + + + + PDF_set_info_creator + Fill the creator document info field [deprecated] + + + &reftitle.description; + + This function is deprecated since PDFlib version 3, use + PDF_set_info instead. + + + - - - PDF_set_info_keywords - - Fill the keywords document info field [deprecated] - - - - &reftitle.description; - - This function is deprecated since PDFlib version 3, use - PDF_set_info instead. - - - + + + + PDF_set_info_keywords + Fill the keywords document info field [deprecated] + + + &reftitle.description; + + This function is deprecated since PDFlib version 3, use + PDF_set_info instead. + + + - - - PDF_set_info_subject - - Fill the subject document info field [deprecated] - - - - &reftitle.description; - - This function is deprecated since PDFlib version 3, use - PDF_set_info instead. - - - + + + + PDF_set_info_subject + Fill the subject document info field [deprecated] + + + &reftitle.description; + + This function is deprecated since PDFlib version 3, use + PDF_set_info instead. + + + - - - PDF_set_info_title - - Fill the title document info field [deprecated] - - - - &reftitle.description; - - This function is deprecated since PDFlib version 3, use - PDF_set_info instead. - - - + + + + PDF_set_info_title + Fill the title document info field [deprecated] + + + &reftitle.description; + + This function is deprecated since PDFlib version 3, use + PDF_set_info instead. + + + - - - PDF_set_info - Fill document info field - - - &reftitle.description; - - boolPDF_set_info - resourcep - stringkey - stringvalue - - - Fill document information field key with - value. &return.success; - - - + + + + PDF_set_info + Fill document info field + + + &reftitle.description; + + boolPDF_set_info + resourcep + stringkey + stringvalue + + + Fill document information field key with + value. &return.success; + + + - - - PDF_set_layer_dependency - Define relationships among layers - - - &reftitle.description; - - boolPDF_set_layer_dependency - resourcepdfdoc - stringtype - stringoptlist - - - Defines hierarchical and group relationships among layers. &return.success; - - - This function requires PDF 1.5. - - - + + + + PDF_set_layer_dependency + Define relationships among layers + + + &reftitle.description; + + boolPDF_set_layer_dependency + resourcepdfdoc + stringtype + stringoptlist + + + Defines hierarchical and group relationships among layers. &return.success; + + + This function requires PDF 1.5. + + + - - - 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 - leading instead. - - - + + + + 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 + leading instead. + + + - - - PDF_set_parameter - Set string parameter - - - &reftitle.description; - - boolPDF_set_parameter - resourcep - stringkey - stringvalue - - - Sets some PDFlib parameter with string type. &return.success; - - - + + + + PDF_set_parameter + Set string parameter + + + &reftitle.description; + + boolPDF_set_parameter + resourcep + stringkey + stringvalue + + + Sets some PDFlib parameter with string type. &return.success; + + + - - - 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_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_set_text_pos - Set text position - - - &reftitle.description; - - boolPDF_set_text_pos - resourcep - floatx - floaty - - - Sets the position for text output on the page. &return.success; - - - + + + + PDF_set_text_pos + Set text position + + + &reftitle.description; + + boolPDF_set_text_pos + resourcep + floatx + floaty + + + Sets the position for text output on the page. &return.success; + + + - - - PDF_set_text_rendering - Determine text rendering [deprecated] - - - &reftitle.description; - - This function is deprecated since PDFlib version 3, use - PDF_set_value with the - textrendering parameter instead. - - - + + + + PDF_set_text_rendering + Determine text rendering [deprecated] + + + &reftitle.description; + + This function is deprecated since PDFlib version 3, use + PDF_set_value with the + textrendering parameter instead. + + + - - - 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 - parameter instead. - - - + + + + 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 + parameter instead. + + + - - - PDF_set_value - Set numerical parameter - - - &reftitle.description; - - boolPDF_set_value - resourcep - stringkey - floatvalue - - - Sets the value of some PDFlib parameter with numerical type. &return.success; - - - + + + + PDF_set_value + Set numerical parameter + + + &reftitle.description; + + boolPDF_set_value + resourcep + stringkey + floatvalue + + + Sets the value of some PDFlib parameter with numerical type. &return.success; + + + - - - 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 - parameter instead. - - - + + + + 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 + parameter instead. + + + - - - PDF_setcolor - Set fill and stroke color - - - &reftitle.description; - - boolPDF_setcolor - resourcep - stringfstype - stringcolorspace - floatc1 - floatc2 - floatc3 - floatc4 - - - Sets the current color space and color. &return.success; - - - + + + + PDF_setcolor + Set fill and stroke color + + + &reftitle.description; + + boolPDF_setcolor + resourcep + stringfstype + stringcolorspace + floatc1 + floatc2 + floatc3 + floatc4 + + + Sets the current color space and color. &return.success; + + + - - - PDF_setdash - Set simple dash pattern - - - &reftitle.description; - - boolPDF_setdash - resourcepdfdoc - floatb - floatw - - - Sets the current dash pattern to b black - and w white units. &return.success; - - - + + + + PDF_setdash + Set simple dash pattern + + + &reftitle.description; + + boolPDF_setdash + resourcepdfdoc + floatb + floatw + + + Sets the current dash pattern to b black + and w white units. &return.success; + + + - - - PDF_setdashpattern - Set dash pattern - - - &reftitle.description; - - boolPDF_setdashpattern - resourcepdfdoc - stringoptlist - - - Sets a dash pattern defined by an option list. &return.success; - - - + + + + PDF_setdashpattern + Set dash pattern + + + &reftitle.description; + + boolPDF_setdashpattern + resourcepdfdoc + stringoptlist + + + Sets a dash pattern defined by an option list. &return.success; + + + - - - PDF_setflat - Set flatness - - - &reftitle.description; - - boolPDF_setflat - resourcepdfdoc - floatflatness - - - Sets the flatness parameter. &return.success; - - - + + + + PDF_setflat + Set flatness + + + &reftitle.description; + + boolPDF_setflat + resourcepdfdoc + floatflatness + + + Sets the flatness parameter. &return.success; + + + - - - PDF_setfont - Set font - - - &reftitle.description; - - boolPDF_setfont - resourcepdfdoc - intfont - floatfontsize - - - Sets the current font in the specified size, using a - font handle returned by PDF_load_font. - &return.success; - - - + + + + PDF_setfont + Set font + + + &reftitle.description; + + boolPDF_setfont + resourcepdfdoc + intfont + floatfontsize + + + Sets the current font in the specified size, using a + font handle returned by PDF_load_font. + &return.success; + + + - - - PDF_setgray_fill - Set fill color to gray [deprecated] - - - &reftitle.description; - - boolPDF_setgray_fill - resourcep - floatg - - - 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. - - - + + + + PDF_setgray_fill + Set fill color to gray [deprecated] + + + &reftitle.description; + + boolPDF_setgray_fill + resourcep + floatg + + + 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. + + + - - - PDF_setgray_stroke - Set stroke color to gray [deprecated] - - - &reftitle.description; - - boolPDF_setgray_stroke - resourcep - floatg - - - Sets the current 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_setgray_stroke + Set stroke color to gray [deprecated] + + + &reftitle.description; + + boolPDF_setgray_stroke + resourcep + floatg + + + Sets the current 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_setgray - Set color to gray [deprecated] - - - &reftitle.description; - - 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_setgray + Set color to gray [deprecated] + + + &reftitle.description; + + 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_setlinecap - Set linecap parameter - - - &reftitle.description; - - boolPDF_setlinecap - resourcep - intlinecap - - - Sets the linecap parameter to control the shape - at the end of a path with respect to stroking. - - - + + + + PDF_setlinecap + Set linecap parameter + + + &reftitle.description; + + boolPDF_setlinecap + resourcep + intlinecap + + + Sets the linecap parameter to control the shape + at the end of a path with respect to stroking. + + + - - - PDF_setlinejoin - Set linejoin parameter - - - &reftitle.description; - - boolPDF_setlinejoin - resourcep - intvalue - - - Sets the linejoin parameter to specify the shape - at the corners of paths that are stroked. &return.success; - - - + + + + PDF_setlinejoin + Set linejoin parameter + + + &reftitle.description; + + boolPDF_setlinejoin + resourcep + intvalue + + + Sets the linejoin parameter to specify the shape + at the corners of paths that are stroked. &return.success; + + + - - - PDF_setlinewidth - Set line width - - - &reftitle.description; - - boolPDF_setlinewidth - resourcep - floatwidth - - - Sets the current line width. &return.success; - - - + + + + PDF_setlinewidth + Set line width + + + &reftitle.description; + + boolPDF_setlinewidth + resourcep + floatwidth + + + Sets the current line width. &return.success; + + + - - - PDF_setmatrix - Set current transformation matrix - - - &reftitle.description; - - boolPDF_setmatrix - resourcep - floata - floatb - floatc - floatd - floate - floatf - - - Explicitly sets the current transformation matrix. &return.success; - - - + + + + PDF_setmatrix + Set current transformation matrix + + + &reftitle.description; + + boolPDF_setmatrix + resourcep + floata + floatb + floatc + floatd + floate + floatf + + + Explicitly sets the current transformation matrix. &return.success; + + + - - - PDF_setmiterlimit - Set miter limit - - - &reftitle.description; - - boolPDF_setmiterlimit - resourcepdfdoc - floatmiter - - - Sets the miter limit.&return.success; - - - + + + + PDF_setmiterlimit + Set miter limit + + + &reftitle.description; + + boolPDF_setmiterlimit + resourcepdfdoc + floatmiter + + + Sets the miter limit.&return.success; + + + - - - PDF_setpolydash - Set complicated dash pattern [deprecated] - - - &reftitle.description; - - This function is deprecated since PDFlib version 5, use - PDF_setdashpattern instead. - - - + + + + PDF_setpolydash + Set complicated dash pattern [deprecated] + + + &reftitle.description; + + This function is deprecated since PDFlib version 5, use + PDF_setdashpattern instead. + + + - - - PDF_setrgbcolor_fill - Set fill rgb color values [deprecated] - - - &reftitle.description; - - boolPDF_setrgbcolor_fill - resourcep - floatred - floatgreen - floatblue - - - Sets the current fill color to the supplied RGB values. &return.success; - - - This function is deprecated since PDFlib version 4, use - PDF_setcolor instead. - - - + + + + PDF_setrgbcolor_fill + Set fill rgb color values [deprecated] + + + &reftitle.description; + + boolPDF_setrgbcolor_fill + resourcep + floatred + floatgreen + floatblue + + + Sets the current fill color to the supplied RGB values. &return.success; + + + This function is deprecated since PDFlib version 4, use + PDF_setcolor instead. + + + - - - PDF_setrgbcolor_stroke - Set stroke rgb color values [deprecated] - - - &reftitle.description; - - boolPDF_setrgbcolor_stroke - resourcep - floatred - floatgreen - floatblue - - - Sets the current stroke color to the supplied RGB values. &return.success; - - - This function is deprecated since PDFlib version 4, use - PDF_setcolor instead. - - - + + + + PDF_setrgbcolor_stroke + Set stroke rgb color values [deprecated] + + + &reftitle.description; + + boolPDF_setrgbcolor_stroke + resourcep + floatred + floatgreen + floatblue + + + Sets the current stroke color to the supplied RGB values. &return.success; + + + This function is deprecated since PDFlib version 4, use + PDF_setcolor instead. + + + - - - PDF_setrgbcolor - Set fill and stroke rgb color values [deprecated] - - - &reftitle.description; - - boolPDF_setrgbcolor - resourcep - floatred - floatgreen - floatblue - - - Sets the current fill and stroke color to the supplied RGB values. - &return.success; - - - This function is deprecated since PDFlib version 4, use - PDF_setcolor instead. - - - + + + + PDF_setrgbcolor + Set fill and stroke rgb color values [deprecated] + + + &reftitle.description; + + boolPDF_setrgbcolor + resourcep + floatred + floatgreen + floatblue + + + Sets the current fill and stroke color to the supplied RGB values. + &return.success; + + + This function is deprecated since PDFlib version 4, use + PDF_setcolor instead. + + + - - - PDF_shading_pattern - Define shading pattern - - - &reftitle.description; - - intPDF_shading_pattern - resourcepdfdoc - intshading - stringoptlist - - - Defines a shading pattern using a shading object. - - - This function requires PDF 1.4 or above. - - - + + + + PDF_shading_pattern + Define shading pattern + + + &reftitle.description; + + intPDF_shading_pattern + resourcepdfdoc + intshading + stringoptlist + + + Defines a shading pattern using a shading object. + + + This function requires PDF 1.4 or above. + + + - - - PDF_shading - Define blend - - - &reftitle.description; - - intPDF_shading - resourcepdfdoc - stringshtype - floatx0 - floaty0 - floatx1 - floaty1 - floatc1 - floatc2 - floatc3 - floatc4 - stringoptlist - - - Defines a blend from the current fill color to another color. - - - This function requires PDF 1.4 or above. - - - + + + + PDF_shading + Define blend + + + &reftitle.description; + + intPDF_shading + resourcepdfdoc + stringshtype + floatx0 + floaty0 + floatx1 + floaty1 + floatc1 + floatc2 + floatc3 + floatc4 + stringoptlist + + + Defines a blend from the current fill color to another color. + + + This function requires PDF 1.4 or above. + + + - - - PDF_shfill - Fill area with shading - - - &reftitle.description; - - boolPDF_shfill - resourcepdfdoc - intshading - - - Fills an area with a shading, based on a shading object. - - - This function requires PDF 1.4 or above. - - - + + + + PDF_shfill + Fill area with shading + + + &reftitle.description; + + boolPDF_shfill + resourcepdfdoc + intshading + + + Fills an area with a shading, based on a shading object. + + + This function requires PDF 1.4 or above. + + + - - - PDF_show_boxed - Output text in a box [deprecated] - - - &reftitle.description; - - intPDF_show_boxed - resourcep - stringtext - floatleft - floattop - floatwidth - floatheight - 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. - - - + + + + PDF_show_boxed + Output text in a box [deprecated] + + + &reftitle.description; + + intPDF_show_boxed + resourcep + stringtext + floatleft + floattop + floatwidth + floatheight + 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. + + + - - - PDF_show_xy - Output text at given position - - - &reftitle.description; - - boolPDF_show_xy - resourcep - stringtext - floatx - floaty - - - Prints text in the current font. &return.success; - - - + + + + PDF_show_xy + Output text at given position + + + &reftitle.description; + + boolPDF_show_xy + resourcep + stringtext + floatx + floaty + + + Prints text in the current font. &return.success; + + + - - - PDF_show - Output text at current position - - - &reftitle.description; - - boolPDF_show - resourcepdfdoc - stringtext - - - Prints text in the current font and size at - the current position. &return.success; - - - + + + + PDF_show + Output text at current position + + + &reftitle.description; + + boolPDF_show + resourcepdfdoc + stringtext + + + Prints text in the current font and size at + the current position. &return.success; + + + - - - PDF_skew - Skew the coordinate system - - - &reftitle.description; - - boolPDF_skew - resourcep - floatalpha - floatbeta - - - Skews the coordinate system in x and y direction by alpha - and beta degrees. &return.success; - - - + + + + PDF_skew + Skew the coordinate system + + + &reftitle.description; + + boolPDF_skew + resourcep + floatalpha + floatbeta + + + Skews the coordinate system in x and y direction by alpha + and beta degrees. &return.success; + + + - - - PDF_stringwidth - Return width of text - - - &reftitle.description; - - floatPDF_stringwidth - resourcep - stringtext - intfont - floatfontsize - - - Returns the width of text in an arbitrary font. - - - + + + + PDF_stringwidth + Return width of text + + + &reftitle.description; + + floatPDF_stringwidth + resourcep + stringtext + intfont + floatfontsize + + + Returns the width of text in an arbitrary font. + + + - - - PDF_stroke - Stroke path - - - &reftitle.description; - - boolPDF_stroke - resourcep - - - Strokes the path with the current color and line width, and clear it. - &return.success; - - - + + + + PDF_stroke + Stroke path + + + &reftitle.description; + + boolPDF_stroke + resourcep + + + Strokes the path with the current color and line width, and clear it. + &return.success; + + + - - - PDF_suspend_page - Suspend page - - - &reftitle.description; - - boolPDF_suspend_page - resourcepdfdoc - stringoptlist - - - Suspends the current page so that it can later be resumed with - PDF_resume_page. - - - + + + + PDF_suspend_page + Suspend page + + + &reftitle.description; + + boolPDF_suspend_page + resourcepdfdoc + stringoptlist + + + Suspends the current page so that it can later be resumed with + PDF_resume_page. + + + - - - PDF_translate - Set origin of coordinate system - - - &reftitle.description; - - boolPDF_translate - resourcep - floattx - floatty - - - Translates the origin of the coordinate system. - - - + + + + PDF_translate + Set origin of coordinate system + + + &reftitle.description; + + boolPDF_translate + resourcep + floattx + floatty + + + Translates the origin of the coordinate system. + + + - - - PDF_utf16_to_utf8 - Convert string from UTF-16 to UTF-8 - - - &reftitle.description; - - stringPDF_utf16_to_utf8 - resourcepdfdoc - stringutf16string - - - Converts a string from UTF-16 format to UTF-8. - - - + + + + PDF_utf16_to_utf8 + Convert string from UTF-16 to UTF-8 + + + &reftitle.description; + + stringPDF_utf16_to_utf8 + resourcepdfdoc + stringutf16string + + + Converts a string from UTF-16 format to UTF-8. + + + - - - PDF_utf8_to_utf16 - Convert string from UTF-8 to UTF-16 - - - &reftitle.description; - - stringPDF_utf8_to_utf16 - resourcepdfdoc - stringutf8string - stringordering - - - Converts a string from UTF-8 format to UTF-16. - - - + + + + PDF_utf8_to_utf16 + Convert string from UTF-8 to UTF-16 + + + &reftitle.description; + + stringPDF_utf8_to_utf16 + resourcepdfdoc + stringutf8string + stringordering + + + Converts a string from UTF-8 format to UTF-16. + + +