diff --git a/functions/cpdf.xml b/functions/cpdf.xml index 76e2d5cffe..31d6e1fcf6 100644 --- a/functions/cpdf.xml +++ b/functions/cpdf.xml @@ -186,6 +186,521 @@ cpdf_close($pdf); + + + cpdf_add_annotation + Adds annotation + + + Description + + + void cpdf_add_annotation + int pdf document + double llx + double lly + double urx + double ury + string title + string content + int + mode + + + + + The cpdf_add_annotation adds a note with the + lower left corner at (llx, + lly) and the upper right corner at + (urx, ury). + + + The optional parameter mode determines the + unit length. If it's 0 or omitted the default unit as specified + for the page is used. Otherwise the coordinates are measured in + postscript points disregarding the current unit. + + + + + + + cpdf_add_outline + Adds bookmark for current page + + + Description + + + void cpdf_add_outline + int pdf document + string text + + + + The cpdf_add_outline function adds a bookmark + with text text that points to the current page. + + Adding a page outline + +<?php +$cpdf = cpdf_open(0); +cpdf_page_init($cpdf, 1, 0, 595, 842); +cpdf_add_outline($cpdf, 0, 0, 0, 1, "Page 1"); +// ... +// some drawing +// ... +cpdf_finalize($cpdf); +Header("Content-type: application/pdf"); +cpdf_output_buffer($cpdf); +cpdf_close($cpdf); +?> + + + + + + + + + cpdf_arc + Draws an arc + + + Description + + + void cpdf_arc + int pdf document + double x-coor + double y-coor + double radius + double start + double end + int mode + + + + The cpdf_arc function draws an arc with + center at point + (x-coor, y-coor) + and radius radius, starting at angle + start and ending at angle + end. + + + The optional parameter mode determines the unit + length. If it's 0 or omitted the default unit as specified for the page + is used. Otherwise the coordinates are measured in postscript points + disregarding the current unit. + + + See also cpdf_circle. + + + + + + + cpdf_begin_text + Starts text section + + + Description + + + void cpdf_begin_text + int pdf document + + + + The cpdf_begin_text function starts a text + section. It must be ended with cpdf_end_text. + + Text output + +<?php +cpdf_begin_text($pdf); +cpdf_set_font($pdf, 16, "Helvetica", "WinAnsiEncoding"); +cpdf_text($pdf, 100, 100, "Some text"); +cpdf_end_text($pdf) +?> + + + + + See also cpdf_end_text. + + + + + + + cpdf_circle + Draw a circle + + + Description + + + void cpdf_circle + int pdf document + double x-coor + double y-coor + double radius + int mode + + + + The cpdf_circle function draws a circle with + center at point + (x-coor, y-coor) + and radius radius. + + + The optional parameter mode determines the unit + length. If it's 0 or omitted the default unit as specified for the page + is used. Otherwise the coordinates are measured in postscript points + disregarding the current unit. + + + See also cpdf_arc. + + + + + + + cpdf_clip + Clips to current path + + + Description + + + void cpdf_clip + int pdf document + + + + The cpdf_clip function clips all drawing + to the current path. + + + + + + + cpdf_close + Closes the pdf document + + + Description + + + void cpdf_close + int pdf document + + + + The cpdf_close function closes the pdf document. + This should be the last function even after + cpdf_finalize, cpdf_output_buffer + and cpdf_save_to_file. + + + See also cpdf_open. + + + + + + + cpdf_closepath + Close path + + + Description + + + void cpdf_closepath + int pdf document + + + + The cpdf_closepath function closes the + current path. + + + + + + + cpdf_closepath_fill_stroke + Close, fill and stroke current path + + + Description + + + void cpdf_closepath_fill_stroke + int pdf document + + + + The cpdf_closepath_fill_stroke function closes, + fills the interior of the current path with the current fill color and + draws current path. + + + See also cpdf_closepath, + cpdf_stroke, + cpdf_fill, + cpdf_setgray_fill, + cpdf_setgray, + cpdf_setrgbcolor_fill, + cpdf_setrgbcolor. + + + + + + + cpdf_closepath_stroke + Close path and draw line along path + + + Description + + + void cpdf_closepath_stroke + int pdf document + + + + The cpdf_closepath_stroke function is a + combination of cpdf_closepath and + cpdf_stroke. Then clears the path. + + + See also cpdf_closepath, + cpdf_stroke. + + + + + + + cpdf_continue_text + Output text in next line + + + Description + + + void cpdf_continue_text + int pdf document + string text + + + + The cpdf_continue_text function outputs the + string in text in the next line. + + + See also cpdf_show_xy, + cpdf_text, + cpdf_set_leading, + cpdf_set_text_pos. + + + + + + + cpdf_curveto + Draws a curve + + + Description + + + void cpdf_curveto + int pdf document + double x1 + double y1 + double x2 + double y2 + double x3 + double y3 + int mode + + + + The cpdf_curveto function draws a Bezier curve + from the current point to the point + (x3, y3) using + (x1, y1) and + (x2, y2) as control + points. + + + The optional parameter mode determines the unit + length. If it's 0 or omitted the default unit as specified for the page is + used. Otherwise the coordinates are measured in postscript points + disregarding the current unit. + + + See also cpdf_moveto, + cpdf_rmoveto, + cpdf_rlineto, + cpdf_lineto. + + + + + + + cpdf_end_text + Ends text section + + + Description + + + void cpdf_end_text + int pdf document + + + + The cpdf_end_text function ends a text + section which was started with cpdf_begin_text. + + Text output + +<?php +cpdf_begin_text($pdf); +cpdf_set_font($pdf, 16, "Helvetica", "WinAnsiEncoding"); +cpdf_text($pdf, 100, 100, "Some text"); +cpdf_end_text($pdf) +?> + + + + + See also cpdf_begin_text. + + + + + + + cpdf_fill + Fill current path + + + Description + + + void cpdf_fill + int pdf document + + + + The cpdf_fill function fills the interior of + the current path with the current fill color. + + + See also cpdf_closepath, + cpdf_stroke, + cpdf_setgray_fill, + cpdf_setgray, + cpdf_setrgbcolor_fill, + cpdf_setrgbcolor. + + + + + + + cpdf_fill_stroke + Fill and stroke current path + + + Description + + + void cpdf_fill_stroke + int pdf document + + + + The cpdf_fill_stroke function fills the interior of + the current path with the current fill color and draws current path. + + + See also cpdf_closepath, + cpdf_stroke, + cpdf_fill, + cpdf_setgray_fill, + cpdf_setgray, + cpdf_setrgbcolor_fill, + cpdf_setrgbcolor. + + + + + + + cpdf_finalize + Ends document + + + Description + + + void cpdf_finalize + int pdf document + + + + The cpdf_finalize function ends the document. + You still have to call cpdf_close + + + See also cpdf_close. + + + + + + + cpdf_finalize_page + Ends page + + + Description + + + void cpdf_finalize_page + int pdf document + int page number + + + + The cpdf_finalize_page function ends the page + with page number page number. + + + This function is only for saving memory. A finalized page takes + less memory but cannot be modified anymore. + + + See also cpdf_page_init. + + + + cpdf_global_set_document_limits @@ -216,107 +731,143 @@ cpdf_close($pdf); - - + + - cpdf_set_creator - Sets the creator field in the pdf document + cpdf_import_jpeg + Opens a JPEG image Description - void cpdf_set_creator - string creator + int cpdf_import_jpeg + int pdf document + string file name + double x-coor + double y-coor + double angle + double width + double height + double x-scale + double y-scale + int + mode + - The cpdf_set_creator function sets the - creator of a pdf document. + The cpdf_import_jpeg function opens an image + stored in the file with the name file + name. The format of the image has to be jpeg. The + image is placed on the current page at position + (x-coor, y-coor). + The image is rotated by angle degres. - See also cpdf_set_subject, - cpdf_set_title, - cpdf_set_keywords. + The optional parameter mode determines the + unit length. If it's 0 or omitted the default unit as specified + for the page is used. Otherwise the coordinates are measured in + postscript points disregarding the current unit. + + + See also cpdf_place_inline_image. - + - cpdf_set_title - Sets the title field of the pdf document + cpdf_lineto + Draws a line Description - void cpdf_set_title - string title + void cpdf_lineto + int pdf document + double x-coor + double y-coor + int mode - The cpdf_set_title function sets the - title of a pdf document. + The cpdf_lineto function draws a line from + the current point to the point with coordinates + (x-coor, y-coor). - See also cpdf_set_subject, - cpdf_set_creator, - cpdf_set_keywords. + The optional parameter mode determines the unit + length. If it's 0 or omitted the default unit as specified for the page + is used. Otherwise the coordinates are measured in postscript points + disregarding the current unit. + + + See also cpdf_moveto, + cpdf_rmoveto, + cpdf_curveto. - + - cpdf_set_subject - Sets the subject field of the pdf document + cpdf_moveto + Sets current point Description - void cpdf_set_subject - string subject + void cpdf_moveto + int pdf document + double x-coor + double y-coor + int + mode + - The cpdf_set_subject function sets the - subject of a pdf document. + The cpdf_moveto function set the current + point to the coordinates x-coor and + y-coor. - See also cpdf_set_title, - cpdf_set_creator, - cpdf_set_keywords. + The optional parameter mode determines the + unit length. If it's 0 or omitted the default unit as specified + for the page is used. Otherwise the coordinates are measured in + postscript points disregarding the current unit. - + - cpdf_set_keywords - Sets the keywords field of the pdf document + cpdf_newpath + Starts a new path Description - void cpdf_set_keywords - string keywords + void + cpdf_newpath + + int + pdf document + - The cpdf_set_keywords function sets the - keywords of a pdf document. - - - See also cpdf_set_title, - cpdf_set_creator, - cpdf_set_subject. + The cpdf_newpath starts a new path on the + document given by the pdf document + parameter. - + cpdf_open @@ -363,25 +914,25 @@ cpdf_close($pdf); - - + + - cpdf_close - Closes the pdf document + cpdf_output_buffer + Outputs the pdf document in memory buffer Description - void cpdf_close + void cpdf_output_buffer int pdf document - The cpdf_close function closes the pdf document. - This should be the last function even after - cpdf_finalize, cpdf_output_buffer - and cpdf_save_to_file. + The cpdf_output_buffer function outputs + the pdf document to stdout. The document has to be created in memory which + is the case if cpdf_open has been called with + no filename parameter. See also cpdf_open. @@ -426,79 +977,227 @@ cpdf_close($pdf); - - + + - cpdf_finalize_page - Ends page + cpdf_place_inline_image + Places an image on the page Description - void cpdf_finalize_page + void cpdf_place_inline_image int pdf document - int page number + int image + double x-coor + double y-coor + double angle + double width + double height + int + mode + - The cpdf_finalize_page function ends the page - with page number page number. + The cpdf_place_inline_image function places + an image created with the php image functions on the page at + postion (x-coor, + y-coor). The image can be scaled at the + same time. - This function is only for saving memory. A finalized page takes - less memory but cannot be modified anymore. + The optional parameter mode determines the + unit length. If it's 0 or omitted the default unit as specified + for the page is used. Otherwise the coordinates are measured in + postscript points disregarding the current unit. - See also cpdf_page_init. + See also cpdf_import_jpeg. - + - cpdf_finalize - Ends document + cpdf_rect + Draw a rectangle Description - void cpdf_finalize + void cpdf_rect int pdf document + double x-coor + double y-coor + double width + double height + int mode - The cpdf_finalize function ends the document. - You still have to call cpdf_close + The cpdf_rect function draws a rectangle with + its lower left corner at point + (x-coor, y-coor). + This width is set to widgth. + This height is set to height. - See also cpdf_close. + The optional parameter mode determines the unit + length. If it's 0 or omitted the default unit as specified for the page + is used. Otherwise the coordinates are measured in postscript points + disregarding the current unit. - + - cpdf_output_buffer - Outputs the pdf document in memory buffer + cpdf_restore + Restores formerly saved enviroment Description - void cpdf_output_buffer + void cpdf_restore int pdf document - The cpdf_output_buffer function outputs - the pdf document to stdout. The document has to be created in memory which - is the case if cpdf_open has been called with - no filename parameter. + The cpdf_restore function restores the + enviroment saved with cpdf_save. It works + like the postscript command grestore. Very useful if you want + to translate or rotate an object without effecting other objects. + + Save/Restore + +<?php +cpdf_save($pdf); +// do all kinds of rotations, transformations, ... +cpdf_restore($pdf) +?> + + - See also cpdf_open. + See also cpdf_save. + + + + + + + cpdf_rlineto + Draws a line + + + Description + + + void cpdf_rlineto + int pdf document + double x-coor + double y-coor + int mode + + + + The cpdf_rlineto function draws a line from + the current point to the relative point with coordinates + (x-coor, y-coor). + + + The optional parameter mode determines the unit + length. If it's 0 or omitted the default unit as specified for the page + is used. Otherwise the coordinates are measured in postscript points + disregarding the current unit. + + + See also cpdf_moveto, + cpdf_rmoveto, + cpdf_curveto. + + + + + + + cpdf_rmoveto + Sets current point + + + Description + + + void cpdf_rmoveto + int pdf document + double x-coor + double y-coor + int mode + + + + The cpdf_rmoveto function set the current point + relative to the coordinates x-coor and + y-coor. + + + The optional parameter mode determines the unit + length. If it's 0 or omitted the default unit as specified for the page is + used. Otherwise the coordinates are measured in postscript points + disregarding the current unit. + + + See also cpdf_moveto. + + + + + + + cpdf_rotate + Sets rotation + + + Description + + + void cpdf_rotate + int pdf document + double angle + + + + The cpdf_rotate function set the rotation in + degress to angle. + + + + + + + cpdf_save + Saves current enviroment + + + Description + + + void cpdf_save + int pdf document + + + + The cpdf_save function saves the current + enviroment. It works like the postscript command gsave. Very + useful if you want to translate or rotate an object without effecting + other objects. + + + See also cpdf_restore. @@ -532,6 +1231,78 @@ cpdf_close($pdf); + + + cpdf_scale + Sets scaling + + + Description + + + void cpdf_scale + int pdf document + double x-scale + double y-scale + + + + The cpdf_scale function set the scaling factor + in both directions. + + + + + + + cpdf_set_char_spacing + Sets character spacing + + + Description + + + void cpdf_set_char_spacing + int pdf document + double space + + + + The cpdf_set_char_spacing function sets the + spacing between characters. + + + See also cpdf_set_word_spacing, + cpdf_set_leading. + + + + + + + cpdf_set_creator + Sets the creator field in the pdf document + + + Description + + + void cpdf_set_creator + string creator + + + + The cpdf_set_creator function sets the + creator of a pdf document. + + + See also cpdf_set_subject, + cpdf_set_title, + cpdf_set_keywords. + + + + cpdf_set_current_page @@ -557,70 +1328,622 @@ cpdf_close($pdf); - + - cpdf_begin_text - Starts text section + cpdf_set_font + Select the current font face and size Description - void cpdf_begin_text + void cpdf_set_font int pdf document + string font name + double size + string encoding - The cpdf_begin_text function starts a text - section. It must be ended with cpdf_end_text. - - Text output - -<?php -cpdf_begin_text($pdf); -cpdf_set_font($pdf, 16, "Helvetica", "WinAnsiEncoding"); -cpdf_text($pdf, 100, 100, "Some text"); -cpdf_end_text($pdf) -?> - - + The cpdf_set_font function sets the + current font face, font size and encoding. Currently only + the standard postscript fonts are supported. - See also cpdf_end_text. + The last parameter encoding can take the + following values: "MacRomanEncoding", "MacExpertEncoding", + "WinAnsiEncoding", and "NULL". "NULL" stands for the font's + built-in encoding. + + + See the ClibPDF Manual for more information, especially how to support + asian fonts. + + + + + + + cpdf_set_horiz_scaling + Sets horizontal scaling of text + + + Description + + + void cpdf_set_horiz_scaling + int pdf document + double scale + + + + The cpdf_set_horiz_scaling function sets the + horizontal scaling to scale percent. - + - cpdf_end_text - Ends text section + cpdf_set_keywords + Sets the keywords field of the pdf document Description - void cpdf_end_text - int pdf document + void cpdf_set_keywords + string keywords - The cpdf_end_text function ends a text - section which was started with cpdf_begin_text. - - Text output - -<?php -cpdf_begin_text($pdf); -cpdf_set_font($pdf, 16, "Helvetica", "WinAnsiEncoding"); -cpdf_text($pdf, 100, 100, "Some text"); -cpdf_end_text($pdf) -?> - - + The cpdf_set_keywords function sets the + keywords of a pdf document. - See also cpdf_begin_text. + See also cpdf_set_title, + cpdf_set_creator, + cpdf_set_subject. + + + + + + + cpdf_set_leading + Sets distance between text lines + + + Description + + + void cpdf_set leading + int pdf document + double distance + + + + The cpdf_set_leading function sets the distance + between text lines. This will be used if text is output by + cpdf_continue_text. + + + See also cpdf_continue_text. + + + + + + + cpdf_set_page_animation + Sets duration between pages + + + Description + + + void cpdf_set_page_animation + int pdf document + int transition + double duration + + + + The cpdf_set_page_animation function set the + transition between following pages. + + + The value of transition + can be + + 0 for none, + + 1 for two lines sweeping across the screen reveal the page, + + + 2 for multiple lines sweeping across the screen reveal the page, + + 3 for a box reveals the page, + + 4 for a single line sweeping across the screen reveals the page, + + 5 for the old page dissolves to reveal the page, + + 6 for the dissolve effect moves from one screen edge to another, + + + 7 for the old page is simply replaced by the new page (default) + + + + + The value of duration is the number of seconds + between page flipping. + + + + + + + cpdf_set_subject + Sets the subject field of the pdf document + + + Description + + + void cpdf_set_subject + string subject + + + + The cpdf_set_subject function sets the + subject of a pdf document. + + + See also cpdf_set_title, + cpdf_set_creator, + cpdf_set_keywords. + + + + + + + cpdf_set_text_matrix + Sets the text matrix + + + Description + + + void cpdf_set_text_matrix + int pdf document + array matrix + + + + The cpdf_set_text_matrix function sets + a matrix which describes a transformation applied on the current + text font. + + + + + + + cpdf_set_text_pos + Sets text position + + + Description + + + void cpdf_set_text_pos + int pdf document + double x-coor + double y-coor + int mode + + + + The cpdf_set_text_pos function sets the + position of text for the next cpdf_show + function call. + + + The optional parameter mode determines the unit + length. If it's 0 or omitted the default unit as specified for the page is + used. Otherwise the coordinates are measured in postscript points + disregarding the current unit. + + + See also cpdf_show, + cpdf_text. + + + + + + + cpdf_set_text_rendering + Determines how text is rendered + + + Description + + + void cpdf_set_text_rendering + int pdf document + int mode + + + + The cpdf_set_text_rendering function + determines how text is rendered. + + + The possible values for mode are 0=fill + text, 1=stroke text, 2=fill and stroke text, 3=invisible, 4=fill + text and add it to clipping path, 5=stroke text and add it to + clipping path, 6=fill and stroke text and add it to clipping + path, 7=add it to clipping path. + + + + + + + cpdf_set_text_rise + Sets the text rise + + + Description + + + void cpdf_set_text_rise + int pdf document + double value + + + + The cpdf_set_text_rise function sets the + text rising to value units. + + + + + + + cpdf_set_title + Sets the title field of the pdf document + + + Description + + + void cpdf_set_title + string title + + + + The cpdf_set_title function sets the + title of a pdf document. + + + See also cpdf_set_subject, + cpdf_set_creator, + cpdf_set_keywords. + + + + + + + cpdf_set_word_spacing + Sets spacing between words + + + Description + + + void cpdf_set_word_spacing + int pdf document + double space + + + + The cpdf_set_word_spacing function sets the + spacing between words. + + + See also cpdf_set_char_spacing, + cpdf_set_leading. + + + + + + + cpdf_setflat + Sets flatness + + + Description + + + void cpdf_setflat + int pdf document + double value + + + + The cpdf_setflat function set the flatness to + a value between 0 and 100. + + + + + + + cpdf_setdash + Sets dash pattern + + + Description + + + void cpdf_setdash + int pdf document + double white + double black + + + + The cpdf_setdash function set the dash + pattern white white units and + black black units. If both are 0 a solid + line is set. + + + + + + + cpdf_setgray + Sets drawing and filling color to gray value + + + Description + + + void cpdf_setgray + int pdf document + double gray value + + + + The cpdf_setgray_stroke function sets the current + drawing and filling color to the given gray value. + + + See also cpdf_setrgbcolor_stroke, + cpdf_setrgbcolor_fill. + + + + + + + cpdf_setgray_fill + Sets filling color to gray value + + + Description + + + void cpdf_setgray_fill + int pdf document + double value + + + + The cpdf_setgray_fill function sets the current + gray value to fill a path. + + + See also cpdf_setrgbcolor_fill. + + + + + + + cpdf_setgray_stroke + Sets drawing color to gray value + + + Description + + + void cpdf_setgray_stroke + int pdf document + double gray value + + + + The cpdf_setgray_stroke function sets the current + drawing color to the given gray value. + + + See also cpdf_setrgbcolor_stroke. + + + + + + + cpdf_setlinecap + Sets linecap parameter + + + Description + + + void cpdf_setlinecap + int pdf document + int value + + + + The cpdf_setlinecap function set the linecap + parameter between a value of 0 and 2. 0 = butt end, 1 = round, + 2 = projecting square. + + + + + + + cpdf_setlinejoin + Sets linejoin parameter + + + Description + + + void cpdf_setlinejoin + int pdf document + long value + + + + The cpdf_setlinejoin function set the + linejoin parameter between a value of 0 and 2. 0 = miter, 1 = + round, 2 = bevel. + + + + + + + cpdf_setlinewidth + Sets line width + + + Description + + + void cpdf_setlinewidth + int pdf document + double width + + + + The cpdf_setlinewidth function set the line + width to width. + + + + + + + cpdf_setmiterlimit + Sets miter limit + + + Description + + + void cpdf_setmiterlimit + int pdf document + double value + + + + The cpdf_setmiterlimit function set the + miter limit to a value greater or equal than 1. + + + + + + + cpdf_setrgbcolor + Sets drawing and filling color to rgb color value + + + Description + + + void cpdf_setrgbcolor + int pdf document + double red value + double green value + double blue value + + + + The cpdf_setrgbcolor_stroke function sets the current + drawing and filling color to the given rgb color value. + + + See also cpdf_setrgbcolor_stroke, + cpdf_setrgbcolor_fill. + + + + + + + cpdf_setrgbcolor_fill + Sets filling color to rgb color value + + + Description + + + void cpdf_setrgbcolor_fill + int pdf document + double red value + double green value + double blue value + + + + The cpdf_setrgbcolor_fill function sets the current + rgb color value to fill a path. + + + See also cpdf_setrgbcolor_stroke, + cpdf_setrgbcolor. + + + + + + + cpdf_setrgbcolor_stroke + Sets drawing color to rgb color value + + + Description + + + void cpdf_setrgbcolor_stroke + int pdf document + double red value + double green value + double blue value + + + + The cpdf_setrgbcolor_stroke function sets the current + drawing color to the given rgb color value. + + + See also cpdf_setrgbcolor_fill, + cpdf_setrgbcolor. @@ -691,6 +2014,55 @@ cpdf_end_text($pdf) + + + cpdf_stringwidth + Returns width of text in current font + + + Description + + + double cpdf_stringwidth + int pdf document + string text + + + + The cpdf_stringwidth function returns the + width of the string in text. It requires + a font to be set before. + + + See also cpdf_set_font. + + + + + + + cpdf_stroke + Draw line along path + + + Description + + + void cpdf_stroke + int pdf document + + + + The cpdf_stroke function draws a line along + current path. + + + See also cpdf_closepath, + cpdf_closepath_stroke. + + + + cpdf_text @@ -738,353 +2110,6 @@ cpdf_end_text($pdf) - - - cpdf_set_font - Select the current font face and size - - - Description - - - void cpdf_set_font - int pdf document - string font name - double size - string encoding - - - - The cpdf_set_font function sets the - current font face, font size and encoding. Currently only - the standard postscript fonts are supported. - - - The last parameter encoding can take the - following values: "MacRomanEncoding", "MacExpertEncoding", - "WinAnsiEncoding", and "NULL". "NULL" stands for the font's - built-in encoding. - - - See the ClibPDF Manual for more information, especially how to support - asian fonts. - - - - - - - cpdf_set_leading - Sets distance between text lines - - - Description - - - void cpdf_set leading - int pdf document - double distance - - - - The cpdf_set_leading function sets the distance - between text lines. This will be used if text is output by - cpdf_continue_text. - - - See also cpdf_continue_text. - - - - - - - cpdf_set_text_rendering - Determines how text is rendered - - - Description - - - void cpdf_set_text_rendering - int pdf document - int mode - - - - The cpdf_set_text_rendering function - determines how text is rendered. - - - The possible values for mode are 0=fill - text, 1=stroke text, 2=fill and stroke text, 3=invisible, 4=fill - text and add it to clipping path, 5=stroke text and add it to - clipping path, 6=fill and stroke text and add it to clipping - path, 7=add it to clipping path. - - - - - - - cpdf_set_horiz_scaling - Sets horizontal scaling of text - - - Description - - - void cpdf_set_horiz_scaling - int pdf document - double scale - - - - The cpdf_set_horiz_scaling function sets the - horizontal scaling to scale percent. - - - - - - - cpdf_set_text_rise - Sets the text rise - - - Description - - - void cpdf_set_text_rise - int pdf document - double value - - - - The cpdf_set_text_rise function sets the - text rising to value units. - - - - - - - cpdf_set_text_matrix - Sets the text matrix - - - Description - - - void cpdf_set_text_matrix - int pdf document - array matrix - - - - The cpdf_set_text_matrix function sets - a matrix which describes a transformation applied on the current - text font. - - - - - - - cpdf_set_text_pos - Sets text position - - - Description - - - void cpdf_set_text_pos - int pdf document - double x-coor - double y-coor - int mode - - - - The cpdf_set_text_pos function sets the - position of text for the next cpdf_show - function call. - - - The optional parameter mode determines the unit - length. If it's 0 or omitted the default unit as specified for the page is - used. Otherwise the coordinates are measured in postscript points - disregarding the current unit. - - - See also cpdf_show, - cpdf_text. - - - - - - - cpdf_set_char_spacing - Sets character spacing - - - Description - - - void cpdf_set_char_spacing - int pdf document - double space - - - - The cpdf_set_char_spacing function sets the - spacing between characters. - - - See also cpdf_set_word_spacing, - cpdf_set_leading. - - - - - - - cpdf_set_word_spacing - Sets spacing between words - - - Description - - - void cpdf_set_word_spacing - int pdf document - double space - - - - The cpdf_set_word_spacing function sets the - spacing between words. - - - See also cpdf_set_char_spacing, - cpdf_set_leading. - - - - - - - cpdf_continue_text - Output text in next line - - - Description - - - void cpdf_continue_text - int pdf document - string text - - - - The cpdf_continue_text function outputs the - string in text in the next line. - - - See also cpdf_show_xy, - cpdf_text, - cpdf_set_leading, - cpdf_set_text_pos. - - - - - - - cpdf_stringwidth - Returns width of text in current font - - - Description - - - double cpdf_stringwidth - int pdf document - string text - - - - The cpdf_stringwidth function returns the - width of the string in text. It requires - a font to be set before. - - - See also cpdf_set_font. - - - - - - - cpdf_save - Saves current enviroment - - - Description - - - void cpdf_save - int pdf document - - - - The cpdf_save function saves the current - enviroment. It works like the postscript command gsave. Very - useful if you want to translate or rotate an object without effecting - other objects. - - - See also cpdf_restore. - - - - - - - cpdf_restore - Restores formerly saved enviroment - - - Description - - - void cpdf_restore - int pdf document - - - - The cpdf_restore function restores the - enviroment saved with cpdf_save. It works - like the postscript command grestore. Very useful if you want - to translate or rotate an object without effecting other objects. - - Save/Restore - -<?php -cpdf_save($pdf); -// do all kinds of rotations, transformations, ... -cpdf_restore($pdf) -?> - - - - - See also cpdf_save. - - - - cpdf_translate @@ -1115,1031 +2140,6 @@ cpdf_restore($pdf) - - - cpdf_scale - Sets scaling - - - Description - - - void cpdf_scale - int pdf document - double x-scale - double y-scale - - - - The cpdf_scale function set the scaling factor - in both directions. - - - - - - - cpdf_rotate - Sets rotation - - - Description - - - void cpdf_rotate - int pdf document - double angle - - - - The cpdf_rotate function set the rotation in - degress to angle. - - - - - - - cpdf_setflat - Sets flatness - - - Description - - - void cpdf_setflat - int pdf document - double value - - - - The cpdf_setflat function set the flatness to - a value between 0 and 100. - - - - - - - cpdf_setlinejoin - Sets linejoin parameter - - - Description - - - void cpdf_setlinejoin - int pdf document - long value - - - - The cpdf_setlinejoin function set the - linejoin parameter between a value of 0 and 2. 0 = miter, 1 = - round, 2 = bevel. - - - - - - - cpdf_setlinecap - Sets linecap parameter - - - Description - - - void cpdf_setlinecap - int pdf document - int value - - - - The cpdf_setlinecap function set the linecap - parameter between a value of 0 and 2. 0 = butt end, 1 = round, - 2 = projecting square. - - - - - - - cpdf_setmiterlimit - Sets miter limit - - - Description - - - void cpdf_setmiterlimit - int pdf document - double value - - - - The cpdf_setmiterlimit function set the - miter limit to a value greater or equal than 1. - - - - - - - cpdf_setlinewidth - Sets line width - - - Description - - - void cpdf_setlinewidth - int pdf document - double width - - - - The cpdf_setlinewidth function set the line - width to width. - - - - - - - cpdf_setdash - Sets dash pattern - - - Description - - - void cpdf_setdash - int pdf document - double white - double black - - - - The cpdf_setdash function set the dash - pattern white white units and - black black units. If both are 0 a solid - line is set. - - - - - - - cpdf_newpath - Starts a new path - - - Description - - - void - cpdf_newpath - - int - pdf document - - - - - The cpdf_newpath starts a new path on the - document given by the pdf document - parameter. - - - - - - - cpdf_moveto - Sets current point - - - Description - - - void cpdf_moveto - int pdf document - double x-coor - double y-coor - int - mode - - - - - The cpdf_moveto function set the current - point to the coordinates x-coor and - y-coor. - - - The optional parameter mode determines the - unit length. If it's 0 or omitted the default unit as specified - for the page is used. Otherwise the coordinates are measured in - postscript points disregarding the current unit. - - - - - - - cpdf_rmoveto - Sets current point - - - Description - - - void cpdf_rmoveto - int pdf document - double x-coor - double y-coor - int mode - - - - The cpdf_rmoveto function set the current point - relative to the coordinates x-coor and - y-coor. - - - The optional parameter mode determines the unit - length. If it's 0 or omitted the default unit as specified for the page is - used. Otherwise the coordinates are measured in postscript points - disregarding the current unit. - - - See also cpdf_moveto. - - - - - - - cpdf_curveto - Draws a curve - - - Description - - - void cpdf_curveto - int pdf document - double x1 - double y1 - double x2 - double y2 - double x3 - double y3 - int mode - - - - The cpdf_curveto function draws a Bezier curve - from the current point to the point - (x3, y3) using - (x1, y1) and - (x2, y2) as control - points. - - - The optional parameter mode determines the unit - length. If it's 0 or omitted the default unit as specified for the page is - used. Otherwise the coordinates are measured in postscript points - disregarding the current unit. - - - See also cpdf_moveto, - cpdf_rmoveto, - cpdf_rlineto, - cpdf_lineto. - - - - - - - cpdf_lineto - Draws a line - - - Description - - - void cpdf_lineto - int pdf document - double x-coor - double y-coor - int mode - - - - The cpdf_lineto function draws a line from - the current point to the point with coordinates - (x-coor, y-coor). - - - The optional parameter mode determines the unit - length. If it's 0 or omitted the default unit as specified for the page - is used. Otherwise the coordinates are measured in postscript points - disregarding the current unit. - - - See also cpdf_moveto, - cpdf_rmoveto, - cpdf_curveto. - - - - - - - cpdf_rlineto - Draws a line - - - Description - - - void cpdf_rlineto - int pdf document - double x-coor - double y-coor - int mode - - - - The cpdf_rlineto function draws a line from - the current point to the relative point with coordinates - (x-coor, y-coor). - - - The optional parameter mode determines the unit - length. If it's 0 or omitted the default unit as specified for the page - is used. Otherwise the coordinates are measured in postscript points - disregarding the current unit. - - - See also cpdf_moveto, - cpdf_rmoveto, - cpdf_curveto. - - - - - - - cpdf_circle - Draw a circle - - - Description - - - void cpdf_circle - int pdf document - double x-coor - double y-coor - double radius - int mode - - - - The cpdf_circle function draws a circle with - center at point - (x-coor, y-coor) - and radius radius. - - - The optional parameter mode determines the unit - length. If it's 0 or omitted the default unit as specified for the page - is used. Otherwise the coordinates are measured in postscript points - disregarding the current unit. - - - See also cpdf_arc. - - - - - - - cpdf_arc - Draws an arc - - - Description - - - void cpdf_arc - int pdf document - double x-coor - double y-coor - double radius - double start - double end - int mode - - - - The cpdf_arc function draws an arc with - center at point - (x-coor, y-coor) - and radius radius, starting at angle - start and ending at angle - end. - - - The optional parameter mode determines the unit - length. If it's 0 or omitted the default unit as specified for the page - is used. Otherwise the coordinates are measured in postscript points - disregarding the current unit. - - - See also cpdf_circle. - - - - - - - cpdf_rect - Draw a rectangle - - - Description - - - void cpdf_rect - int pdf document - double x-coor - double y-coor - double width - double height - int mode - - - - The cpdf_rect function draws a rectangle with - its lower left corner at point - (x-coor, y-coor). - This width is set to widgth. - This height is set to height. - - - The optional parameter mode determines the unit - length. If it's 0 or omitted the default unit as specified for the page - is used. Otherwise the coordinates are measured in postscript points - disregarding the current unit. - - - - - - - cpdf_closepath - Close path - - - Description - - - void cpdf_closepath - int pdf document - - - - The cpdf_closepath function closes the - current path. - - - - - - - cpdf_stroke - Draw line along path - - - Description - - - void cpdf_stroke - int pdf document - - - - The cpdf_stroke function draws a line along - current path. - - - See also cpdf_closepath, - cpdf_closepath_stroke. - - - - - - - cpdf_closepath_stroke - Close path and draw line along path - - - Description - - - void cpdf_closepath_stroke - int pdf document - - - - The cpdf_closepath_stroke function is a - combination of cpdf_closepath and - cpdf_stroke. Then clears the path. - - - See also cpdf_closepath, - cpdf_stroke. - - - - - - - cpdf_fill - Fill current path - - - Description - - - void cpdf_fill - int pdf document - - - - The cpdf_fill function fills the interior of - the current path with the current fill color. - - - See also cpdf_closepath, - cpdf_stroke, - cpdf_setgray_fill, - cpdf_setgray, - cpdf_setrgbcolor_fill, - cpdf_setrgbcolor. - - - - - - - cpdf_fill_stroke - Fill and stroke current path - - - Description - - - void cpdf_fill_stroke - int pdf document - - - - The cpdf_fill_stroke function fills the interior of - the current path with the current fill color and draws current path. - - - See also cpdf_closepath, - cpdf_stroke, - cpdf_fill, - cpdf_setgray_fill, - cpdf_setgray, - cpdf_setrgbcolor_fill, - cpdf_setrgbcolor. - - - - - - - cpdf_closepath_fill_stroke - Close, fill and stroke current path - - - Description - - - void cpdf_closepath_fill_stroke - int pdf document - - - - The cpdf_closepath_fill_stroke function closes, - fills the interior of the current path with the current fill color and - draws current path. - - - See also cpdf_closepath, - cpdf_stroke, - cpdf_fill, - cpdf_setgray_fill, - cpdf_setgray, - cpdf_setrgbcolor_fill, - cpdf_setrgbcolor. - - - - - - - cpdf_clip - Clips to current path - - - Description - - - void cpdf_clip - int pdf document - - - - The cpdf_clip function clips all drawing - to the current path. - - - - - - - cpdf_setgray_fill - Sets filling color to gray value - - - Description - - - void cpdf_setgray_fill - int pdf document - double value - - - - The cpdf_setgray_fill function sets the current - gray value to fill a path. - - - See also cpdf_setrgbcolor_fill. - - - - - - - cpdf_setgray_stroke - Sets drawing color to gray value - - - Description - - - void cpdf_setgray_stroke - int pdf document - double gray value - - - - The cpdf_setgray_stroke function sets the current - drawing color to the given gray value. - - - See also cpdf_setrgbcolor_stroke. - - - - - - - cpdf_setgray - Sets drawing and filling color to gray value - - - Description - - - void cpdf_setgray - int pdf document - double gray value - - - - The cpdf_setgray_stroke function sets the current - drawing and filling color to the given gray value. - - - See also cpdf_setrgbcolor_stroke, - cpdf_setrgbcolor_fill. - - - - - - - cpdf_setrgbcolor_fill - Sets filling color to rgb color value - - - Description - - - void cpdf_setrgbcolor_fill - int pdf document - double red value - double green value - double blue value - - - - The cpdf_setrgbcolor_fill function sets the current - rgb color value to fill a path. - - - See also cpdf_setrgbcolor_stroke, - cpdf_setrgbcolor. - - - - - - - cpdf_setrgbcolor_stroke - Sets drawing color to rgb color value - - - Description - - - void cpdf_setrgbcolor_stroke - int pdf document - double red value - double green value - double blue value - - - - The cpdf_setrgbcolor_stroke function sets the current - drawing color to the given rgb color value. - - - See also cpdf_setrgbcolor_fill, - cpdf_setrgbcolor. - - - - - - - cpdf_setrgbcolor - Sets drawing and filling color to rgb color value - - - Description - - - void cpdf_setrgbcolor - int pdf document - double red value - double green value - double blue value - - - - The cpdf_setrgbcolor_stroke function sets the current - drawing and filling color to the given rgb color value. - - - See also cpdf_setrgbcolor_stroke, - cpdf_setrgbcolor_fill. - - - - - - - cpdf_add_outline - Adds bookmark for current page - - - Description - - - void cpdf_add_outline - int pdf document - string text - - - - The cpdf_add_outline function adds a bookmark - with text text that points to the current page. - - Adding a page outline - -<?php -$cpdf = cpdf_open(0); -cpdf_page_init($cpdf, 1, 0, 595, 842); -cpdf_add_outline($cpdf, 0, 0, 0, 1, "Page 1"); -// ... -// some drawing -// ... -cpdf_finalize($cpdf); -Header("Content-type: application/pdf"); -cpdf_output_buffer($cpdf); -cpdf_close($cpdf); -?> - - - - - - - - - cpdf_set_page_animation - Sets duration between pages - - - Description - - - void cpdf_set_page_animation - int pdf document - int transition - double duration - - - - The cpdf_set_page_animation function set the - transition between following pages. - - - The value of transition - can be - - 0 for none, - - 1 for two lines sweeping across the screen reveal the page, - - - 2 for multiple lines sweeping across the screen reveal the page, - - 3 for a box reveals the page, - - 4 for a single line sweeping across the screen reveals the page, - - 5 for the old page dissolves to reveal the page, - - 6 for the dissolve effect moves from one screen edge to another, - - - 7 for the old page is simply replaced by the new page (default) - - - - - The value of duration is the number of seconds - between page flipping. - - - - - - - cpdf_import_jpeg - Opens a JPEG image - - - Description - - - int cpdf_import_jpeg - int pdf document - string file name - double x-coor - double y-coor - double angle - double width - double height - double x-scale - double y-scale - int - mode - - - - - The cpdf_import_jpeg function opens an image - stored in the file with the name file - name. The format of the image has to be jpeg. The - image is placed on the current page at position - (x-coor, y-coor). - The image is rotated by angle degres. - - - The optional parameter mode determines the - unit length. If it's 0 or omitted the default unit as specified - for the page is used. Otherwise the coordinates are measured in - postscript points disregarding the current unit. - - - See also cpdf_place_inline_image. - - - - - - - cpdf_place_inline_image - Places an image on the page - - - Description - - - void cpdf_place_inline_image - int pdf document - int image - double x-coor - double y-coor - double angle - double width - double height - int - mode - - - - - The cpdf_place_inline_image function places - an image created with the php image functions on the page at - postion (x-coor, - y-coor). The image can be scaled at the - same time. - - - The optional parameter mode determines the - unit length. If it's 0 or omitted the default unit as specified - for the page is used. Otherwise the coordinates are measured in - postscript points disregarding the current unit. - - - See also cpdf_import_jpeg. - - - - - - - cpdf_add_annotation - Adds annotation - - - Description - - - void cpdf_add_annotation - int pdf document - double llx - double lly - double urx - double ury - string title - string content - int - mode - - - - - The cpdf_add_annotation adds a note with the - lower left corner at (llx, - lly) and the upper right corner at - (urx, ury). - - - The optional parameter mode determines the - unit length. If it's 0 or omitted the default unit as specified - for the page is used. Otherwise the coordinates are measured in - postscript points disregarding the current unit. - - - -