cvs: phpdoc /en/reference/cpdf/functions cpdf-add-annotation.xml cpdf-add-outline.xml cpdf-arc.xml cpdf-begin-text.xml cpdf-circle.xml cpdf-clip.xml
cpdf-close.xml cpdf-closepath-fill-stroke.xml cpdf-closepath-stroke.xml cpdf-closepath.xml cpdf-continue-text.xml cpdf-curveto.xml cpdf-end-text.xml
cpdf-fill-stroke.xml cpdf-fill.xml cpdf-finalize-page.xml cpdf-finalize.xml cpdf-global-set-document-limits.xml cpdf-import-jpeg.xml cpdf-lineto.xml
cpdf-moveto.xml cpdf-newpath.xml cpdf-open.xml cpdf-output-buffer.xml cpdf-page-init.xml cpdf-place-inline-image.xml cpdf-rect.xml cpdf-restore.xml
cpdf-rlineto.xml cpdf-rmoveto.xml cpdf-rotate-text.xml cpdf-rotate.xml cpdf-save-to-file.xml cpdf-save.xml cpdf-scale.xml cpdf-set-action-url.xml
cpdf-set-char-spacing.xml cpdf-set-creator.xml cpdf-set-current-page.xml cpdf-set-font-directories.xml cpdf-set-font-map-file.xml cpdf-set-font.xml
cpdf-set-horiz-scaling.xml cpdf-set-keywords.xml cpdf-set-leading.xml cpdf-set-page-animation.xml cpdf-set-subject.xml cpdf-set-text-matrix.xml
cpdf-set-text-pos.xml cpdf-set-text-rendering.xml cpdf-set-text-rise.xml cpdf-set-title.xml cpdf-set-viewer-preferences.xml cpdf-set-word-spacing.xml
cpdf-setdash.xml cpdf-setflat.xml cpdf-setgray-fill.xml cpdf-setgray-stroke.xml cpdf-setgray.xml cpdf-setlinecap.xml cpdf-setlinejoin.xml
cpdf-setlinewidth.xml cpdf-setmiterlimit.xml cpdf-setrgbcolor-fill.xml cpdf-setrgbcolor-stroke.xml cpdf-setrgbcolor.xml cpdf-show-xy.xml cpdf-show.xml
cpdf-stroke.xml cpdf-text.xml cpdf-translate.xml

didou Fri Aug 15 10:29:06 2003 EDT Modified files: /phpdoc/en/reference/cpdf/functions cpdf-add-annotation.xml cpdf-add-outline.xml cpdf-arc.xml cpdf-begin-text.xml cpdf-circle.xml cpdf-clip.xml cpdf-closepath-fill-stroke.xml cpdf-closepath-stroke.xml cpdf-closepath.xml cpdf-close.xml cpdf-continue-text.xml cpdf-curveto.xml cpdf-end-text.xml cpdf-fill-stroke.xml cpdf-fill.xml cpdf-finalize-page.xml cpdf-finalize.xml cpdf-global-set-document-limits.xml cpdf-import-jpeg.xml cpdf-lineto.xml cpdf-moveto.xml cpdf-newpath.xml cpdf-open.xml cpdf-output-buffer.xml cpdf-page-init.xml cpdf-place-inline-image.xml cpdf-rect.xml cpdf-restore.xml cpdf-rlineto.xml cpdf-rmoveto.xml cpdf-rotate-text.xml cpdf-rotate.xml cpdf-save-to-file.xml cpdf-save.xml cpdf-scale.xml cpdf-set-action-url.xml cpdf-set-char-spacing.xml cpdf-set-creator.xml cpdf-set-current-page.xml cpdf-setdash.xml cpdf-setflat.xml cpdf-set-font-directories.xml cpdf-set-font-map-file.xml cpdf-set-font.xml cpdf-setgray-fill.xml cpdf-setgray-stroke.xml cpdf-setgray.xml cpdf-set-horiz-scaling.xml cpdf-set-keywords.xml cpdf-set-leading.xml cpdf-setlinecap.xml cpdf-setlinejoin.xml cpdf-setlinewidth.xml cpdf-setmiterlimit.xml cpdf-set-page-animation.xml cpdf-setrgbcolor-fill.xml cpdf-setrgbcolor-stroke.xml cpdf-setrgbcolor.xml cpdf-set-subject.xml cpdf-set-text-matrix.xml cpdf-set-text-pos.xml cpdf-set-text-rendering.xml cpdf-set-text-rise.xml cpdf-set-title.xml cpdf-set-viewer-preferences.xml cpdf-set-word-spacing.xml cpdf-show.xml cpdf-show-xy.xml cpdf-stroke.xml cpdf-text.xml cpdf-translate.xml Log: updating protos fixed missing params added role to programlisting added para arround the examples added one example and a note about the rgb values (users notes) WS for the See Also using cpdf.ul; as shorthand

Index: phpdoc/en/reference/cpdf/functions/cpdf-add-annotation.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-add-annotation.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-add-annotation.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-add-annotation.xml:1.3 Wed Feb 12 13:05:22 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-add-annotation.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.3 --> <refentry id="function.cpdf-add-annotation"> <refnamediv> @@ -9,7 +9,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_add_annotation</methodname> + <type>bool</type><methodname>cpdf_add_annotation</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>llx</parameter></methodparam> <methodparam><type>float</type><parameter>lly</parameter></methodparam> @@ -24,13 +24,11 @@ lower left corner at (<parameter>llx</parameter>, <parameter>lly</parameter>) and the upper right corner at (<parameter>urx</parameter>, <parameter>ury</parameter>). + &return.success; </para> - <para> - The optional parameter <parameter>mode</parameter> 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. - </para> + + &cpdf.ul; + </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-add-outline.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-add-outline.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-add-outline.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-add-outline.xml:1.3 Wed Feb 12 13:05:22 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-add-outline.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-add-outline"> <refnamediv> @@ -9,16 +9,22 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_add_outline</methodname> + <type>int</type><methodname>cpdf_add_outline</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> + <methodparam><type>int</type><parameter>lastoutline</parameter></methodparam> + <methodparam><type>int</type><parameter>sublevel</parameter></methodparam> + <methodparam><type>int</type><parameter>open</parameter></methodparam> + <methodparam><type>int</type><parameter>pagenr</parameter></methodparam> <methodparam><type>string</type><parameter>text</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_add_outline</function> function adds a bookmark with text <parameter>text</parameter> that points to the current page. + </para> + <para> <example> <title>Adding a page outline</title> - <programlisting> + <programlisting role="php"> <![CDATA[ <?php $cpdf = cpdf_open(0); Index: phpdoc/en/reference/cpdf/functions/cpdf-arc.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-arc.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-arc.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-arc.xml:1.3 Wed Feb 12 13:05:22 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-arc.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-arc"> <refnamediv> @@ -9,7 +9,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_arc</methodname> + <type>bool</type><methodname>cpdf_arc</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>x-coor</parameter></methodparam> <methodparam><type>float</type><parameter>y-coor</parameter></methodparam> @@ -24,14 +24,11 @@ (<parameter>x-coor</parameter>, <parameter>y-coor</parameter>) and radius <parameter>radius</parameter>, starting at angle <parameter>start</parameter> and ending at angle - <parameter>end</parameter>. - </para> - <para> - The optional parameter <parameter>mode</parameter> 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. + <parameter>end</parameter>. &return.success; </para> + + &cpdf.ul; + <para> See also <function>cpdf_circle</function>. </para> Index: phpdoc/en/reference/cpdf/functions/cpdf-begin-text.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-begin-text.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-begin-text.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-begin-text.xml:1.3 Wed Feb 12 13:05:22 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-begin-text.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-begin-text"> <refnamediv> @@ -9,15 +9,19 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_begin_text</methodname> + <type>bool</type><methodname>cpdf_begin_text</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_begin_text</function> function starts a text - section. It must be ended with <function>cpdf_end_text</function>. + section. &return.success; + The created text section must be ended with + <function>cpdf_end_text</function>. + </para> + <para> <example> <title>Text output</title> - <programlisting> + <programlisting role="php"> <![CDATA[ <?php cpdf_begin_text($pdf); Index: phpdoc/en/reference/cpdf/functions/cpdf-circle.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-circle.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-circle.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-circle.xml:1.3 Wed Feb 12 13:05:22 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-circle.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-circle"> <refnamediv> @@ -9,7 +9,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_circle</methodname> + <type>bool</type><methodname>cpdf_circle</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>x-coor</parameter></methodparam> <methodparam><type>float</type><parameter>y-coor</parameter></methodparam> @@ -20,14 +20,11 @@ The <function>cpdf_circle</function> function draws a circle with center at point (<parameter>x-coor</parameter>, <parameter>y-coor</parameter>) - and radius <parameter>radius</parameter>. - </para> - <para> - The optional parameter <parameter>mode</parameter> 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. + and radius <parameter>radius</parameter>. &return.success; </para> + + &cpdf.ul; + <para> See also <function>cpdf_arc</function>. </para> Index: phpdoc/en/reference/cpdf/functions/cpdf-clip.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-clip.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-clip.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-clip.xml:1.3 Wed Feb 12 13:05:22 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-clip.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-clip"> <refnamediv> @@ -9,12 +9,12 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_clip</methodname> + <type>bool</type><methodname>cpdf_clip</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_clip</function> function clips all drawing - to the current path. + to the current path. &return.success; </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-closepath-fill-stroke.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-closepath-fill-stroke.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-closepath-fill-stroke.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-closepath-fill-stroke.xml:1.3 Wed Feb 12 13:05:22 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-closepath-fill-stroke.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-closepath-fill-stroke"> <refnamediv> @@ -9,22 +9,22 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_closepath_fill_stroke</methodname> + <type>bool</type><methodname>cpdf_closepath_fill_stroke</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_closepath_fill_stroke</function> function closes, fills the interior of the current path with the current fill color and - draws current path. + draws current path. &return.success; </para> <para> See also <function>cpdf_closepath</function>, - <function>cpdf_stroke</function>, - <function>cpdf_fill</function>, - <function>cpdf_setgray_fill</function>, - <function>cpdf_setgray</function>, - <function>cpdf_setrgbcolor_fill</function>, - <function>cpdf_setrgbcolor</function>. + <function>cpdf_stroke</function>, + <function>cpdf_fill</function>, + <function>cpdf_setgray_fill</function>, + <function>cpdf_setgray</function>, + <function>cpdf_setrgbcolor_fill</function> and + <function>cpdf_setrgbcolor</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-closepath-stroke.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-closepath-stroke.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-closepath-stroke.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-closepath-stroke.xml:1.3 Wed Feb 12 13:05:22 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-closepath-stroke.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-closepath-stroke"> <refnamediv> @@ -9,17 +9,18 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_closepath_stroke</methodname> + <type>bool</type><methodname>cpdf_closepath_stroke</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_closepath_stroke</function> function is a combination of <function>cpdf_closepath</function> and <function>cpdf_stroke</function>. Then clears the path. + &return.success; </para> <para> - See also <function>cpdf_closepath</function>, - <function>cpdf_stroke</function>. + See also <function>cpdf_closepath</function> and + <function>cpdf_stroke</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-closepath.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-closepath.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-closepath.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-closepath.xml:1.3 Wed Feb 12 13:05:22 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-closepath.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-closepath"> <refnamediv> @@ -9,12 +9,12 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_closepath</methodname> + <type>bool</type><methodname>cpdf_closepath</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_closepath</function> function closes the - current path. + current path. &return.success; </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-close.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-close.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-close.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-close.xml:1.3 Wed Feb 12 13:05:22 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-close.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-close"> <refnamediv> @@ -9,12 +9,12 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_close</methodname> + <type>bool</type><methodname>cpdf_close</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_close</function> function closes the pdf document. - This should be the last function even after + &return.success; This should be the last function even after <function>cpdf_finalize</function>, <function>cpdf_output_buffer</function> and <function>cpdf_save_to_file</function>. </para> Index: phpdoc/en/reference/cpdf/functions/cpdf-continue-text.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-continue-text.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-continue-text.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-continue-text.xml:1.3 Wed Feb 12 13:05:22 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-continue-text.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-continue-text"> <refnamediv> @@ -9,19 +9,19 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_continue_text</methodname> + <type>bool</type><methodname>cpdf_continue_text</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>string</type><parameter>text</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_continue_text</function> function outputs the - string in <parameter>text</parameter> in the next line. + string in <parameter>text</parameter> in the next line. &return.success; </para> <para> See also <function>cpdf_show_xy</function>, - <function>cpdf_text</function>, - <function>cpdf_set_leading</function>, - <function>cpdf_set_text_pos</function>. + <function>cpdf_text</function>, + <function>cpdf_set_leading</function> and + <function>cpdf_set_text_pos</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-curveto.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-curveto.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-curveto.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-curveto.xml:1.3 Wed Feb 12 13:05:22 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-curveto.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-curveto"> <refnamediv> @@ -9,7 +9,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_curveto</methodname> + <type>bool</type><methodname>cpdf_curveto</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>x1</parameter></methodparam> <methodparam><type>float</type><parameter>y1</parameter></methodparam> @@ -25,19 +25,16 @@ (<parameter>x3</parameter>, <parameter>y3</parameter>) using (<parameter>x1</parameter>, <parameter>y1</parameter>) and (<parameter>x2</parameter>, <parameter>y2</parameter>) as control - points. - </para> - <para> - The optional parameter <parameter>mode</parameter> 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. + points. &return.success; </para> + + &cpdf.ul; + <para> See also <function>cpdf_moveto</function>, - <function>cpdf_rmoveto</function>, - <function>cpdf_rlineto</function>, - <function>cpdf_lineto</function>. + <function>cpdf_rmoveto</function>, + <function>cpdf_rlineto</function> and + <function>cpdf_lineto</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-end-text.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-end-text.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-end-text.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-end-text.xml:1.3 Wed Feb 12 13:05:22 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-end-text.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-end-text"> <refnamediv> @@ -9,15 +9,18 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_end_text</methodname> + <type>bool</type><methodname>cpdf_end_text</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_end_text</function> function ends a text section which was started with <function>cpdf_begin_text</function>. + &return.success; + </para> + <para> <example> <title>Text output</title> - <programlisting> + <programlisting role="php"> <![CDATA[ <?php cpdf_begin_text($pdf); Index: phpdoc/en/reference/cpdf/functions/cpdf-fill-stroke.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-fill-stroke.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-fill-stroke.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-fill-stroke.xml:1.3 Wed Feb 12 13:05:22 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-fill-stroke.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-fill-stroke"> <refnamediv> @@ -9,21 +9,22 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_fill_stroke</methodname> + <type>bool</type><methodname>cpdf_fill_stroke</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_fill_stroke</function> function fills the interior of the current path with the current fill color and draws current path. + &return.success; </para> <para> See also <function>cpdf_closepath</function>, - <function>cpdf_stroke</function>, - <function>cpdf_fill</function>, - <function>cpdf_setgray_fill</function>, - <function>cpdf_setgray</function>, - <function>cpdf_setrgbcolor_fill</function>, - <function>cpdf_setrgbcolor</function>. + <function>cpdf_stroke</function>, + <function>cpdf_fill</function>, + <function>cpdf_setgray_fill</function>, + <function>cpdf_setgray</function>, + <function>cpdf_setrgbcolor_fill</function> and + <function>cpdf_setrgbcolor</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-fill.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-fill.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-fill.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-fill.xml:1.3 Wed Feb 12 13:05:22 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-fill.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-fill"> <refnamediv> @@ -9,20 +9,20 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_fill</methodname> + <type>bool</type><methodname>cpdf_fill</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_fill</function> function fills the interior of - the current path with the current fill color. + the current path with the current fill color. &return.success; </para> <para> See also <function>cpdf_closepath</function>, - <function>cpdf_stroke</function>, - <function>cpdf_setgray_fill</function>, - <function>cpdf_setgray</function>, - <function>cpdf_setrgbcolor_fill</function>, - <function>cpdf_setrgbcolor</function>. + <function>cpdf_stroke</function>, + <function>cpdf_setgray_fill</function>, + <function>cpdf_setgray</function>, + <function>cpdf_setrgbcolor_fill</function> and + <function>cpdf_setrgbcolor</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-finalize-page.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-finalize-page.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-finalize-page.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-finalize-page.xml:1.3 Wed Feb 12 13:05:22 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-finalize-page.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-finalize-page"> <refnamediv> @@ -9,13 +9,13 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_finalize_page</methodname> + <type>bool</type><methodname>cpdf_finalize_page</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>int</type><parameter>page_number</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_finalize_page</function> function ends the page - with page number <parameter>page_number</parameter>. + with page number <parameter>page_number</parameter>. &return.success; </para> <para> This function is only for saving memory. A finalized page takes Index: phpdoc/en/reference/cpdf/functions/cpdf-finalize.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-finalize.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-finalize.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-finalize.xml:1.3 Wed Feb 12 13:05:22 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-finalize.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-finalize"> <refnamediv> @@ -9,12 +9,12 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_finalize</methodname> + <type>bool</type><methodname>cpdf_finalize</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_finalize</function> function ends the document. - You still have to call <function>cpdf_close</function> + You still have to call <function>cpdf_close</function>. &return.success; </para> <para> See also <function>cpdf_close</function>. Index: phpdoc/en/reference/cpdf/functions/cpdf-global-set-document-limits.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-global-set-document-limits.xml:1.2 phpdoc/en/reference/cpdf/functions/cpdf-global-set-document-limits.xml:1.3 --- phpdoc/en/reference/cpdf/functions/cpdf-global-set-document-limits.xml:1.2 Wed Apr 17 02:36:49 2002 +++ phpdoc/en/reference/cpdf/functions/cpdf-global-set-document-limits.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.22 --> <refentry id="function.cpdf-global-set-document-limits"> <refnamediv> @@ -9,7 +9,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_global_set_document_limits</methodname> + <type>bool</type><methodname>cpdf_global_set_document_limits</methodname> <methodparam><type>int</type><parameter>maxpages</parameter></methodparam> <methodparam><type>int</type><parameter>maxfonts</parameter></methodparam> <methodparam><type>int</type><parameter>maximages</parameter></methodparam> @@ -20,7 +20,7 @@ The <function>cpdf_global_set_document_limits</function> function sets several document limits. This function has to be called before <function>cpdf_open</function> to take effect. It sets the limits - for any document open afterwards. + for any document open afterwards. &return.success; </para> <para> See also <function>cpdf_open</function>. Index: phpdoc/en/reference/cpdf/functions/cpdf-import-jpeg.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-import-jpeg.xml:1.4 phpdoc/en/reference/cpdf/functions/cpdf-import-jpeg.xml:1.5 --- phpdoc/en/reference/cpdf/functions/cpdf-import-jpeg.xml:1.4 Sat May 17 09:28:22 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-import-jpeg.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-import-jpeg"> <refnamediv> @@ -29,12 +29,9 @@ (<parameter>x-coor</parameter>, <parameter>y-coor</parameter>). The image is rotated by <parameter>angle</parameter> degrees. </para> - <para> - The optional parameter <parameter>mode</parameter> 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. - </para> + + &cpdf.ul; + <para> See also <function>cpdf_place_inline_image</function>. </para> Index: phpdoc/en/reference/cpdf/functions/cpdf-lineto.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-lineto.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-lineto.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-lineto.xml:1.3 Wed Feb 12 13:05:22 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-lineto.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-lineto"> <refnamediv> @@ -9,7 +9,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_lineto</methodname> + <type>bool</type><methodname>cpdf_lineto</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>x-coor</parameter></methodparam> <methodparam><type>float</type><parameter>y-coor</parameter></methodparam> @@ -19,17 +19,15 @@ The <function>cpdf_lineto</function> function draws a line from the current point to the point with coordinates (<parameter>x-coor</parameter>, <parameter>y-coor</parameter>). + &return.success; </para> - <para> - The optional parameter <parameter>mode</parameter> 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. - </para> + + &cpdf.ul; + <para> See also <function>cpdf_moveto</function>, - <function>cpdf_rmoveto</function>, - <function>cpdf_curveto</function>. + <function>cpdf_rmoveto</function> and + <function>cpdf_curveto</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-moveto.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-moveto.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-moveto.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-moveto.xml:1.3 Wed Feb 12 13:05:22 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-moveto.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-moveto"> <refnamediv> @@ -9,7 +9,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_moveto</methodname> + <type>bool</type><methodname>cpdf_moveto</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>x-coor</parameter></methodparam> <methodparam><type>float</type><parameter>y-coor</parameter></methodparam> @@ -18,14 +18,11 @@ <para> The <function>cpdf_moveto</function> function set the current point to the coordinates <parameter>x-coor</parameter> and - <parameter>y-coor</parameter>. - </para> - <para> - The optional parameter <parameter>mode</parameter> 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. + <parameter>y-coor</parameter>. &return.success; </para> + + &cpdf.ul; + </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-newpath.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-newpath.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-newpath.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-newpath.xml:1.3 Wed Feb 12 13:05:22 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-newpath.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.22 --> <refentry id="function.cpdf-newpath"> <refnamediv> @@ -9,13 +9,13 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_newpath</methodname> + <type>bool</type><methodname>cpdf_newpath</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_newpath</function> starts a new path on the document given by the <parameter>pdf_document</parameter> - parameter. + parameter. &return.success; </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-open.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-open.xml:1.2 phpdoc/en/reference/cpdf/functions/cpdf-open.xml:1.3 --- phpdoc/en/reference/cpdf/functions/cpdf-open.xml:1.2 Wed Apr 17 02:36:49 2002 +++ phpdoc/en/reference/cpdf/functions/cpdf-open.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.22 --> <refentry id="function.cpdf-open"> <refnamediv> @@ -38,8 +38,8 @@ </note> </para> <para> - See also <function>cpdf_close</function>, - <function>cpdf_output_buffer</function>. + See also <function>cpdf_close</function> and + <function>cpdf_output_buffer</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-output-buffer.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-output-buffer.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-output-buffer.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-output-buffer.xml:1.3 Wed Feb 12 13:05:22 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-output-buffer.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-output-buffer"> <refnamediv> @@ -9,14 +9,14 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_output_buffer</methodname> + <type>bool</type><methodname>cpdf_output_buffer</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_output_buffer</function> function outputs the pdf document to stdout. The document has to be created in memory which is the case if <function>cpdf_open</function> has been called with - no filename parameter. + no filename parameter. &return.success; </para> <para> See also <function>cpdf_open</function>. Index: phpdoc/en/reference/cpdf/functions/cpdf-page-init.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-page-init.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-page-init.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-page-init.xml:1.3 Wed Feb 12 13:05:22 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-page-init.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-page-init"> <refnamediv> @@ -9,7 +9,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_page_init</methodname> + <type>bool</type><methodname>cpdf_page_init</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>int</type><parameter>page_number</parameter></methodparam> <methodparam><type>int</type><parameter>orientation</parameter></methodparam> @@ -20,8 +20,8 @@ <para> The <function>cpdf_page_init</function> function starts a new page with height <parameter>height</parameter> and width - <parameter>width</parameter>. The page has number - <parameter>page_number</parameter> and orientation + <parameter>width</parameter>. &return.success; + The page has number <parameter>page_number</parameter> and orientation <parameter>orientation</parameter>. <parameter>orientation</parameter> can be 0 for portrait and 1 for landscape. The last optional parameter <parameter>unit</parameter> sets the unit for the coordinate system. Index: phpdoc/en/reference/cpdf/functions/cpdf-place-inline-image.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-place-inline-image.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-place-inline-image.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-place-inline-image.xml:1.3 Wed Feb 12 13:05:22 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-place-inline-image.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-place-inline-image"> <refnamediv> @@ -9,7 +9,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_place_inline_image</methodname> + <type>bool</type><methodname>cpdf_place_inline_image</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>int</type><parameter>image</parameter></methodparam> <methodparam><type>float</type><parameter>x-coor</parameter></methodparam> @@ -24,14 +24,11 @@ an image created with the php image functions on the page at position (<parameter>x-coor</parameter>, <parameter>y-coor</parameter>). The image can be scaled at the - same time. - </para> - <para> - The optional parameter <parameter>mode</parameter> 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. + same time. &return.success; </para> + + &cpdf.ul; + <para> See also <function>cpdf_import_jpeg</function>. </para> Index: phpdoc/en/reference/cpdf/functions/cpdf-rect.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-rect.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-rect.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-rect.xml:1.3 Wed Feb 12 13:05:22 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-rect.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-rect"> <refnamediv> @@ -9,7 +9,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_rect</methodname> + <type>bool</type><methodname>cpdf_rect</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>x-coor</parameter></methodparam> <methodparam><type>float</type><parameter>y-coor</parameter></methodparam> @@ -22,13 +22,39 @@ its lower left corner at point (<parameter>x-coor</parameter>, <parameter>y-coor</parameter>). This width is set to <parameter>width</parameter>. - This height is set to <parameter>height</parameter>. + This height is set to <parameter>height</parameter>. &return.success; </para> + + &cpdf.ul; + <para> - The optional parameter <parameter>mode</parameter> 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. + <example> + <title>Drawing a rectangle</title> + <programlisting role="php"> +<![CDATA[ +<?php + +$cpdf = cpdf_open(0); +cpdf_page_init($cpdf, 1, 0, 595, 842, 1.0); + +// set the fill color to red +cpdf_setrgbcolor($cpdf, 1, 0, 0); + +// draw a (180 * 100) rectangle +cpdf_rect($cpdf, 645, 400, 180, 100); + +// fill the rectangle +cpdf_fill($cpdf); + +cpdf_finalize($cpdf); +Header("Content-type: application/pdf"); +cpdf_output_buffer($cpdf); +cpdf_close($cpdf); + +?> +]]> + </programlisting> + </example> </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-restore.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-restore.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-restore.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-restore.xml:1.3 Wed Feb 12 13:05:23 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-restore.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-restore"> <refnamediv> @@ -9,7 +9,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_restore</methodname> + <type>bool</type><methodname>cpdf_restore</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> </methodsynopsis> <para> @@ -17,9 +17,12 @@ environment saved with <function>cpdf_save</function>. It works like the postscript command grestore. Very useful if you want to translate or rotate an object without effecting other objects. + &return.success; + </para> + <para> <example> <title>Save/Restore</title> - <programlisting> + <programlisting role="php"> <![CDATA[ <?php cpdf_save($pdf); Index: phpdoc/en/reference/cpdf/functions/cpdf-rlineto.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-rlineto.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-rlineto.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-rlineto.xml:1.3 Wed Feb 12 13:05:23 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-rlineto.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-rlineto"> <refnamediv> @@ -9,7 +9,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_rlineto</methodname> + <type>bool</type><methodname>cpdf_rlineto</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>x-coor</parameter></methodparam> <methodparam><type>float</type><parameter>y-coor</parameter></methodparam> @@ -19,17 +19,15 @@ The <function>cpdf_rlineto</function> function draws a line from the current point to the relative point with coordinates (<parameter>x-coor</parameter>, <parameter>y-coor</parameter>). + &return.success; </para> - <para> - The optional parameter <parameter>mode</parameter> 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. - </para> + + &cpdf.ul; + <para> See also <function>cpdf_moveto</function>, - <function>cpdf_rmoveto</function>, - <function>cpdf_curveto</function>. + <function>cpdf_rmoveto</function> and + <function>cpdf_curveto</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-rmoveto.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-rmoveto.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-rmoveto.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-rmoveto.xml:1.3 Wed Feb 12 13:05:23 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-rmoveto.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-rmoveto"> <refnamediv> @@ -9,7 +9,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_rmoveto</methodname> + <type>bool</type><methodname>cpdf_rmoveto</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>x-coor</parameter></methodparam> <methodparam><type>float</type><parameter>y-coor</parameter></methodparam> @@ -18,14 +18,11 @@ <para> The <function>cpdf_rmoveto</function> function set the current point relative to the coordinates <parameter>x-coor</parameter> and - <parameter>y-coor</parameter>. - </para> - <para> - The optional parameter <parameter>mode</parameter> 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. + <parameter>y-coor</parameter>. &return.success; </para> + + &cpdf.ul; + <para> See also <function>cpdf_moveto</function>. </para> Index: phpdoc/en/reference/cpdf/functions/cpdf-rotate-text.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-rotate-text.xml:1.2 phpdoc/en/reference/cpdf/functions/cpdf-rotate-text.xml:1.3 --- phpdoc/en/reference/cpdf/functions/cpdf-rotate-text.xml:1.2 Wed Apr 17 02:36:50 2002 +++ phpdoc/en/reference/cpdf/functions/cpdf-rotate-text.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.35 --> <refentry id='function.cpdf-rotate-text'> <refnamediv> @@ -11,7 +11,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_rotate_text</methodname> + <type>bool</type><methodname>cpdf_rotate_text</methodname> <methodparam><type>int</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>float</type><parameter>angle</parameter></methodparam> </methodsynopsis> Index: phpdoc/en/reference/cpdf/functions/cpdf-rotate.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-rotate.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-rotate.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-rotate.xml:1.3 Wed Feb 12 13:05:23 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-rotate.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-rotate"> <refnamediv> @@ -9,13 +9,13 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_rotate</methodname> + <type>bool</type><methodname>cpdf_rotate</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>angle</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_rotate</function> function set the rotation in - degrees to <parameter>angle</parameter>. + degrees to <parameter>angle</parameter>. &return.success; </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-save-to-file.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-save-to-file.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-save-to-file.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-save-to-file.xml:1.3 Wed Feb 12 13:05:23 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-save-to-file.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-save-to-file"> <refnamediv> @@ -9,21 +9,22 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_save_to_file</methodname> + <type>bool</type><methodname>cpdf_save_to_file</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>string</type><parameter>filename</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_save_to_file</function> function outputs the pdf document into a file if it has been created in memory. + &return.success; </para> <para> This function is not needed if the pdf document has been open by specifying a filename as a parameter of <function>cpdf_open</function>. </para> <para> - See also <function>cpdf_output_buffer</function>, - <function>cpdf_open</function>. + See also <function>cpdf_output_buffer</function> and + <function>cpdf_open</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-save.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-save.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-save.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-save.xml:1.3 Wed Feb 12 13:05:23 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-save.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-save"> <refnamediv> @@ -9,14 +9,14 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_save</methodname> + <type>bool</type><methodname>cpdf_save</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_save</function> function saves the current environment. It works like the postscript command gsave. Very useful if you want to translate or rotate an object without effecting - other objects. + other objects. &return.success; </para> <para> See also <function>cpdf_restore</function>. Index: phpdoc/en/reference/cpdf/functions/cpdf-scale.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-scale.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-scale.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-scale.xml:1.3 Wed Feb 12 13:05:23 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-scale.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-scale"> <refnamediv> @@ -9,14 +9,14 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_scale</methodname> + <type>bool</type><methodname>cpdf_scale</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>x-scale</parameter></methodparam> <methodparam><type>float</type><parameter>y-scale</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_scale</function> function set the scaling factor - in both directions. + in both directions. &return.success; </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-set-action-url.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-action-url.xml:1.2 phpdoc/en/reference/cpdf/functions/cpdf-set-action-url.xml:1.3 --- phpdoc/en/reference/cpdf/functions/cpdf-set-action-url.xml:1.2 Wed Apr 17 02:36:52 2002 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-action-url.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id='function.cpdf-set-action-url'> <refnamediv> @@ -11,7 +11,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_set_action_url</methodname> + <type>bool</type><methodname>cpdf_set_action_url</methodname> <methodparam><type>int</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>float</type><parameter>xll</parameter></methodparam> <methodparam><type>float</type><parameter>yll</parameter></methodparam> Index: phpdoc/en/reference/cpdf/functions/cpdf-set-char-spacing.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-char-spacing.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-set-char-spacing.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-set-char-spacing.xml:1.3 Wed Feb 12 13:05:23 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-char-spacing.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-set-char-spacing"> <refnamediv> @@ -9,17 +9,17 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_set_char_spacing</methodname> + <type>bool</type><methodname>cpdf_set_char_spacing</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>space</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_set_char_spacing</function> function sets the - spacing between characters. + spacing between characters. &return.success; </para> <para> - See also <function>cpdf_set_word_spacing</function>, - <function>cpdf_set_leading</function>. + See also <function>cpdf_set_word_spacing</function> and + <function>cpdf_set_leading</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-set-creator.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-creator.xml:1.2 phpdoc/en/reference/cpdf/functions/cpdf-set-creator.xml:1.3 --- phpdoc/en/reference/cpdf/functions/cpdf-set-creator.xml:1.2 Wed Apr 17 02:36:52 2002 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-creator.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-set-creator"> <refnamediv> @@ -9,17 +9,17 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_set_creator</methodname> + <type>bool</type><methodname>cpdf_set_creator</methodname> <methodparam><type>string</type><parameter>creator</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_set_creator</function> function sets the - creator of a pdf document. + creator of a pdf document. &return.success; </para> <para> See also <function>cpdf_set_subject</function>, - <function>cpdf_set_title</function>, - <function>cpdf_set_keywords</function>. + <function>cpdf_set_title</function> and + <function>cpdf_set_keywords</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-set-current-page.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-current-page.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-set-current-page.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-set-current-page.xml:1.3 Wed Feb 12 13:05:23 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-current-page.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-set-current-page"> <refnamediv> @@ -9,7 +9,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_set_current_page</methodname> + <type>bool</type><methodname>cpdf_set_current_page</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>int</type><parameter>page_number</parameter></methodparam> </methodsynopsis> @@ -17,6 +17,7 @@ The <function>cpdf_set_current_page</function> function set the page on which all operations are performed. One can switch between pages until a page is finished with <function>cpdf_finalize_page</function>. + &return.success; </para> <para> See also <function>cpdf_finalize_page</function>. Index: phpdoc/en/reference/cpdf/functions/cpdf-setdash.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-setdash.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-setdash.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-setdash.xml:1.3 Wed Feb 12 13:05:23 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-setdash.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-setdash"> <refnamediv> @@ -9,7 +9,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_setdash</methodname> + <type>bool</type><methodname>cpdf_setdash</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>white</parameter></methodparam> <methodparam><type>float</type><parameter>black</parameter></methodparam> @@ -18,7 +18,7 @@ The <function>cpdf_setdash</function> function set the dash pattern <parameter>white</parameter> white units and <parameter>black</parameter> black units. If both are 0 a solid - line is set. + line is set. &return.success; </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-setflat.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-setflat.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-setflat.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-setflat.xml:1.3 Wed Feb 12 13:05:23 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-setflat.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-setflat"> <refnamediv> @@ -9,13 +9,13 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_setflat</methodname> + <type>bool</type><methodname>cpdf_setflat</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>value</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_setflat</function> function set the flatness to - a value between 0 and 100. + a value between 0 and 100. &return.success; </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-set-font-directories.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-font-directories.xml:1.2 phpdoc/en/reference/cpdf/functions/cpdf-set-font-directories.xml:1.3 --- phpdoc/en/reference/cpdf/functions/cpdf-set-font-directories.xml:1.2 Wed Apr 17 02:36:52 2002 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-font-directories.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.35 --> <refentry id='function.cpdf-set-font-directories'> <refnamediv> @@ -11,7 +11,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_set_font_directories</methodname> + <type>bool</type><methodname>cpdf_set_font_directories</methodname> <methodparam><type>int</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>string</type><parameter>pfmdir</parameter></methodparam> <methodparam><type>string</type><parameter>pfbdir</parameter></methodparam> Index: phpdoc/en/reference/cpdf/functions/cpdf-set-font-map-file.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-font-map-file.xml:1.2 phpdoc/en/reference/cpdf/functions/cpdf-set-font-map-file.xml:1.3 --- phpdoc/en/reference/cpdf/functions/cpdf-set-font-map-file.xml:1.2 Wed Apr 17 02:36:52 2002 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-font-map-file.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.35 --> <refentry id='function.cpdf-set-font-map-file'> <refnamediv> @@ -11,7 +11,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_set_font_map_file</methodname> + <type>bool</type><methodname>cpdf_set_font_map_file</methodname> <methodparam><type>int</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>string</type><parameter>filename</parameter></methodparam> </methodsynopsis> Index: phpdoc/en/reference/cpdf/functions/cpdf-set-font.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-font.xml:1.4 phpdoc/en/reference/cpdf/functions/cpdf-set-font.xml:1.5 --- phpdoc/en/reference/cpdf/functions/cpdf-set-font.xml:1.4 Sat May 17 09:28:22 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-font.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-set-font"> <refnamediv> @@ -9,7 +9,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_set_font</methodname> + <type>bool</type><methodname>cpdf_set_font</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>string</type><parameter>font_name</parameter></methodparam> <methodparam><type>float</type><parameter>size</parameter></methodparam> @@ -18,7 +18,7 @@ <para> The <function>cpdf_set_font</function> function sets the current font face, font size and encoding. Currently only - the standard postscript fonts are supported. + the standard postscript fonts are supported. &return.success; </para> <para> The last parameter <parameter>encoding</parameter> can take the Index: phpdoc/en/reference/cpdf/functions/cpdf-setgray-fill.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-setgray-fill.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-setgray-fill.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-setgray-fill.xml:1.3 Wed Feb 12 13:05:23 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-setgray-fill.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-setgray-fill"> <refnamediv> @@ -9,13 +9,13 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_setgray_fill</methodname> + <type>bool</type><methodname>cpdf_setgray_fill</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>value</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_setgray_fill</function> function sets the current - gray value to fill a path. + gray <parameter>value</parameter> to fill a path. &return.success; </para> <para> See also <function>cpdf_setrgbcolor_fill</function>. Index: phpdoc/en/reference/cpdf/functions/cpdf-setgray-stroke.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-setgray-stroke.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-setgray-stroke.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-setgray-stroke.xml:1.3 Wed Feb 12 13:05:23 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-setgray-stroke.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-setgray-stroke"> <refnamediv> @@ -9,13 +9,13 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_setgray_stroke</methodname> + <type>bool</type><methodname>cpdf_setgray_stroke</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>gray_value</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_setgray_stroke</function> function sets the current - drawing color to the given gray value. + drawing color to the given gray value. &return.success; </para> <para> See also <function>cpdf_setrgbcolor_stroke</function>. Index: phpdoc/en/reference/cpdf/functions/cpdf-setgray.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-setgray.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-setgray.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-setgray.xml:1.3 Wed Feb 12 13:05:23 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-setgray.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-setgray"> <refnamediv> @@ -9,17 +9,17 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_setgray</methodname> + <type>bool</type><methodname>cpdf_setgray</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>gray_value</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_setgray</function> function sets the current - drawing and filling color to the given gray value. + drawing and filling color to the given gray value. &return.success; </para> <para> - See also <function>cpdf_setrgbcolor_stroke</function>, - <function>cpdf_setrgbcolor_fill</function>. + See also <function>cpdf_setrgbcolor_stroke</function> and + <function>cpdf_setrgbcolor_fill</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-set-horiz-scaling.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-horiz-scaling.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-set-horiz-scaling.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-set-horiz-scaling.xml:1.3 Wed Feb 12 13:05:23 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-horiz-scaling.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-set-horiz-scaling"> <refnamediv> @@ -9,13 +9,14 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_set_horiz_scaling</methodname> + <type>bool</type><methodname>cpdf_set_horiz_scaling</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>scale</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_set_horiz_scaling</function> function sets the horizontal scaling to <parameter>scale</parameter> percent. + &return.success; </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-set-keywords.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-keywords.xml:1.2 phpdoc/en/reference/cpdf/functions/cpdf-set-keywords.xml:1.3 --- phpdoc/en/reference/cpdf/functions/cpdf-set-keywords.xml:1.2 Wed Apr 17 02:36:53 2002 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-keywords.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-set-keywords"> <refnamediv> @@ -9,17 +9,17 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_set_keywords</methodname> + <type>bool</type><methodname>cpdf_set_keywords</methodname> <methodparam><type>string</type><parameter>keywords</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_set_keywords</function> function sets the - keywords of a pdf document. + keywords of a pdf document. &return.success; </para> <para> See also <function>cpdf_set_title</function>, - <function>cpdf_set_creator</function>, - <function>cpdf_set_subject</function>. + <function>cpdf_set_creator</function> and + <function>cpdf_set_subject</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-set-leading.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-leading.xml:1.4 phpdoc/en/reference/cpdf/functions/cpdf-set-leading.xml:1.5 --- phpdoc/en/reference/cpdf/functions/cpdf-set-leading.xml:1.4 Wed Feb 12 13:05:23 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-leading.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.6 --> <refentry id="function.cpdf-set-leading"> <refnamediv> @@ -9,14 +9,15 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_set_leading</methodname> + <type>bool</type><methodname>cpdf_set_leading</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>distance</parameter></methodparam> </methodsynopsis> <para> - The <function>cpdf_set_leading</function> function sets the distance - between text lines. This will be used if text is output by - <function>cpdf_continue_text</function>. + The <function>cpdf_set_leading</function> function sets the + <parameter>distance</parameter> between text lines. This will + be used if text is output by <function>cpdf_continue_text</function>. + &return.success; </para> <para> See also <function>cpdf_continue_text</function>. Index: phpdoc/en/reference/cpdf/functions/cpdf-setlinecap.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-setlinecap.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-setlinecap.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-setlinecap.xml:1.3 Wed Feb 12 13:05:23 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-setlinecap.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-setlinecap"> <refnamediv> @@ -9,14 +9,14 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_setlinecap</methodname> + <type>bool</type><methodname>cpdf_setlinecap</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>int</type><parameter>value</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_setlinecap</function> function set the linecap - parameter between a value of 0 and 2. 0 = butt end, 1 = round, - 2 = projecting square. + parameter between a <parameter>value</parameter> of 0 and 2. + 0 = butt end, 1 = round, 2 = projecting square. &return.success; </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-setlinejoin.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-setlinejoin.xml:1.4 phpdoc/en/reference/cpdf/functions/cpdf-setlinejoin.xml:1.5 --- phpdoc/en/reference/cpdf/functions/cpdf-setlinejoin.xml:1.4 Wed Feb 12 13:05:23 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-setlinejoin.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-setlinejoin"> <refnamediv> @@ -9,14 +9,14 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_setlinejoin</methodname> + <type>bool</type><methodname>cpdf_setlinejoin</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>int</type><parameter>value</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_setlinejoin</function> function set the - linejoin parameter between a value of 0 and 2. 0 = miter, 1 = - round, 2 = bevel. + linejoin parameter between a <parameter>value</parameter> of + 0 and 2. 0 = miter, 1 = round, 2 = bevel. &return.success; </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-setlinewidth.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-setlinewidth.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-setlinewidth.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-setlinewidth.xml:1.3 Wed Feb 12 13:05:23 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-setlinewidth.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-setlinewidth"> <refnamediv> @@ -9,13 +9,13 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_setlinewidth</methodname> + <type>bool</type><methodname>cpdf_setlinewidth</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>width</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_setlinewidth</function> function set the line - width to <parameter>width</parameter>. + width to <parameter>width</parameter>. &return.success; </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-setmiterlimit.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-setmiterlimit.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-setmiterlimit.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-setmiterlimit.xml:1.3 Wed Feb 12 13:05:23 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-setmiterlimit.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-setmiterlimit"> <refnamediv> @@ -9,13 +9,13 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_setmiterlimit</methodname> + <type>bool</type><methodname>cpdf_setmiterlimit</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>value</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_setmiterlimit</function> function set the - miter limit to a value greater or equal than 1. + miter limit to a value greater or equal than 1. &return.success; </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-set-page-animation.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-page-animation.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-set-page-animation.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-set-page-animation.xml:1.3 Wed Feb 12 13:05:23 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-page-animation.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-set-page-animation"> <refnamediv> @@ -9,14 +9,14 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_set_page_animation</methodname> + <type>bool</type><methodname>cpdf_set_page_animation</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>int</type><parameter>transition</parameter></methodparam> <methodparam><type>float</type><parameter>duration</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_set_page_animation</function> function set the - transition between following pages. + transition between following pages. &return.success; </para> <para> The value of <parameter>transition</parameter> Index: phpdoc/en/reference/cpdf/functions/cpdf-setrgbcolor-fill.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-setrgbcolor-fill.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-setrgbcolor-fill.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-setrgbcolor-fill.xml:1.3 Wed Feb 12 13:05:23 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-setrgbcolor-fill.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-setrgbcolor-fill"> <refnamediv> @@ -9,7 +9,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_setrgbcolor_fill</methodname> + <type>bool</type><methodname>cpdf_setrgbcolor_fill</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>red_value</parameter></methodparam> <methodparam><type>float</type><parameter>green_value</parameter></methodparam> @@ -17,11 +17,17 @@ </methodsynopsis> <para> The <function>cpdf_setrgbcolor_fill</function> function sets the current - rgb color value to fill a path. + rgb color value to fill a path. &return.success; </para> + <note> + <para> + The values are expected to be floating point values between 0.0 and + 1.0. (i.e black is (0.0, 0.0, 0.0) and white is (1.0, 1.0, 1.0)). + </para> + </note> <para> See also <function>cpdf_setrgbcolor_stroke</function> and - <function>cpdf_setrgbcolor</function>. + <function>cpdf_setrgbcolor</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-setrgbcolor-stroke.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-setrgbcolor-stroke.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-setrgbcolor-stroke.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-setrgbcolor-stroke.xml:1.3 Wed Feb 12 13:05:23 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-setrgbcolor-stroke.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-setrgbcolor-stroke"> <refnamediv> @@ -9,7 +9,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_setrgbcolor_stroke</methodname> + <type>bool</type><methodname>cpdf_setrgbcolor_stroke</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>red_value</parameter></methodparam> <methodparam><type>float</type><parameter>green_value</parameter></methodparam> @@ -17,11 +17,17 @@ </methodsynopsis> <para> The <function>cpdf_setrgbcolor_stroke</function> function sets the current - drawing color to the given rgb color value. + drawing color to the given rgb color value. &return.success; </para> + <note> + <para> + The values are expected to be floating point values between 0.0 and + 1.0. (i.e black is (0.0, 0.0, 0.0) and white is (1.0, 1.0, 1.0)). + </para> + </note> <para> - See also <function>cpdf_setrgbcolor_fill</function>, - <function>cpdf_setrgbcolor</function>. + See also <function>cpdf_setrgbcolor_fill</function> and + <function>cpdf_setrgbcolor</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-setrgbcolor.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-setrgbcolor.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-setrgbcolor.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-setrgbcolor.xml:1.3 Wed Feb 12 13:05:23 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-setrgbcolor.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-setrgbcolor"> <refnamediv> @@ -9,7 +9,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_setrgbcolor</methodname> + <type>bool</type><methodname>cpdf_setrgbcolor</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>red_value</parameter></methodparam> <methodparam><type>float</type><parameter>green_value</parameter></methodparam> @@ -17,11 +17,17 @@ </methodsynopsis> <para> The <function>cpdf_setrgbcolor</function> function sets the current - drawing and filling color to the given rgb color value. + drawing and filling color to the given rgb color value. &return.success; </para> + <note> + <para> + The values are expected to be floating point values between 0.0 and + 1.0. (i.e black is (0.0, 0.0, 0.0) and white is (1.0, 1.0, 1.0)). + </para> + </note> <para> - See also <function>cpdf_setrgbcolor_stroke</function>, - <function>cpdf_setrgbcolor_fill</function>. + See also <function>cpdf_setrgbcolor_stroke</function> and + <function>cpdf_setrgbcolor_fill</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-set-subject.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-subject.xml:1.2 phpdoc/en/reference/cpdf/functions/cpdf-set-subject.xml:1.3 --- phpdoc/en/reference/cpdf/functions/cpdf-set-subject.xml:1.2 Wed Apr 17 02:36:53 2002 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-subject.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-set-subject"> <refnamediv> @@ -9,17 +9,18 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_set_subject</methodname> + <type>bool</type><methodname>cpdf_set_subject</methodname> + <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>string</type><parameter>subject</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_set_subject</function> function sets the - subject of a pdf document. + <parameter>subject</parameter> of a pdf document. &return.success; </para> <para> See also <function>cpdf_set_title</function>, - <function>cpdf_set_creator</function>, - <function>cpdf_set_keywords</function>. + <function>cpdf_set_creator</function> and + <function>cpdf_set_keywords</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-set-text-matrix.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-text-matrix.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-set-text-matrix.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-set-text-matrix.xml:1.3 Wed Feb 12 13:05:23 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-text-matrix.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-set-text-matrix"> <refnamediv> @@ -9,14 +9,14 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_set_text_matrix</methodname> + <type>bool</type><methodname>cpdf_set_text_matrix</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>array</type><parameter>matrix</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_set_text_matrix</function> function sets - a matrix which describes a transformation applied on the current - text font. + a <parameter>matrix</parameter> which describes a transformation + applied on the current text font. &return.success; </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-set-text-pos.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-text-pos.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-set-text-pos.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-set-text-pos.xml:1.3 Wed Feb 12 13:05:23 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-text-pos.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-set-text-pos"> <refnamediv> @@ -9,7 +9,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_set_text_pos</methodname> + <type>bool</type><methodname>cpdf_set_text_pos</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>x-coor</parameter></methodparam> <methodparam><type>float</type><parameter>y-coor</parameter></methodparam> @@ -18,17 +18,14 @@ <para> The <function>cpdf_set_text_pos</function> function sets the position of text for the next <function>cpdf_show</function> - function call. + function call. &return.success; </para> + + &cpdf.ul; + <para> - The optional parameter <parameter>mode</parameter> 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. - </para> - <para> - See also <function>cpdf_show</function>, - <function>cpdf_text</function>. + See also <function>cpdf_show</function> and + <function>cpdf_text</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-set-text-rendering.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-text-rendering.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-set-text-rendering.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-set-text-rendering.xml:1.3 Wed Feb 12 13:05:23 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-text-rendering.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-set-text-rendering"> <refnamediv> @@ -9,16 +9,16 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_set_text_rendering</methodname> + <type>bool</type><methodname>cpdf_set_text_rendering</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> + <methodparam><type>int</type><parameter>rendermode</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_set_text_rendering</function> function - determines how text is rendered. + determines how text is rendered. &return.success; </para> <para> - The possible values for <parameter>mode</parameter> are 0=fill + The possible values for <parameter>rendermode</parameter> 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 Index: phpdoc/en/reference/cpdf/functions/cpdf-set-text-rise.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-text-rise.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-set-text-rise.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-set-text-rise.xml:1.3 Wed Feb 12 13:05:23 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-text-rise.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-set-text-rise"> <refnamediv> @@ -9,13 +9,13 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_set_text_rise</methodname> + <type>bool</type><methodname>cpdf_set_text_rise</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>value</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_set_text_rise</function> function sets the - text rising to <parameter>value</parameter> units. + text rising to <parameter>value</parameter> units. &return.success; </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-set-title.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-title.xml:1.2 phpdoc/en/reference/cpdf/functions/cpdf-set-title.xml:1.3 --- phpdoc/en/reference/cpdf/functions/cpdf-set-title.xml:1.2 Wed Apr 17 02:36:54 2002 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-title.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-set-title"> <refnamediv> @@ -9,17 +9,17 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_set_title</methodname> + <type>bool</type><methodname>cpdf_set_title</methodname> <methodparam><type>string</type><parameter>title</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_set_title</function> function sets the - title of a pdf document. + <parameter>title</parameter> of a pdf document. &return.success; </para> <para> See also <function>cpdf_set_subject</function>, - <function>cpdf_set_creator</function>, - <function>cpdf_set_keywords</function>. + <function>cpdf_set_creator</function> and + <function>cpdf_set_keywords</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-set-viewer-preferences.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-viewer-preferences.xml:1.2 phpdoc/en/reference/cpdf/functions/cpdf-set-viewer-preferences.xml:1.3 --- phpdoc/en/reference/cpdf/functions/cpdf-set-viewer-preferences.xml:1.2 Wed Apr 17 02:36:54 2002 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-viewer-preferences.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.35 --> <refentry id='function.cpdf-set-viewer-preferences'> <refnamediv> @@ -11,7 +11,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_set_viewer_preferences</methodname> + <type>bool</type><methodname>cpdf_set_viewer_preferences</methodname> <methodparam><type>int</type><parameter>pdfdoc</parameter></methodparam> <methodparam><type>array</type><parameter>preferences</parameter></methodparam> </methodsynopsis> Index: phpdoc/en/reference/cpdf/functions/cpdf-set-word-spacing.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-set-word-spacing.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-set-word-spacing.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-set-word-spacing.xml:1.3 Wed Feb 12 13:05:23 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-set-word-spacing.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-set-word-spacing"> <refnamediv> @@ -9,17 +9,17 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_set_word_spacing</methodname> + <type>bool</type><methodname>cpdf_set_word_spacing</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>space</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_set_word_spacing</function> function sets the - spacing between words. + spacing between words. &return.success; </para> <para> - See also <function>cpdf_set_char_spacing</function>, - <function>cpdf_set_leading</function>. + See also <function>cpdf_set_char_spacing</function> and + <function>cpdf_set_leading</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-show.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-show.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-show.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-show.xml:1.3 Wed Feb 12 13:05:23 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-show.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-show"> <refnamediv> @@ -9,18 +9,19 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_show</methodname> + <type>bool</type><methodname>cpdf_show</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>string</type><parameter>text</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_show</function> function outputs the string in <parameter>text</parameter> at the current position. + &return.success; </para> <para> See also <function>cpdf_text</function>, - <function>cpdf_begin_text</function>, - <function>cpdf_end_text</function>. + <function>cpdf_begin_text</function> and + <function>cpdf_end_text</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-show-xy.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-show-xy.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-show-xy.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-show-xy.xml:1.3 Wed Feb 12 13:05:23 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-show-xy.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-show-xy"> <refnamediv> @@ -9,7 +9,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_show_xy</methodname> + <type>bool</type><methodname>cpdf_show_xy</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>string</type><parameter>text</parameter></methodparam> <methodparam><type>float</type><parameter>x-coor</parameter></methodparam> @@ -20,12 +20,12 @@ The <function>cpdf_show_xy</function> function outputs the string <parameter>text</parameter> at position with coordinates (<parameter>x-coor</parameter>, <parameter>y-coor</parameter>). + &return.success; </para> + + &cpdf.ul; + <para> - The optional parameter <parameter>mode</parameter> 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. <note> <simpara> The function <function>cpdf_show_xy</function> is identical to Index: phpdoc/en/reference/cpdf/functions/cpdf-stroke.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-stroke.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-stroke.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-stroke.xml:1.3 Wed Feb 12 13:05:23 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-stroke.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-stroke"> <refnamediv> @@ -9,16 +9,16 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_stroke</methodname> + <type>bool</type><methodname>cpdf_stroke</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> </methodsynopsis> <para> The <function>cpdf_stroke</function> function draws a line along - current path. + current path. &return.success; </para> <para> - See also <function>cpdf_closepath</function>, - <function>cpdf_closepath_stroke</function>. + See also <function>cpdf_closepath</function> and + <function>cpdf_closepath_stroke</function>. </para> </refsect1> </refentry> Index: phpdoc/en/reference/cpdf/functions/cpdf-text.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-text.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-text.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-text.xml:1.3 Wed Feb 12 13:05:23 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-text.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 --> <refentry id="function.cpdf-text"> <refnamediv> @@ -9,7 +9,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_text</methodname> + <type>bool</type><methodname>cpdf_text</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>string</type><parameter>text</parameter></methodparam> <methodparam><type>float</type><parameter>x-coor</parameter></methodparam> @@ -22,16 +22,18 @@ The <function>cpdf_text</function> function outputs the string <parameter>text</parameter> at position with coordinates (<parameter>x-coor</parameter>, <parameter>y-coor</parameter>). + &return.success; </para> + + &cpdf.ul; + <para> - The optional parameter <parameter>mode</parameter> 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 <parameter>orientation</parameter> is the rotation of - the text in degree. The optional parameter - <parameter>alignmode</parameter> determines how the text is - aligned. + The optional parameter <parameter>orientation</parameter> is the + rotation of the text in degree. + </para> + <para> + The optional parameter <parameter>alignmode</parameter> determines + how the text is aligned. </para> <para> See the ClibPDF documentation for possible values. Index: phpdoc/en/reference/cpdf/functions/cpdf-translate.xml diff -u phpdoc/en/reference/cpdf/functions/cpdf-translate.xml:1.3 phpdoc/en/reference/cpdf/functions/cpdf-translate.xml:1.4 --- phpdoc/en/reference/cpdf/functions/cpdf-translate.xml:1.3 Wed Feb 12 13:05:23 2003 +++ phpdoc/en/reference/cpdf/functions/cpdf-translate.xml Fri Aug 15 10:29:05 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.35 --> <refentry id="function.cpdf-translate"> <refnamediv> @@ -9,7 +9,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>void</type><methodname>cpdf_translate</methodname> + <type>bool</type><methodname>cpdf_translate</methodname> <methodparam><type>int</type><parameter>pdf_document</parameter></methodparam> <methodparam><type>float</type><parameter>x-coor</parameter></methodparam> <methodparam><type>float</type><parameter>y-coor</parameter></methodparam> @@ -18,14 +18,11 @@ <para> The <function>cpdf_translate</function> function set the origin of coordinate system to the point (<parameter>x-coor</parameter>, - <parameter>y-coor</parameter>). - </para> - <para> - The optional parameter <parameter>mode</parameter> 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. + <parameter>y-coor</parameter>). &return.success; </para> + + &cpdf.ul; + </refsect1> </refentry>