rjs Thu Mar 1 11:52:54 2001 EDT
Modified files:
/phpdoc/en/functions pdf.xml
Log:
- integrated new functions vor PDFlib V4.0 (beta1)
Index: phpdoc/en/functions/pdf.xml
diff -u phpdoc/en/functions/pdf.xml:1.35 phpdoc/en/functions/pdf.xml:1.36
--- phpdoc/en/functions/pdf.xml:1.35 Mon Feb 12 09:47:00 2001
+++ phpdoc/en/functions/pdf.xml Thu Mar 1 11:52:54 2001
@@ -572,6 +572,26 @@
</refsect1>
</refentry>
+ <refentry id="function.pdf-add-thumbnail">
+ <refnamediv>
+ <refname>PDF_add_thumbnail</refname>
+ <refpurpose>Adds thumbnail for current page</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>int <function>PDF_add_thumbnail</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>int <parameter>image</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ Add an existing image as thumbnail for the current page.
+ </para>
+ </refsect1>
+ </refentry>
+
<refentry id="function.pdf-add-weblink">
<refnamediv>
<refname>PDF_add_weblink</refname>
@@ -620,6 +640,30 @@
</refsect1>
</refentry>
+ <refentry id="function.pdf-arcn">
+ <refnamediv>
+ <refname>PDF_arcn</refname>
+ <refpurpose>Draws an arc</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>void <function>PDF_arc</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>double <parameter>x</parameter></paramdef>
+ <paramdef>double <parameter>y</parameter></paramdef>
+ <paramdef>double <parameter>r</parameter></paramdef>
+ <paramdef>double <parameter>alpha</parameter></paramdef>
+ <paramdef>double <parameter>beta</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ Draw a clockwise circular arc from alpha to beta degrees
+ </para>
+ </refsect1>
+ </refentry>
+
<refentry id="function.pdf-attach-file">
<refnamediv>
<refname>PDF_attach_file</refname>
@@ -670,6 +714,51 @@
</refsect1>
</refentry>
+ <refentry id="function.pdf-begin-pattern">
+ <refnamediv>
+ <refname>PDF_begin_pattern</refname>
+ <refpurpose>Starts new pattern</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>void <function>PDF_begin_pattern</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>double <parameter>width</parameter></paramdef>
+ <paramdef>double <parameter>height</parameter></paramdef>
+ <paramdef>double <parameter>xstep/parameter></paramdef>
+ <paramdef>double <parameter>ystep</parameter></paramdef>
+ <paramdef>int <parameter>painttype</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ Start a new pattern definition.
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.pdf-begin-template">
+ <refnamediv>
+ <refname>PDF_begin_template</refname>
+ <refpurpose>Starts new template</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>void <function>PDF_begin_template</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>double <parameter>width</parameter></paramdef>
+ <paramdef>double <parameter>height</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ Start a new template definition.
+ </para>
+ </refsect1>
+ </refentry>
+
<refentry id="function.pdf-circle">
<refnamediv>
<refname>PDF_circle</refname>
@@ -807,6 +896,51 @@
</refsect1>
</refentry>
+ <refentry id="function.pdf-close-pdi">
+ <refnamediv>
+ <refname>PDF_close_pdi</refname>
+ Close the input PDF document.
+ <refpurpose>
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>void <function>PDF_close_pdi</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>int <parameter>dochandle</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ Close all open page handles, and close the input PDF document.
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.pdf-close-pdi-page">
+ <refnamediv>
+ <refname>PDF_close_pdi_page</refname>
+ Close the page handle.
+ <refpurpose>
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>void <function>PDF_close_pdi_page</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>int <parameter>dochandle</parameter></paramdef>
+ <paramdef>int <parameter>pagehandle</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ Close the page handle, and free all page-related resources.
+ </para>
+ </refsect1>
+ </refentry>
+
<refentry id="function.pdf-concat">
<refnamediv>
<refname>PDF_concat</refname>
@@ -923,17 +1057,49 @@
</refnamediv>
<refsect1>
<title>Description</title>
+ <para>
+ Deprecated, use one of the stroke, fill, or clip functions instead.
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.pdf-endpattern">
+ <refnamediv>
+ <refname>PDF_endpattern</refname>
+ <refpurpose>Finish pattern</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>void <function>PDF_endpath</function></funcdef>
+ <funcdef>void <function>PDF_endpattern</function></funcdef>
<paramdef>int <parameter>pdf object</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- Deprecated, use one of the stroke, fill, or clip functions instead.
+ Finish the pattern definition.
</para>
</refsect1>
</refentry>
+
+ <refentry id="function.pdf-end-template">
+ <refnamediv>
+ <refname>PDF_end_template</refname>
+ <refpurpose>Finish template</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>void <function>PDF_end_template</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ Finish the template definition.
+ </para>
+ </refsect1>
+ </refentry>
<refentry id="function.pdf-fill">
<refnamediv>
@@ -1130,6 +1296,52 @@
</refsect1>
</refentry>
+ <refentry id="function.pdf-get-pdi-parameter">
+ <refnamediv>
+ <refname>PDF_get_pdi_parameter</refname>
+ <refpurpose>Get some PDI string parameters</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>string <function>PDF_get_pdi_parameter</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>string <parameter>key</parameter></paramdef>
+ <paramdef>int <parameter>doc</parameter></paramdef>
+ <paramdef>int <parameter>page</parameter></paramdef>
+ <paramdef>int <parameter>index</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ Get the contents of some PDI document parameter with string type.
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.pdf-get-pdi-value">
+ <refnamediv>
+ <refname>PDF_get_pdi_value</refname>
+ <refpurpose>Gets some PDI numerical parameters</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>string <function>PDF_get_pdi_value</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>string <parameter>key</parameter></paramdef>
+ <paramdef>int <parameter>doc</parameter></paramdef>
+ <paramdef>int <parameter>page</parameter></paramdef>
+ <paramdef>int <parameter>index</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ Get the contents of some PDI document parameter with numerical type.
+ </para>
+ </refsect1>
+ </refentry>
+
<refentry id="function.pdf-get-value">
<refnamediv>
<refname>PDF_get_value</refname>
@@ -1151,6 +1363,25 @@
</refsect1>
</refentry>
+ <refentry id="function.pdf-initgraphics">
+ <refnamediv>
+ <refname>PDF_initgraphics</refname>
+ <refpurpose>Resets graphic state</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>void <function>PDF_initgraphics</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ Reset all implicit color and graphics state parameters to their defaults.
+ </para>
+ </refsect1>
+ </refentry>
+
<refentry id="function.pdf-lineto">
<refnamediv>
<refname>PDF_lineto</refname>
@@ -1173,6 +1404,26 @@
</refsect1>
</refentry>
+ <refentry id="function.pdf-makespotcolor">
+ <refnamediv>
+ <refname>PDF_makespotcolor</refname>
+ <refpurpose>Makes a spotcolor</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>void <function>PDF_makespotcolor</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>string <parameter>spotname</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ Make a named spot color from the current color.
+ </para>
+ </refsect1>
+ </refentry>
+
<refentry id="function.pdf-moveto">
<refnamediv>
<refname>PDF_moveto</refname>
@@ -1372,6 +1623,54 @@
</refsect1>
</refentry>
+ <refentry id="function.pdf-open-pdi">
+ <refnamediv>
+ <refname>PDF_open_pdi</refname>
+ <refpurpose>
+ Opens a PDF file
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>void <function>PDF_open_pdi</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>string <parameter>filename</parameter></paramdef>
+ <paramdef>string <parameter>stringparam</parameter></paramdef>
+ <paramdef>int <parameter>intparam</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ Open an existing PDF document for later use.
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.pdf-open-pdi-page">
+ <refnamediv>
+ <refname>PDF_open_pdi_page</refname>
+ <refpurpose>
+ Prepare a page
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>void <function>PDF_open_pd_pagei</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>int <parameter>dochandle</parameter></paramdef>
+ <paramdef>int <parameter>pagenumber</parameter></paramdef>
+ <paramdef>string <parameter>pagelabel</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ Prepare a page for later use with <function>PDF_place_image</function>
+ </para>
+ </refsect1>
+ </refentry>
+
<refentry id="function.pdf-open-png">
<refnamediv>
<refname>PDF_open_png</refname>
@@ -1539,6 +1838,32 @@
</refsect1>
</refentry>
+ <refentry id="function.pdf-setcolor">
+ <refnamediv>
+ <refname>PDF_setcolor</refname>
+ <refpurpose>Sets fill and stroke color to CMYK values</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>void <function>PDF_secolor</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>string <parameter>type</parameter></paramdef>
+ <paramdef>string <parameter>colorspace</parameter></paramdef>
+ <paramdef>double <parameter>c1</parameter></paramdef>
+ <paramdef>double <parameter>c2</parameter></paramdef>
+ <paramdef>double <parameter>c3</parameter></paramdef>
+ <paramdef>double <parameter>c4</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ Set the current color space and color. type is "fill",
+ "stroke", or "both".
+ </para>
+ </refsect1>
+ </refentry>
+
<refentry id="function.pdf-setdash">
<refnamediv>
<refname>PDF_setdash</refname>
@@ -1620,6 +1945,11 @@
<para>
Set the current fill and stroke color.
</para>
+ <note>
+ <para>
+ PDFlib V4.0: Depreciated, use <function>PDF_setcolor</function> instead.
+ </para>
+ </note>
</refsect1>
</refentry>
@@ -1640,6 +1970,11 @@
<para>
Set the current fill color to a gray value between 0 and 1 inclusive.
</para>
+ <note>
+ <para>
+ PDFlib V4.0: Depreciated, use <function>PDF_setcolor</function> instead.
+ </para>
+ </note>
</refsect1>
</refentry>
@@ -1660,6 +1995,11 @@
<para>
Set the current stroke color to a gray value between 0 and 1 inclusive
</para>
+ <note>
+ <para>
+ PDFlib V4.0: Depreciated, use <function>PDF_setcolor</function> instead.
+ </para>
+ </note>
</refsect1>
</refentry>
@@ -1723,6 +2063,31 @@
</refsect1>
</refentry>
+ <refentry id="function.pdf-setmatrix">
+ <refnamediv>
+ <refname>PDF_setmatrix</refname>
+ <refpurpose>Sets current transformation matrix</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>void <function>PDF_setmatrix</function></funcdef>
+ <paramdef>int <parameter>pdf object</parameter></paramdef>
+ <paramdef>double <parameter>a</parameter></paramdef>
+ <paramdef>double <parameter>b</parameter></paramdef>
+ <paramdef>double <parameter>c</parameter></paramdef>
+ <paramdef>double <parameter>d</parameter></paramdef>
+ <paramdef>double <parameter>e</parameter></paramdef>
+ <paramdef>double <parameter>f</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ Explicitly set the current transformation matrix.
+ </para>
+ </refsect1>
+ </refentry>
+
<refentry id="function.pdf-setmiterlimit">
<refnamediv>
<refname>PDF_setmiterlimit</refname>
@@ -1782,6 +2147,11 @@
<para>
Set the current fill and stroke color to the supplied RGB values.
</para>
+ <note>
+ <para>
+ PDFlib V4.0: Depreciated, use <function>PDF_setcolor</function> instead.
+ </para>
+ </note>
</refsect1>
</refentry>
@@ -1804,6 +2174,11 @@
<para>
Set the current fill color to the supplied RGB values.
</para>
+ <note>
+ <para>
+ PDFlib V4.0: Depreciated, use <function>PDF_setcolor</function> instead.
+ </para>
+ </note>
</refsect1>
</refentry>
@@ -1826,9 +2201,14 @@
<para>
Set the current stroke color to the supplied RGB values.
</para>
+ <note>
+ <para>
+ PDFlib V4.0: Depreciated, use <function>PDF_setcolor</function> instead.
+ </para>
+ </note>
</refsect1>
</refentry>
-
+
<refentry id="function.pdf-set-border-color">
<refnamediv>
<refname>PDF_set_border_color</refname>
