CVS update: php3/doc/functions

Date: Tuesday November 3, 1998 @ 12:00 Author: steinm Update of /repository/php3/doc/functions In directory asf:/u2/tmp/cvs-serv1164/doc/functions Modified Files: pdf.sgml Log Message: more documentation, more pdf functions Index: php3/doc/functions/pdf.sgml diff -c php3/doc/functions/pdf.sgml:1.6 php3/doc/functions/pdf.sgml:1.7 *** php3/doc/functions/pdf.sgml:1.6 Wed Oct 28 00:44:33 1998 --- php3/doc/functions/pdf.sgml Tue Nov 3 12:00:13 1998 *************** *** 17,22 **** --- 17,25 ---- and the php3 module have the same name. The parameteres are also identical. You should also understand some of the concepts of pdf to efficiently use this module. + + The pdf module introduces two new types of variables. They are called + <parameter>pdfdoc</parameter> and <parameter>pdfinfo</parameter>. </partintro> <refentry id="function.pdf-get-info"> *************** *** 457,462 **** --- 460,484 ---- </refsect1> </refentry> + <refentry id="function.pdf-set-text-matrix"> + <refnamediv> + <refname>PDF_set_text_matrix</refname> + <refpurpose>Sets the text matrix</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>void <function>pdf_set_text_matrix</function></funcdef> + <paramdef>pdfdoc <parameter>pdf document</parameter></paramdef> + <paramdef>array <parameter>matrix</parameter></paramdef> + </funcsynopsis> + <para> + The <function>PDF_set_text_matrix</function> function sets + a matrix which describes a transformation applied on the current + text font. + </refsect1> + </refentry> + <refentry id="function.pdf-set-text-pos"> <refnamediv> <refname>PDF_set_text_pos</refname> *************** *** 1048,1053 **** --- 1070,1373 ---- <function>PDF_setrgbcolor_fill</function>, <function>PDF_setrgbcolor</function>. + </refsect1> + </refentry> + + <refentry id="function.pdf-fill-stroke"> + <refnamediv> + <refname>PDF_fill_stroke</refname> + <refpurpose>Fill and stroke current path</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>void <function>pdf_fill_stroke</function></funcdef> + <paramdef>pdfdoc <parameter>pdf document</parameter></paramdef> + </funcsynopsis> + <para> + The <function>PDF_fill_stroke</function> function fills the interior of + the current path with the current fill color and draws current path. + + <para> + See also <function>PDF_closepath</function>, + <function>PDF_stroke</function>, + <function>PDF_fill</function>, + <function>PDF_setgray_fill</function>, + <function>PDF_setgray</function>, + <function>PDF_setrgbcolor_fill</function>, + <function>PDF_setrgbcolor</function>. + + </refsect1> + </refentry> + + <refentry id="function.pdf-closepath-fill-stroke"> + <refnamediv> + <refname>PDF_closepath_fill_stroke</refname> + <refpurpose>Close, fill and stroke current path</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>void <function>pdf_closepath_fill_stroke</function></funcdef> + <paramdef>pdfdoc <parameter>pdf document</parameter></paramdef> + </funcsynopsis> + <para> + The <function>PDF_closepath_fill_stroke</function> function closes, + fills the interior of + the current path with the current fill color and draws current path. + + <para> + See also <function>PDF_closepath</function>, + <function>PDF_stroke</function>, + <function>PDF_fill</function>, + <function>PDF_setgray_fill</function>, + <function>PDF_setgray</function>, + <function>PDF_setrgbcolor_fill</function>, + <function>PDF_setrgbcolor</function>. + + </refsect1> + </refentry> + + <refentry id="function.pdf-endpath"> + <refnamediv> + <refname>PDF_endpath</refname> + <refpurpose>Ends current path</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>void <function>pdf_endpath</function></funcdef> + <paramdef>pdfdoc <parameter>pdf document</parameter></paramdef> + </funcsynopsis> + <para> + The <function>PDF_endpath</function> function ends + the current path but does not close it. + + <para> + See also <function>PDF_closepath</function>. + + </refsect1> + </refentry> + + <refentry id="function.pdf-clip"> + <refnamediv> + <refname>PDF_clip</refname> + <refpurpose>Clips to current path</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>void <function>pdf_clip</function></funcdef> + <paramdef>pdfdoc <parameter>pdf document</parameter></paramdef> + </funcsynopsis> + <para> + The <function>PDF_clip</function> function clips all drawing + to the current path. + + </refsect1> + </refentry> + + <refentry id="function.pdf-setgray-fill"> + <refnamediv> + <refname>PDF_setgray_fill</refname> + <refpurpose>Sets filling color to gray value</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>void <function>pdf_setgray_fill</function></funcdef> + <paramdef>pdfdoc <parameter>pdf document</parameter></paramdef> + <paramdef>double <parameter>gray value</parameter></paramdef> + </funcsynopsis> + <para> + The <function>PDF_setgray_fill</function> function sets the current + gray value to fill a path. + + <para> + See also <function>PDF_setrgbcolor_fill</function>. + + </refsect1> + </refentry> + + <refentry id="function.pdf-setgray-stroke"> + <refnamediv> + <refname>PDF_setgray_stroke</refname> + <refpurpose>Sets drawing color to gray value</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>void <function>pdf_setgray_stroke</function></funcdef> + <paramdef>pdfdoc <parameter>pdf document</parameter></paramdef> + <paramdef>double <parameter>gray value</parameter></paramdef> + </funcsynopsis> + <para> + The <function>PDF_setgray_stroke</function> function sets the current + drawing color to the given gray value. + + <para> + See also <function>PDF_setrgbcolor_stroke</function>. + + </refsect1> + </refentry> + + <refentry id="function.pdf-setgray"> + <refnamediv> + <refname>PDF_setgray</refname> + <refpurpose>Sets drawing and filling color to gray value</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>void <function>pdf_setgray</function></funcdef> + <paramdef>pdfdoc <parameter>pdf document</parameter></paramdef> + <paramdef>double <parameter>gray value</parameter></paramdef> + </funcsynopsis> + <para> + The <function>PDF_setgray_stroke</function> function sets the current + drawing and filling color to the given gray value. + + <para> + See also <function>PDF_setrgbcolor_stroke</function>, + <function>PDF_setrgbcolor_fill</function>. + + </refsect1> + </refentry> + + <refentry id="function.pdf-setrgbcolor-fill"> + <refnamediv> + <refname>PDF_setrgbcolor_fill</refname> + <refpurpose>Sets filling color to rgb color value</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>void <function>pdf_setrgbcolor_fill</function></funcdef> + <paramdef>pdfdoc <parameter>pdf document</parameter></paramdef> + <paramdef>double <parameter>red value</parameter></paramdef> + <paramdef>double <parameter>green value</parameter></paramdef> + <paramdef>double <parameter>blue value</parameter></paramdef> + </funcsynopsis> + <para> + The <function>PDF_setrgbcolor_fill</function> function sets the current + rgb color value to fill a path. + + <para> + See also <function>PDF_setrgbcolor_fill</function>. + + </refsect1> + </refentry> + + <refentry id="function.pdf-setrgbcolor-stroke"> + <refnamediv> + <refname>PDF_setrgbcolor_stroke</refname> + <refpurpose>Sets drawing color to rgb color value</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>void <function>pdf_setrgbcolor_stroke</function></funcdef> + <paramdef>pdfdoc <parameter>pdf document</parameter></paramdef> + <paramdef>double <parameter>red value</parameter></paramdef> + <paramdef>double <parameter>green value</parameter></paramdef> + <paramdef>double <parameter>blue value</parameter></paramdef> + </funcsynopsis> + <para> + The <function>PDF_setrgbcolor_stroke</function> function sets the current + drawing color to the given rgb color value. + + <para> + See also <function>PDF_setrgbcolor_stroke</function>. + + </refsect1> + </refentry> + + <refentry id="function.pdf-setrgbcolor"> + <refnamediv> + <refname>PDF_setrgbcolor</refname> + <refpurpose>Sets drawing and filling color to rgb color value</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>void <function>pdf_setrgbcolor</function></funcdef> + <paramdef>pdfdoc <parameter>pdf document</parameter></paramdef> + <paramdef>double <parameter>red value</parameter></paramdef> + <paramdef>double <parameter>green value</parameter></paramdef> + <paramdef>double <parameter>blue value</parameter></paramdef> + </funcsynopsis> + <para> + The <function>PDF_setrgbcolor_stroke</function> function sets the current + drawing and filling color to the given rgb color value. + + <para> + See also <function>PDF_setrgbcolor_stroke</function>, + <function>PDF_setrgbcolor_fill</function>. + + </refsect1> + </refentry> + + <refentry id="function.pdf-add-outline"> + <refnamediv> + <refname>PDF_add_outline</refname> + <refpurpose>Add bookmark for current page</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>void <function>pdf_add_outline</function></funcdef> + <paramdef>pdfdoc <parameter>pdf document</parameter></paramdef> + <paramdef>string <parameter>text</parameter></paramdef> + </funcsynopsis> + <para> + The <function>PDF_add_outline</function> function adds a bookmark + with text <parameter>text</parameter> that points to the current page. + + </refsect1> + </refentry> + + <refentry id="function.pdf-set-transition"> + <refnamediv> + <refname>PDF_set_transition</refname> + <refpurpose>Set transition between pages</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>void <function>pdf_set_transition</function></funcdef> + <paramdef>pdfdoc <parameter>pdf document</parameter></paramdef> + <paramdef>int <parameter>transition</parameter></paramdef> + </funcsynopsis> + <para> + The <function>PDF_set_transition</function> function set the transition + between following pages. The value of <parameter>transition</parameter> + can be 0 for none, + 1 for two lines sweeping across the screen reveal the page, + 2 for multiple lines sweeping across the screen reveal the page, + 3 for a box reveals the page, + 4 for a single line sweeping across the screen reveals the page, + 5 for the old page dissolves to reveal the page, + 6 for the dissolve effect moves from one screen edge to another, + 7 for the old page is simply replaced by the new page (default) + + </refsect1> + </refentry> + + <refentry id="function.pdf-set-duration"> + <refnamediv> + <refname>PDF_set_duration</refname> + <refpurpose>Set duration between pages</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>void <function>pdf_set_duration</function></funcdef> + <paramdef>pdfdoc <parameter>pdf document</parameter></paramdef> + <paramdef>double <parameter>duration</parameter></paramdef> + </funcsynopsis> + <para> + The <function>PDF_set_duration</function> function set the duration + between following pages in seconds. </refsect1> </refentry> -- PHP Development Mailing List http://www.php.net/ To unsubscribe send an empty message to php-dev-unsubscribe@lists.php.net For help: php-dev-help@lists.php.net