From 398e813e3d7056ac288013a7c7eec7631df653c9 Mon Sep 17 00:00:00 2001 From: Martin Samesch Date: Tue, 29 Aug 2000 18:02:22 +0000 Subject: [PATCH] some more re-indenting,.... git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@31493 c90b9560-bf6c-de11-be94-00142212c4b1 --- functions/cpdf.xml | 483 +++++++++++++++++++++++---------------------- 1 file changed, 246 insertions(+), 237 deletions(-) diff --git a/functions/cpdf.xml b/functions/cpdf.xml index 388b1112b8..adfbf57bba 100644 --- a/functions/cpdf.xml +++ b/functions/cpdf.xml @@ -666,10 +666,10 @@ cpdf_end_text($pdf) (x-coor, y-coor). - The last optional parameter determines the unit length. If is 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. + 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. The function cpdf_show_xy is identical to @@ -711,13 +711,14 @@ cpdf_end_text($pdf) text at position with coordinates (x-coor, y-coor). - orientation is the rotation - of the text in degree. The optional parameter - alignmode determines how the text is align. + + 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. The optional parameter + orientation is the rotation of the text in degree. + The optional parameter alignmode determines how the + text is align. See the ClibPDF documentation for possible values. @@ -900,10 +901,10 @@ cpdf_end_text($pdf) function call. - The last optional parameter mode determines - the unit length. If is 0 or omitted the default unit as specified - for the page is used. Otherwise the coodinates are measured in - postscript points disregarding the current unit. + 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, @@ -1096,10 +1097,10 @@ cpdf_restore($pdf) y-coor). - The last optional parameter determines the unit length. If is 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. + 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. @@ -1121,8 +1122,8 @@ cpdf_restore($pdf) The cpdf_scale function set the scaling factor - in both directions. - + in both directions. + @@ -1142,8 +1143,8 @@ cpdf_restore($pdf) The cpdf_rotate function set the rotation in - degress to angle. - + degress to angle. + @@ -1163,8 +1164,8 @@ cpdf_restore($pdf) The cpdf_setflat function set the flatness to - a value between 0 and 100. - + a value between 0 and 100. + @@ -1184,8 +1185,8 @@ cpdf_restore($pdf) The cpdf_setlinejoin function set the linejoin - parameter between a value of 0 and 2. 0 = miter, 1 = round, 2 = bevel. - + parameter between a value of 0 and 2. 0 = miter, 1 = round, 2 = bevel. + @@ -1206,8 +1207,8 @@ cpdf_restore($pdf) The cpdf_setlinecap function set the linecap parameter between a value of 0 and 2. 0 = butt end, 1 = round, - 2 = projecting square. - + 2 = projecting square. + @@ -1227,8 +1228,8 @@ cpdf_restore($pdf) The cpdf_setmiterlimit function set the miter limit - to a value greater or equal than 1. - + to a value greater or equal than 1. + @@ -1248,8 +1249,8 @@ cpdf_restore($pdf) The cpdf_setlinewidth function set the line width - to width. - + to width. + @@ -1271,35 +1272,33 @@ cpdf_restore($pdf) The cpdf_setdash function set the dash pattern white white units and black - black units. If both are 0 a solid line is set. - + black units. If both are 0 a solid line is set. + - - cpdf_newpath - - Starts a new path - - - - Description - + + cpdf_newpath + Starts a new path + + + Description + - void - cpdf_newpath - - int - pdf_document - + void + cpdf_newpath + + int + pdf_document + - - - The cpdf_newpath starts a new path on the document - given by the pdf_document parameter. - - + + + The cpdf_newpath starts a new path on the document + given by the pdf_document parameter. + + @@ -1313,21 +1312,22 @@ cpdf_restore($pdf) void cpdf_moveto int pdf document - double x-koor - double y-koor - int mode + double x-coor + double y-coor + int mode The cpdf_moveto function set the current point - to the coordinates x-koor and - y-koor. - + to the coordinates x-coor and + y-coor. + - The last optional parameter determines the unit length. If is 0 or omitted - the default unit as specified for the page is used. Otherwise the koodinates - are measured in postscript points disregarding the current unit. - + 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. + @@ -1342,23 +1342,25 @@ cpdf_restore($pdf) void cpdf_rmoveto int pdf document - double x-koor - double y-koor - int mode + double x-coor + double y-coor + int mode The cpdf_rmoveto function set the current point - relative to the coordinates x-koor and - y-koor. - + relative to the coordinates x-coor and + y-coor. + - The last optional parameter determines the unit length. If is 0 or omitted - the default unit as specified for the page is used. Otherwise the koodinates - are measured in postscript points disregarding the current unit. - + 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. + See also cpdf_moveto. + @@ -1379,7 +1381,7 @@ cpdf_restore($pdf) double y2 double x3 double y3 - int mode + int mode @@ -1388,19 +1390,20 @@ cpdf_restore($pdf) (x3, y3) using (x1, y1) and (x2, y2) as control - points. - + points. + - The last optional parameter determines the unit length. If is 0 or omitted - the default unit as specified for the page is used. Otherwise the koodinates - are measured in postscript points disregarding the current unit. - + 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. + @@ -1415,26 +1418,27 @@ cpdf_restore($pdf) void cpdf_lineto int pdf document - double x-koor - double y-koor - int mode + 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-koor, y-koor). - + (x-coor, y-coor). + - The last optional parameter determines the unit length. If is 0 or omitted - the default unit as specified for the page is used. Otherwise the koodinates - are measured in postscript points disregarding the current unit. - + 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_curveto. + @@ -1449,26 +1453,27 @@ cpdf_restore($pdf) void cpdf_rlineto int pdf document - double x-koor - double y-koor - int mode + 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-koor, y-koor). - + (x-coor, y-coor). + - The last optional parameter determines the unit length. If is 0 or omitted - the default unit as specified for the page is used. Otherwise the koodinates - are measured in postscript points disregarding the current unit. - + 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_curveto. + @@ -1483,26 +1488,27 @@ cpdf_restore($pdf) void cpdf_circle int pdf document - double x-koor - double y-koor + double x-coor + double y-coor double radius - int mode + int mode The cpdf_circle function draws a circle with center at point - (x-koor, y-koor) - and radius radius. - + (x-coor, y-coor) + and radius radius. + - The last optional parameter determines the unit length. If is 0 or omitted - the default unit as specified for the page is used. Otherwise the koodinates - are measured in postscript points disregarding the current unit. - + 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. - + See also cpdf_arc. + @@ -1517,30 +1523,31 @@ cpdf_restore($pdf) void cpdf_arc int pdf document - double x-koor - double y-koor + double x-coor + double y-coor double radius double start double end - int mode + int mode The cpdf_arc function draws an arc with center at point - (x-koor, y-koor) + (x-coor, y-coor) and radius radius, starting at angle start and ending at angle - end. - + end. + - The last optional parameter determines the unit length. If is 0 or omitted - the default unit as specified for the page is used. Otherwise the koodinates - are measured in postscript points disregarding the current unit. - + 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. - + See also cpdf_circle. + @@ -1555,25 +1562,26 @@ cpdf_restore($pdf) void cpdf_rect int pdf document - double x-koor - double y-koor + double x-coor + double y-coor double width double height - int mode + int mode The cpdf_rect function draws a rectangle with its lower left corner at point - (x-koor, y-koor). + (x-coor, y-coor). This width is set to widgth. - This height is set to height. - + This height is set to height. + - The last optional parameter determines the unit length. If is 0 or omitted - the default unit as specified for the page is used. Otherwise the koodinates - are measured in postscript points disregarding the current unit. - + 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. + @@ -1592,8 +1600,8 @@ cpdf_restore($pdf) The cpdf_closepath function closes the - current path. - + current path. + @@ -1612,12 +1620,12 @@ cpdf_restore($pdf) The cpdf_stroke function draws a line along - current path. - + current path. + See also cpdf_closepath, - cpdf_closepath_stroke. - + cpdf_closepath_stroke. + @@ -1637,12 +1645,12 @@ cpdf_restore($pdf) The cpdf_closepath_stroke function is a combination of cpdf_closepath and - cpdf_stroke. Than clears the path. - + cpdf_stroke. Than clears the path. + See also cpdf_closepath, - cpdf_stroke. - + cpdf_stroke. + @@ -1661,16 +1669,16 @@ cpdf_restore($pdf) The cpdf_fill function fills the interior of - the current path with the current fill color. - + 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_setrgbcolor. + @@ -1689,8 +1697,8 @@ cpdf_restore($pdf) The cpdf_fill_stroke function fills the interior of - the current path with the current fill color and draws current path. - + the current path with the current fill color and draws current path. + See also cpdf_closepath, cpdf_stroke, @@ -1698,8 +1706,8 @@ cpdf_restore($pdf) cpdf_setgray_fill, cpdf_setgray, cpdf_setrgbcolor_fill, - cpdf_setrgbcolor. - + cpdf_setrgbcolor. + @@ -1718,9 +1726,9 @@ cpdf_restore($pdf) The cpdf_closepath_fill_stroke function closes, - fills the interior of - the current path with the current fill color and draws current path. - + fills the interior of the current path with the current fill color and + draws current path. + See also cpdf_closepath, cpdf_stroke, @@ -1728,8 +1736,8 @@ cpdf_restore($pdf) cpdf_setgray_fill, cpdf_setgray, cpdf_setrgbcolor_fill, - cpdf_setrgbcolor. - + cpdf_setrgbcolor. + @@ -1748,8 +1756,8 @@ cpdf_restore($pdf) The cpdf_clip function clips all drawing - to the current path. - + to the current path. + @@ -1769,11 +1777,11 @@ cpdf_restore($pdf) The cpdf_setgray_fill function sets the current - gray value to fill a path. - + gray value to fill a path. + - See also cpdf_setrgbcolor_fill. - + See also cpdf_setrgbcolor_fill. + @@ -1793,11 +1801,11 @@ cpdf_restore($pdf) The cpdf_setgray_stroke function sets the current - drawing color to the given gray value. - + drawing color to the given gray value. + - See also cpdf_setrgbcolor_stroke. - + See also cpdf_setrgbcolor_stroke. + @@ -1817,12 +1825,12 @@ cpdf_restore($pdf) The cpdf_setgray_stroke function sets the current - drawing and filling color to the given gray value. - + drawing and filling color to the given gray value. + See also cpdf_setrgbcolor_stroke, - cpdf_setrgbcolor_fill. - + cpdf_setrgbcolor_fill. + @@ -1844,12 +1852,12 @@ cpdf_restore($pdf) The cpdf_setrgbcolor_fill function sets the current - rgb color value to fill a path. - + rgb color value to fill a path. + See also cpdf_setrgbcolor_stroke, - cpdf_setrgbcolor. - + cpdf_setrgbcolor. + @@ -1871,12 +1879,12 @@ cpdf_restore($pdf) The cpdf_setrgbcolor_stroke function sets the current - drawing color to the given rgb color value. - + drawing color to the given rgb color value. + See also cpdf_setrgbcolor_fill, - cpdf_setrgbcolor. - + cpdf_setrgbcolor. + @@ -1898,12 +1906,12 @@ cpdf_restore($pdf) The cpdf_setrgbcolor_stroke function sets the current - drawing and filling color to the given rgb color value. - + drawing and filling color to the given rgb color value. + See also cpdf_setrgbcolor_stroke, - cpdf_setrgbcolor_fill. - + cpdf_setrgbcolor_fill. + @@ -1924,7 +1932,6 @@ cpdf_restore($pdf) The cpdf_add_outline function adds a bookmark with text text that points to the current page. - Adding a page outline @@ -1939,10 +1946,10 @@ cpdf_finalize($cpdf); Header("Content-type: application/pdf"); cpdf_output_buffer($cpdf); cpdf_close($cpdf); -?> - - - +?> + + + @@ -1963,41 +1970,36 @@ cpdf_close($cpdf); The cpdf_set_page_animation function set the - transition between following pages. - + transition between following pages. + The value of transition can be - - 0 for none, - + 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, - + 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, - + 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. + between page flipping. + @@ -2013,29 +2015,32 @@ cpdf_close($cpdf); int cpdf_open_jpeg int pdf document string file name - double x-koor - double y-koor + double x-coor + double y-coor double angle double width double height double x-scale double y-scale - int mode + 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-koor, y-koor). - The image is rotated by angle degres. + page at position (x-coor, y-coor). + The image is rotated by angle degres. + - The last optional parameter determines the unit length. If is 0 or omitted - the default unit as specified for the page is used. Otherwise the koodinates - are measured in postscript points disregarding the current unit. - + 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, + See also cpdf_place_inline_image. + @@ -2051,27 +2056,29 @@ cpdf_close($cpdf); void cpdf_place_inline_image int pdf document int image - double x-koor - double y-koor + double x-coor + double y-coor double angle double width double height - int mode + int mode The cpdf_place_inline_image function places an image created with the php image functions on the page at postion - (x-koor, - y-koor). The image can be scaled at the same - time. + (x-coor, y-coor). The image + can be scaled at the same time. + - The last optional parameter determines the unit length. If is 0 or omitted - the default unit as specified for the page is used. Otherwise the koodinates - are measured in postscript points disregarding the current unit. - + 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, + See also cpdf_import_jpeg. + @@ -2092,19 +2099,21 @@ cpdf_close($cpdf); double ury string title string content - int mode + 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). - + (urx, ury). + - The last optional parameter determines the unit length. If is 0 or omitted - the default unit as specified for the page is used. Otherwise the koodinates - are measured in postscript points disregarding the current unit. + 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. +