CVS update: phpdoc/functions

Date: Wednesday June 30, 1999 @ 16:37 Author: steinm Update of /repository/phpdoc/functions In directory php:/tmp/cvs-serv5105/functions Modified Files: pdf.sgml Log Message: - some errors corrected. More examples Index: phpdoc/functions/pdf.sgml diff -u phpdoc/functions/pdf.sgml:1.5 phpdoc/functions/pdf.sgml:1.6 --- phpdoc/functions/pdf.sgml:1.5 Sat Jun 19 23:04:56 1999 +++ phpdoc/functions/pdf.sgml Wed Jun 30 16:37:36 1999 @@ -1711,13 +1711,29 @@ 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) + <simplelist> + <listitem> + 1 for two lines sweeping across the screen reveal the page, + </listitem> + <listitem> + 2 for multiple lines sweeping across the screen reveal the page, + </listitem> + <listitem> + 3 for a box reveals the page, + </listitem> + <listitem> + 4 for a single line sweeping across the screen reveals the page, + </listitem> + <listitem> + 5 for the old page dissolves to reveal the page, + </listitem> + <listitem> + 6 for the dissolve effect moves from one screen edge to another, + </listitem> + <listitem> + 7 for the old page is simply replaced by the new page (default) + </listitem> + </simplelist> </refsect1> </refentry> @@ -1748,14 +1764,26 @@ <refsect1> <title>Description</title> <funcsynopsis> - <funcdef>int <function>pdf_open_gifg</function></funcdef> + <funcdef>int <function>pdf_open_gif</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>string <parameter>file name</parameter></paramdef> + <paramdef>string <parameter>filename</parameter></paramdef> </funcsynopsis> <para> The <function>PDF_open_gif</function> function opens an image stored in the file with the name <parameter>file name</parameter>. The format of the image has to be jpeg. + + <example> + <title>Including a gif image</title> + <programlisting> +&lt;?php +$im = PDF_open_gif($pdf, "test.gif"); +pdf_place_image($pdf, $im, 100, 100, 1); +pdf_close_image($pdf, $im); +?> + </programlisting> + </example> + <para> See also <function>PDF_close_image</function>, <function>PDF_open_jpeg</function>, @@ -1782,6 +1810,21 @@ The <function>PDF_open_memory_image</function> function takes an image created with the PHP's image functions and makes it available for the pdf document. + + <example> + <title>Including a memory image</title> + <programlisting> +&lt;?php +$im = ImageCreate(100, 100); +$col = ImageColorAllocate($im, 80, 45, 190); +ImageFill($im, 10, 10, $col); +$pim = PDF_open_memory_image($pdf, $im); +pdf_place_image($pdf, $pim, 100, 100, 1); +pdf_close_image($pdf, $pim); +?> + </programlisting> + </example> + <para> See also <function>PDF_close_image</function>, <function>PDF_open_jpeg</function>, @@ -1802,7 +1845,7 @@ <funcsynopsis> <funcdef>int <function>pdf_open_jpeg</function></funcdef> <paramdef>int <parameter>pdf document</parameter></paramdef> - <paramdef>string <parameter>file name</parameter></paramdef> + <paramdef>string <parameter>filename</parameter></paramdef> </funcsynopsis> <para> The <function>PDF_open_jpeg</function> function opens an image stored @@ -1881,8 +1924,8 @@ The PDF_put_image function places an image in the PDF file without showing it. The stored image can be displayed with the <function>PDF_execute_image</function> - function. This is useful when using the same image multiple - times. + function as many times as needed. This is useful when using the same + image multiple times in order to keep the file size small. <para> See also <function>PDF_place_image</function>, <function>PDF_execute_image</function>. @@ -1911,6 +1954,23 @@ <para> The image can be scaled while displaying it. A scale of 1.0 will show the image in the original size. + + <example> + <title>Multiple show of an image</title> + <programlisting> +&lt;?php +$im = ImageCreate(100, 100); +$col1 = ImageColorAllocate($im, 80, 45, 190); +ImageFill($im, 10, 10, $col1); +$pim = PDF_open_memory_image($pdf, $im); +pdf_put_image($pdf, $pim); +pdf_execute_image($pdf, $pim, 100, 100, 1); +pdf_execute_image($pdf, $pim, 200, 200, 2); +pdf_close_image($pdf, $pim); +?> + </programlisting> + </example> + </refsect1> </refentry>