CVS update: php3/doc/functions

Date: Monday October 26, 1998 @ 11:05 Author: steinm Update of /repository/php3/doc/functions In directory asf:/u2/tmp/cvs-serv25035/doc/functions Modified Files: pdf.sgml Log Message: more documentation and parameter checking Index: php3/doc/functions/pdf.sgml diff -c php3/doc/functions/pdf.sgml:1.2 php3/doc/functions/pdf.sgml:1.3 *** php3/doc/functions/pdf.sgml:1.2 Fri Oct 23 07:39:08 1998 --- php3/doc/functions/pdf.sgml Mon Oct 26 11:05:35 1998 *************** *** 553,558 **** --- 553,836 ---- </refsect1> </refentry> + <refentry id="function.pdf_continue_text"> + <refnamediv> + <refname>PDF_continue_text</refname> + <refpurpose>Output text in next line</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>void <function>pdf_continue_text</function></funcdef> + <paramdef>pdfdoc <parameter>pdf document</parameter></paramdef> + <paramdef>string <parameter>text</parameter></paramdef> + </funcsynopsis> + <para> + The <function>PDF_continue_text</function> function outputs the + string in <parameter>text</parameter> in the next line. + + <para> + See also <function>PDF_show_xy</function>, + <function>PDF_set_text_leading</function>, + <function>PDF_set_text_pos</function>. + + </refsect1> + </refentry> + + <refentry id="function.pdf_stringwidth"> + <refnamediv> + <refname>PDF_stringwidth</refname> + <refpurpose>Returns width of text</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>double <function>pdf_stringwidth</function></funcdef> + <paramdef>pdfdoc <parameter>pdf document</parameter></paramdef> + <paramdef>string <parameter>text</parameter></paramdef> + </funcsynopsis> + <para> + The <function>PDF_stringwidth</function> function returns the + width of the string in <parameter>text</parameter>. It requires + a font to be set before. + + <para> + See also <function>PDF_set_font</function>. + + </refsect1> + </refentry> + + <refentry id="function.pdf_save"> + <refnamediv> + <refname>PDF_save</refname> + <refpurpose>Returns width of text</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>void <function>pdf_save</function></funcdef> + <paramdef>pdfdoc <parameter>pdf document</parameter></paramdef> + </funcsynopsis> + <para> + The <function>PDF_save</function> function saves the current + enviroment. It works like the postscript command gsave. Very + useful if you want to translate or rotate an object without effecting + other objects. + + <para> + See also <function>PDF_restore</function>. + + </refsect1> + </refentry> + + <refentry id="function.pdf_restore"> + <refnamediv> + <refname>PDF_restore</refname> + <refpurpose>Returns width of text</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>void <function>pdf_restore</function></funcdef> + <paramdef>pdfdoc <parameter>pdf document</parameter></paramdef> + </funcsynopsis> + <para> + The <function>PDF_restore</function> function restores the + enviroment saved with <function>PDF_save</function>. It works + like the postscript command grestore. Very + useful if you want to translate or rotate an object without effecting + other objects. + + <example> + <title>PDF_get_info</title> + <programlisting> + &lt;?php PDF_save($pdf); + // do all kinds of rotations, transformations, ... + PDF_restore($pdf) ?> + </programlisting></example> + + <para> + See also <function>PDF_save</function>. + + </refsect1> + </refentry> + + <refentry id="function.pdf_translate"> + <refnamediv> + <refname>PDF_translate</refname> + <refpurpose>Sets origin of koordinate system</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>void <function>pdf_translate</function></funcdef> + <paramdef>pdfdoc <parameter>pdf document</parameter></paramdef> + <paramdef>double <parameter>x-koor</parameter></paramdef> + <paramdef>double <parameter>y-koor</parameter></paramdef> + </funcsynopsis> + <para> + The <function>PDF_translate</function> function set the origin of + koordinate system to the point (<parameter>x-koor</parameter>, + <parameter>y-koor</parameter>). + + </refsect1> + </refentry> + + <refentry id="function.pdf_scale"> + <refnamediv> + <refname>PDF_scale</refname> + <refpurpose>Sets scaling</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>void <function>pdf_scale</function></funcdef> + <paramdef>pdfdoc <parameter>pdf document</parameter></paramdef> + <paramdef>double <parameter>x-scale</parameter></paramdef> + <paramdef>double <parameter>y-scale</parameter></paramdef> + </funcsynopsis> + <para> + The <function>PDF_scale</function> function set the scaling factor + in both directions. + + </refsect1> + </refentry> + + <refentry id="function.pdf_rotate"> + <refnamediv> + <refname>PDF_rotate</refname> + <refpurpose>Sets rotation</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>void <function>pdf_rotate</function></funcdef> + <paramdef>pdfdoc <parameter>pdf document</parameter></paramdef> + <paramdef>double <parameter>angle</parameter></paramdef> + </funcsynopsis> + <para> + The <function>PDF_rotate</function> function set the rotation in + degress to <parameter>angle</parameter>. + + </refsect1> + </refentry> + + <refentry id="function.pdf_setflat"> + <refnamediv> + <refname>PDF_setflat</refname> + <refpurpose>Sets flatness</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>void <function>pdf_setflat</function></funcdef> + <paramdef>pdfdoc <parameter>pdf document</parameter></paramdef> + <paramdef>double <parameter>value</parameter></paramdef> + </funcsynopsis> + <para> + The <function>PDF_setflat</function> function set the flatness to + a value between 0 and 100. + + </refsect1> + </refentry> + + <refentry id="function.pdf_setlinejoin"> + <refnamediv> + <refname>PDF_setlinejoin</refname> + <refpurpose>Sets linejoin parameter</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>void <function>pdf_setlinejoin</function></funcdef> + <paramdef>pdfdoc <parameter>pdf document</parameter></paramdef> + <paramdef>long <parameter>value</parameter></paramdef> + </funcsynopsis> + <para> + The <function>PDF_setlinejoin</function> function set the linejoin + parameter between a value of 0 and 2. + + </refsect1> + </refentry> + + <refentry id="function.pdf_setlinecap"> + <refnamediv> + <refname>PDF_setlinecap</refname> + <refpurpose>Sets linecap aparameter</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>void <function>pdf_setlinecap</function></funcdef> + <paramdef>pdfdoc <parameter>pdf document</parameter></paramdef> + <paramdef>long <parameter>value</parameter></paramdef> + </funcsynopsis> + <para> + The <function>PDF_setlinecap</function> function set the linecap + parameter between a value of 0 and 2. + + </refsect1> + </refentry> + + <refentry id="function.pdf_setmiterlimit"> + <refnamediv> + <refname>PDF_setmiterlimit</refname> + <refpurpose>Sets linecap aparameter</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>void <function>pdf_setmiterlimit</function></funcdef> + <paramdef>pdfdoc <parameter>pdf document</parameter></paramdef> + <paramdef>double <parameter>value</parameter></paramdef> + </funcsynopsis> + <para> + The <function>PDF_setmiterlimit</function> function set the miter limit + to a value greater of equal than 1. + + </refsect1> + </refentry> + + <refentry id="function.pdf_setlinewidth"> + <refnamediv> + <refname>PDF_setlinewidth</refname> + <refpurpose>Sets line width</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>void <function>pdf_setlinewidth</function></funcdef> + <paramdef>pdfdoc <parameter>pdf document</parameter></paramdef> + <paramdef>double <parameter>width</parameter></paramdef> + </funcsynopsis> + <para> + The <function>PDF_setlinewidth</function> function set the line width + to <parameter>width</parameter>. + + </refsect1> + </refentry> + + <refentry id="function.pdf_setdash"> + <refnamediv> + <refname>PDF_setdash</refname> + <refpurpose>Sets dash pattern</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcdef>void <function>pdf_setdash</function></funcdef> + <paramdef>pdfdoc <parameter>pdf document</parameter></paramdef> + <paramdef>double <parameter>white</parameter></paramdef> + <paramdef>double <parameter>black</parameter></paramdef> + </funcsynopsis> + <para> + The <function>PDF_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. + + </refsect1> + </refentry> + </reference> <!-- Keep this comment at the end of the file -- 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