sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

fixing protos

Browse source 
unified deprecated functions layout
adding tags
adding some user notes and examples
corrected c/p errors
fixed some ugly WS
changed the pdf_object notation to pdfdoc to make it less confusing
(thank you philip ;))


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@137061 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour 2003-08-09 04:31:34 +00:00
parent d56392c250
commit 8cc28e49c2
115 changed files with 642 additions and 567 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
reference/pdf/functions/pdf-add-annotation.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-add-annotation">
<refnamediv>
@ -9,11 +9,8 @@
<refsect1>
<title>Description</title>
<para>
<function>pdf_add_outline</function> is replaced by
<function>pdf_add_note</function>
</para>
<para>
See also <function>pdf_add_note</function>.
This function is deprecated, use <function>pdf_add_note</function>
instead.
</para>
</refsect1>
</refentry>

44
reference/pdf/functions/pdf-add-bookmark.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-add-bookmark">
<refnamediv>
@ -10,7 +10,7 @@
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>pdf_add_bookmark</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>text</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>parent</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>open</parameter></methodparam>
@ -19,7 +19,45 @@
Add a nested bookmark under <parameter>parent</parameter>, or a new top-level
bookmark if <parameter>parent</parameter> = 0. Returns a bookmark descriptor
which may be used as parent for subsequent nested bookmarks.
If open = 1, child bookmarks will be folded out, and invisible if open = 0.
If <parameter>open</parameter> = 1, child bookmarks will be folded out, and
invisible if <parameter>open</parameter> = 0.
</para>
<para>
<example>
<title><function>pdf_add_bookmark</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// create a new PDF
$pdf = pdf_new();
pdf_open_file($pdf);
pdf_set_info($pdf, "Author","Bob Nijman");
// begin a new page
pdf_begin_page($pdf, 300, 300);
// add a top-level bookmark
$bookmark = pdf_add_bookmark($pdf, "People");
// add a nested bookmark
pdf_add_bookmark($pdf, "Rasmus", $bookmark);
// and some text
pdf_set_font($pdf, "Helvetica", 20, "host");
$text = "This is R's page";
$width = pdf_stringwidth($pdf, $text);
pdf_set_text_pos($pdf, (300-$width)/2, 100);
pdf_show($pdf, $text);
// close the page and the PDF
pdf_end_page($pdf);
pdf_close($pdf);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
</refentry>

12
reference/pdf/functions/pdf-add-launchlink.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-add-launchlink">
<refnamediv>
@ -9,8 +9,8 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>pdf_add_launchlink</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_add_launchlink</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>float</type><parameter>llx</parameter></methodparam>
<methodparam><type>float</type><parameter>lly</parameter></methodparam>
<methodparam><type>float</type><parameter>urx</parameter></methodparam>
@ -18,7 +18,11 @@
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
Add a launch annotation (to a target of arbitrary file type).
Adds a link to a web resource specified by <parameter>filename</parameter>.
&return.success;
</para>
<para>
See also <function>pdf_add_locallink</function>.
</para>
</refsect1>
</refentry>

26
reference/pdf/functions/pdf-add-locallink.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-add-locallink">
<refnamediv>
@ -9,17 +9,27 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>pdf_add_locallink</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<methodparam><type>float</type><parameter>llx</parameter></methodparam>
<methodparam><type>float</type><parameter>lly</parameter></methodparam>
<methodparam><type>float</type><parameter>urx</parameter></methodparam>
<methodparam><type>float</type><parameter>ury</parameter></methodparam>
<type>bool</type><methodname>pdf_add_locallink</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>float</type><parameter>lowerleftx</parameter></methodparam>
<methodparam><type>float</type><parameter>lowerlefty</parameter></methodparam>
<methodparam><type>float</type><parameter>upperrightx</parameter></methodparam>
<methodparam><type>float</type><parameter>upperrighty</parameter></methodparam>
<methodparam><type>int</type><parameter>page</parameter></methodparam>
<methodparam><type>string</type><parameter>dest</parameter></methodparam>
</methodsynopsis>
<para>
Add a link annotation to a target within the current PDF file.
Add a link annotation to a target within the current PDF file.
&return.success;
</para>
<para>
<parameter>dest</parameter> is the zoom setting on the destination page,
it can be one of <literal>retain</literal>, <literal>fitpage</literal>,
<literal>fitwidth</literal>, <literal>fitheight</literal> or
<literal>fitbbox</literal>.
</para>
<para>
See also <function>pdf_add_launchlink</function>.
</para>
</refsect1>
</refentry>

14
reference/pdf/functions/pdf-add-note.xml
View file

@ -1,16 +1,16 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-add-note">
<refnamediv>
<refname>pdf_add_note</refname>
<refpurpose>Add a note annotation for current page</refpurpose>
<refpurpose>Sets annotation for current page</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>pdf_add_note</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_add_note</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>float</type><parameter>llx</parameter></methodparam>
<methodparam><type>float</type><parameter>lly</parameter></methodparam>
<methodparam><type>float</type><parameter>urx</parameter></methodparam>
@ -21,8 +21,10 @@
<methodparam><type>int</type><parameter>open</parameter></methodparam>
</methodsynopsis>
<para>
Add a note annotation. icon is one of of "comment, "insert", "note",
"paragraph", "newparagraph", "key", or "help".
Sets an annotation for the current page. <parameter>icon</parameter> is one of
<literal>comment</literal>, <literal>insert</literal>, <literal>note</literal>,
<literal>paragraph</literal>, <literal>newparagraph</literal>,
<literal>key</literal>, or <literal>help</literal>. &return.success;
</para>
</refsect1>
</refentry>

8
reference/pdf/functions/pdf-add-outline.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-add-outline">
<refnamediv>
@ -9,10 +9,8 @@
<refsect1>
<title>Description</title>
<para>
Deprecated.
</para>
<para>
See <function>pdf_add_bookmark</function>.
This function is deprecated, use <function>pdf_add_bookmark</function>
instead.
</para>
</refsect1>
</refentry>

21
reference/pdf/functions/pdf-add-pdflink.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-add-pdflink">
<refnamediv>
@ -9,18 +9,23 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>pdf_add_pdflink</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<methodparam><type>float</type><parameter>llx</parameter></methodparam>
<methodparam><type>float</type><parameter>lly</parameter></methodparam>
<methodparam><type>float</type><parameter>urx</parameter></methodparam>
<methodparam><type>float</type><parameter>ury</parameter></methodparam>
<type>bool</type><methodname>pdf_add_pdflink</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>float</type><parameter>bottom_left_x</parameter></methodparam>
<methodparam><type>float</type><parameter>bottom_left_y</parameter></methodparam>
<methodparam><type>float</type><parameter>up_right_x</parameter></methodparam>
<methodparam><type>float</type><parameter>up_right_y</parameter></methodparam>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam><type>int</type><parameter>page</parameter></methodparam>
<methodparam><type>string</type><parameter>dest</parameter></methodparam>
</methodsynopsis>
<para>
Add a file link annotation (to a PDF target).
Add a file link annotation (to a PDF target).
&return.success;
</para>
<para>
See also <function>pdf_add_locallink</function> and
<function>pdf_add_weblink</function>.
</para>
</refsect1>
</refentry>

9
reference/pdf/functions/pdf-add-thumbnail.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-add-thumbnail">
<refnamediv>
@ -9,12 +9,13 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>pdf_add_thumbnail</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_add_thumbnail</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>int</type><parameter>image</parameter></methodparam>
</methodsynopsis>
<para>
Add an existing image as thumbnail for the current page.
Adds an existing image as thumbnail for the current page.
&return.success;
</para>
</refsect1>
</refentry>

17
reference/pdf/functions/pdf-add-weblink.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-add-weblink">
<refnamediv>
@ -9,16 +9,17 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>pdf_add_weblink</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<methodparam><type>float</type><parameter>llx</parameter></methodparam>
<methodparam><type>float</type><parameter>lly</parameter></methodparam>
<methodparam><type>float</type><parameter>urx</parameter></methodparam>
<methodparam><type>float</type><parameter>ury</parameter></methodparam>
<type>bool</type><methodname>pdf_add_weblink</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>float</type><parameter>lowerleftx</parameter></methodparam>
<methodparam><type>float</type><parameter>lowerlefty</parameter></methodparam>
<methodparam><type>float</type><parameter>upperrightx</parameter></methodparam>
<methodparam><type>float</type><parameter>upperrighty</parameter></methodparam>
<methodparam><type>string</type><parameter>url</parameter></methodparam>
</methodsynopsis>
<para>
Add a weblink annotation to a target URL on the Web.
Add a weblink annotation to a target <parameter>url</parameter> on the Web.
&return.success;
</para>
</refsect1>
</refentry>

18
reference/pdf/functions/pdf-arc.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.65 -->
<refentry id="function.pdf-arc">
<refnamediv>
@ -9,8 +9,8 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_arc</methodname>
<methodparam><type>resource</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_arc</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>float</type><parameter>x</parameter></methodparam>
<methodparam><type>float</type><parameter>y</parameter></methodparam>
<methodparam><type>float</type><parameter>r</parameter></methodparam>
@ -18,11 +18,15 @@
<methodparam><type>float</type><parameter>beta</parameter></methodparam>
</methodsynopsis>
<para>
Draw a counterclockwise circular arc from alpha to beta degrees
Draw a counterclockwise circular arc with center (<parameter>x</parameter>,
<parameter>y</parameter>) and radius <parameter>r</parameter> from
<parameter>alpha</parameter> to <parameter>beta</parameter> degrees.
&return.success;
</para>
<para>
See also: <function>pdf_arcn</function>
</para>
<para>
See also <function>pdf_arcn</function> and
<function>pdf_circle</function>.
</para>
</refsect1>
</refentry>

18
reference/pdf/functions/pdf-arcn.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-arcn">
<refnamediv>
@ -9,8 +9,8 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_arcn</methodname>
<methodparam><type>resource</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_arcn</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>float</type><parameter>x</parameter></methodparam>
<methodparam><type>float</type><parameter>y</parameter></methodparam>
<methodparam><type>float</type><parameter>r</parameter></methodparam>
@ -18,11 +18,15 @@
<methodparam><type>float</type><parameter>beta</parameter></methodparam>
</methodsynopsis>
<para>
Draw a clockwise circular arc from alpha to beta degrees
Draw a clockwise circular arc with center (<parameter>x</parameter>,
<parameter>y</parameter>) and radius <parameter>r</parameter> from
<parameter>alpha</parameter> to <parameter>beta</parameter> degrees.
&return.success;
</para>
<para>
See also <function>pdf_arc</function> and
<function>pdf_circle</function>.
</para>
<para>
See also: <function>pdf_arc</function>
</para>
</refsect1>
</refentry>

13
reference/pdf/functions/pdf-attach-file.xml
View file

@ -1,16 +1,16 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-attach-file">
<refnamediv>
<refname>pdf_attach_file</refname>
<refpurpose>Adds a file attachement for current page</refpurpose>
<refpurpose>Adds a file attachment for current page</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>pdf_attach_file</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_attach_file</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>float</type><parameter>llx</parameter></methodparam>
<methodparam><type>float</type><parameter>lly</parameter></methodparam>
<methodparam><type>float</type><parameter>urx</parameter></methodparam>
@ -22,8 +22,9 @@
<methodparam><type>string</type><parameter>icon</parameter></methodparam>
</methodsynopsis>
<para>
Add a file attachment annotation. icon is one of "graph,
"paperclip", "pushpin", or "tag".
Add a file attachment annotation. <parameter>icon</parameter> is one of
<literal>graph</literal>, <literal>paperclip</literal>,
<literal>pushpin</literal>, or <literal>tag</literal>. &return.success;
</para>
<note>
<para>

15
reference/pdf/functions/pdf-begin-page.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-begin-page">
<refnamediv>
@ -9,15 +9,15 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_begin_page</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_begin_page</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>float</type><parameter>width</parameter></methodparam>
<methodparam><type>float</type><parameter>height</parameter></methodparam>
</methodsynopsis>
<para>
Add a new page to the document. The <parameter>width</parameter>
and <parameter>height</parameter> are specified in points, which are
1/72 of an inch.
Add a new page to the document. &return.success;
The <parameter>width</parameter> and <parameter>height</parameter> are
specified in points, which are 1/72 of an inch.
</para>
<para>
<table>
@ -82,6 +82,9 @@
</tgroup>
</table>
</para>
<para>
See also <function>pdf_end_page</function>.
</para>
</refsect1>
</refentry>

7
reference/pdf/functions/pdf-begin-pattern.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-begin-pattern">
<refnamediv>
@ -10,7 +10,7 @@
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>pdf_begin_pattern</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>float</type><parameter>width</parameter></methodparam>
<methodparam><type>float</type><parameter>height</parameter></methodparam>
<methodparam><type>float</type><parameter>xstep</parameter></methodparam>
@ -26,6 +26,9 @@
own colour settings whereas a value of 2 indicates that the current
colour is used when the pattern is applied.
</para>
<para>
See also <function>pdf_end_pattern</function>.
</para>
</refsect1>
</refentry>

4
reference/pdf/functions/pdf-begin-template.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-begin-template">
<refnamediv>
@ -10,7 +10,7 @@
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>pdf_begin_template</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>float</type><parameter>width</parameter></methodparam>
<methodparam><type>float</type><parameter>height</parameter></methodparam>
</methodsynopsis>

13
reference/pdf/functions/pdf-circle.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-circle">
<refnamediv>
@ -9,14 +9,19 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_circle</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_circle</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>float</type><parameter>x</parameter></methodparam>
<methodparam><type>float</type><parameter>y</parameter></methodparam>
<methodparam><type>float</type><parameter>r</parameter></methodparam>
</methodsynopsis>
<para>
Draw a circle with center (x, y) and radius r.
Draw a circle with center (<parameter>x</parameter>, <parameter>y</parameter>)
and radius <parameter>r</parameter>. &return.success;
</para>
<para>
See also <function>pdf_arc</function> and
<function>pdf_arcn</function>.
</para>
</refsect1>
</refentry>

8
reference/pdf/functions/pdf-clip.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-clip">
<refnamediv>
@ -9,11 +9,11 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_clip</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_clip</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
</methodsynopsis>
<para>
Use the current path as clipping path.
Use the current path as clipping path. &return.success;
</para>
</refsect1>
</refentry>

8
reference/pdf/functions/pdf-close-image.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-close-image">
<refnamediv>
@ -10,12 +10,12 @@
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_close_image</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>int</type><parameter>image</parameter></methodparam>
</methodsynopsis>
<para>
Close an <parameter>image</parameter> retrieved with one of the
<function>pdf_open_image*</function> functions.
Close an <parameter>image</parameter> retrieved with the
<function>pdf_open_image</function> function.
</para>
</refsect1>
</refentry>

8
reference/pdf/functions/pdf-close-pdi-page.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-close-pdi-page">
<refnamediv>
@ -11,12 +11,12 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_close_pdi_page</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_close_pdi_page</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>int</type><parameter>pagehandle</parameter></methodparam>
</methodsynopsis>
<para>
Close the page handle, and free all page-related resources.
Close the page handle, and free all page-related resources. &return.success;
</para>
</refsect1>
</refentry>

11
reference/pdf/functions/pdf-close-pdi.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-close-pdi">
<refnamediv>
@ -11,12 +11,15 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_close_pdi</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_close_pdi</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>int</type><parameter>dochandle</parameter></methodparam>
</methodsynopsis>
<para>
Close all open page handles, and close the input PDF document.
Close all open page handles, and close the input PDF document. &return.success;
</para>
<para>
See also <function>pdf_open_pdi</function>.
</para>
</refsect1>
</refentry>

14
reference/pdf/functions/pdf-close.xml
View file

@ -1,19 +1,23 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-close">
<refnamediv>
<refname>pdf_close</refname>
<refpurpose>Closes a pdf object</refpurpose>
<refpurpose>Closes a pdf resource</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_close</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_close</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
</methodsynopsis>
<para>
Close the generated PDF file, and free all document-related resources.
Close the generated PDF file, and free all document-related resources.
&return.success;
</para>
<para>
See also <function>pdf_new</function>.
</para>
</refsect1>
</refentry>

12
reference/pdf/functions/pdf-closepath-fill-stroke.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-closepath-fill-stroke">
<refnamediv>
@ -9,11 +9,15 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_closepath_fill_stroke</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_closepath_fill_stroke</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
</methodsynopsis>
<para>
Close the path, fill, and stroke it.
Close the path, fill, and stroke it. &return.success;
</para>
<para>
See also <function>pdf_closepath</function> and
<function>pdf_closepath_stroke</function>.
</para>
</refsect1>
</refentry>

12
reference/pdf/functions/pdf-closepath-stroke.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-closepath-stroke">
<refnamediv>
@ -9,11 +9,15 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_closepath_stroke</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_closepath_stroke</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
</methodsynopsis>
<para>
Close the path, and stroke it.
Close the path, and stroke it. &return.success;
</para>
<para>
See also <function>pdf_closepath</function> and
<function>pdf_closepath_fil_stroke</function>.
</para>
</refsect1>
</refentry>

12
reference/pdf/functions/pdf-closepath.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-closepath">
<refnamediv>
@ -9,11 +9,15 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_closepath</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_closepath</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
</methodsynopsis>
<para>
Close the current path.
Close the current path. &return.success;
</para>
<para>
See also <function>pdf_closepath_stroke</function> and
<function>pdf_closepath_fil_stroke</function>.
</para>
</refsect1>
</refentry>

8
reference/pdf/functions/pdf-concat.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-concat">
<refnamediv>
@ -9,8 +9,8 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_concat</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_concat</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>float</type><parameter>a</parameter></methodparam>
<methodparam><type>float</type><parameter>b</parameter></methodparam>
<methodparam><type>float</type><parameter>c</parameter></methodparam>
@ -19,7 +19,7 @@
<methodparam><type>float</type><parameter>f</parameter></methodparam>
</methodsynopsis>
<para>
Concatenate a matrix to the CTM.
Concatenate a matrix to the CTM. &return.success;
</para>
</refsect1>
</refentry>

9
reference/pdf/functions/pdf-continue-text.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-continue-text">
<refnamediv>
@ -9,13 +9,12 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_continue_text</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_continue_text</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>text</parameter></methodparam>
</methodsynopsis>
<para>
Print text at the next line. The spacing between lines is determined
by the <parameter>leading</parameter> parameter.
Print <parameter>text</parameter> at the next line. &return.success;
</para>
</refsect1>
</refentry>

9
reference/pdf/functions/pdf-curveto.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-curveto">
<refnamediv>
@ -9,8 +9,8 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_curveto</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_curveto</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>float</type><parameter>x1</parameter></methodparam>
<methodparam><type>float</type><parameter>y1</parameter></methodparam>
<methodparam><type>float</type><parameter>x2</parameter></methodparam>
@ -19,7 +19,8 @@
<methodparam><type>float</type><parameter>y3</parameter></methodparam>
</methodsynopsis>
<para>
Draw a Bezier curve from the current point, using 3 more control points.
Draw a Bezier curve from the current point, using 3 more control points.
&return.success;
</para>
</refsect1>
</refentry>

11
reference/pdf/functions/pdf-delete.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-delete">
<refnamediv>
@ -9,11 +9,14 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_delete</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_delete</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
</methodsynopsis>
<para>
Delete the PDF object, and free all internal resources.
Delete the PDF resource, and free all internal resources. &return.success;
</para>
<para>
See also <function>pdf_new</function>.
</para>
</refsect1>
</refentry>

11
reference/pdf/functions/pdf-end-page.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-end-page">
<refnamediv>
@ -9,11 +9,14 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_end_page</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_end_page</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
</methodsynopsis>
<para>
Finish the page.
Finish the page. &return.success;
</para>
<para>
See also <function>pdf_begin_page</function>.
</para>
</refsect1>
</refentry>

11
reference/pdf/functions/pdf-end-pattern.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-end-pattern">
<refnamediv>
@ -9,11 +9,14 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_end_pattern</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_end_pattern</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
</methodsynopsis>
<para>
Finish the pattern definition.
Finish the pattern definition. &return.success;
</para>
<para>
See also <function>pdf_begin_pattern</function>.
</para>
</refsect1>
</refentry>

8
reference/pdf/functions/pdf-end-template.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-end-template">
<refnamediv>
@ -9,11 +9,11 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_end_template</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_end_template</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
</methodsynopsis>
<para>
Finish the template definition.
Finish the template definition. &return.success;
</para>
</refsect1>
</refentry>

6
reference/pdf/functions/pdf-endpath.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-endpath">
<refnamediv>
@ -9,7 +9,9 @@
<refsect1>
<title>Description</title>
<para>
Deprecated, use one of the stroke, fill, or clip functions instead.
This function is deprecated, use one of the
<function>pdf_stroke</function>, <function>pdf_clip</function> or
<function>pdf_closepath_fill_stroke</function> functions instead.
</para>
</refsect1>
</refentry>

12
reference/pdf/functions/pdf-fill-stroke.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-fill-stroke">
<refnamediv>
@ -9,11 +9,15 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_fill_stroke</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_fill_stroke</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
</methodsynopsis>
<para>
Fill and stroke the path with the current fill and stroke color.
Fill and stroke the path with the current fill and stroke color.
&return.success;
</para>
<para>
See also <function>pdf_setcolor</function>.
</para>
</refsect1>
</refentry>

19
reference/pdf/functions/pdf-findfont.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-findfont">
<refnamediv>
@ -10,18 +10,19 @@
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>pdf_findfont</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>fontname</parameter></methodparam>
<methodparam><type>string</type><parameter>encoding</parameter></methodparam>
<methodparam><type>int</type><parameter>embed</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>embed</parameter></methodparam>
</methodsynopsis>
<para>
Prepare a font for later use with <function>pdf_setfont</function>.
The metrics will be loaded, and if embed is nonzero, the font file
will be checked, but not yet
used. <parameter>encoding</parameter> is one of "builtin",
"macroman", "winansi", "host", or a user-defined encoding name,
or the name of a CMap.
Prepare a font for later use with <function>pdf_setfont</function>.
The metrics will be loaded, and if <parameter>embed</parameter> is
nonzero, the font file will be checked, but not yet used.
<parameter>encoding</parameter> is one of <literal>builtin</literal>,
<literal>macroman</literal>, <literal>winansi</literal>,
<literal>host</literal>, a user-defined encoding name or the name of
a CMap.
</para>
<para>
<function>pdf_findfont</function> returns a font handle or &false;

4
reference/pdf/functions/pdf-get-buffer.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-get-buffer">
<refnamediv>
@ -10,7 +10,7 @@
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>pdf_get_buffer</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
</methodsynopsis>
<para>
Get the contents of the PDF output buffer. The result must be

8
reference/pdf/functions/pdf-get-font.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-get-font">
<refnamediv>
@ -9,10 +9,8 @@
<refsect1>
<title>Description</title>
<para>
Deprecated.
</para>
<para>
See <function>pdf_get_value</function>.
This function is deprecated, use <function>pdf_get_value</function>
instead.
</para>
</refsect1>
</refentry>

8
reference/pdf/functions/pdf-get-fontname.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-get-fontname">
<refnamediv>
@ -9,10 +9,8 @@
<refsect1>
<title>Description</title>
<para>
Deprecated.
</para>
<para>
See <function>pdf_get_parameter</function>.
This function is deprecated, use <function>pdf_get_parameter</function>
instead.
</para>
</refsect1>
</refentry>

8
reference/pdf/functions/pdf-get-fontsize.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-get-fontsize">
<refnamediv>
@ -9,10 +9,8 @@
<refsect1>
<title>Description</title>
<para>
Deprecated.
</para>
<para>
See <function>pdf_get_value</function>.
This function is deprecated, use <function>pdf_get_value</function>
instead.
</para>
</refsect1>
</refentry>

13
reference/pdf/functions/pdf-get-image-height.xml
View file

@ -1,21 +1,16 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-get-image-height">
<refnamediv>
<refname>pdf_get_image_height</refname>
<refpurpose>Returns height of an image</refpurpose>
<refpurpose>Deprecated: returns height of an image</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>pdf_get_image_height</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<methodparam><type>int</type><parameter>image</parameter></methodparam>
</methodsynopsis>
<para>
<function>pdf_get_image_height</function> is deprecated,
use <function>pdf_get_value</function> instead.
This function is deprecated, use <function>pdf_get_value</function>
instead.
</para>
</refsect1>
</refentry>

13
reference/pdf/functions/pdf-get-image-width.xml
View file

@ -1,21 +1,16 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-get-image-width">
<refnamediv>
<refname>pdf_get_image_width</refname>
<refpurpose>Returns width of an image</refpurpose>
<refpurpose>Deprecated: Returns width of an image</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>pdf_get_image_width</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<methodparam><type>int</type><parameter>image</parameter></methodparam>
</methodsynopsis>
<para>
The <function>pdf_get_image_width</function> is deprecated,
use <function>pdf_get_value</function> instead.
This function is deprecated, use <function>pdf_get_value</function>
instead.
</para>
</refsect1>
</refentry>

5
reference/pdf/functions/pdf-get-majorversion.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.72 -->
<refentry id='function.pdf-get-majorversion'>
<refnamediv>
@ -17,6 +17,9 @@
<para>
Returns the major version number of the PDFlib.
</para>
<para>
See also <function>pdf_get_minorversion</function>.
</para>
</refsect1>
</refentry>

7
reference/pdf/functions/pdf-get-minorversion.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.72 -->
<refentry id='function.pdf-get-minorversion'>
<refnamediv>
@ -11,12 +11,15 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>pdf_get_majorversion</methodname>
<type>int</type><methodname>pdf_get_minorversion</methodname>
<void/>
</methodsynopsis>
<para>
Returns the minor version number of the PDFlib.
</para>
<para>
See also <function>pdf_get_majorversion</function>.
</para>
</refsect1>
</refentry>

4
reference/pdf/functions/pdf-get-parameter.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-get-parameter">
<refnamediv>
@ -10,7 +10,7 @@
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>pdf_get_parameter</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam choice="opt"><type>float</type><parameter>modifier</parameter></methodparam>
</methodsynopsis>

9
reference/pdf/functions/pdf-get-pdi-parameter.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-get-pdi-parameter">
<refnamediv>
@ -10,14 +10,15 @@
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>pdf_get_pdi_parameter</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>int</type><parameter>doc</parameter></methodparam>
<methodparam><type>int</type><parameter>document</parameter></methodparam>
<methodparam><type>int</type><parameter>page</parameter></methodparam>
<methodparam><type>int</type><parameter>index</parameter></methodparam>
</methodsynopsis>
<para>
Get the contents of some PDI document parameter with string type.
Get the contents of some PDI <parameter>document</parameter> parameter
with string type.
</para>
</refsect1>
</refentry>

4
reference/pdf/functions/pdf-get-pdi-value.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-get-pdi-value">
<refnamediv>
@ -10,7 +10,7 @@
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>pdf_get_pdi_value</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>int</type><parameter>doc</parameter></methodparam>
<methodparam><type>int</type><parameter>page</parameter></methodparam>

4
reference/pdf/functions/pdf-get-value.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-get-value">
<refnamediv>
@ -10,7 +10,7 @@
<title>Description</title>
<methodsynopsis>
<type>float</type><methodname>pdf_get_value</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam choice="opt"><type>float</type><parameter>modifier</parameter></methodparam>
</methodsynopsis>

9
reference/pdf/functions/pdf-initgraphics.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-initgraphics">
<refnamediv>
@ -9,11 +9,12 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_initgraphics</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_initgraphics</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
</methodsynopsis>
<para>
Reset all implicit color and graphics state parameters to their defaults.
Reset all implicit color and graphics state parameters to their defaults.
&return.success;
</para>
</refsect1>
</refentry>

10
reference/pdf/functions/pdf-lineto.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-lineto">
<refnamediv>
@ -9,14 +9,14 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_lineto</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_lineto</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>float</type><parameter>x</parameter></methodparam>
<methodparam><type>float</type><parameter>y</parameter></methodparam>
</methodsynopsis>
<para>
Draw a line from the current point to (<parameter>x</parameter>,
<parameter>y</parameter>).
Draw a line from the current point to (<parameter>x</parameter>,
<parameter>y</parameter>). &return.success;
</para>
</refsect1>
</refentry>

11
reference/pdf/functions/pdf-makespotcolor.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-makespotcolor">
<refnamediv>
@ -9,12 +9,15 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_makespotcolor</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_makespotcolor</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>spotname</parameter></methodparam>
</methodsynopsis>
<para>
Make a named spot color from the current color.
Make a named spot color from the current color. &return.success;
</para>
<para>
See also <function>pdf_setcolor</function>.
</para>
</refsect1>
</refentry>

9
reference/pdf/functions/pdf-moveto.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-moveto">
<refnamediv>
@ -9,13 +9,14 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_moveto</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_moveto</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>float</type><parameter>x</parameter></methodparam>
<methodparam><type>float</type><parameter>y</parameter></methodparam>
</methodsynopsis>
<para>
Set the current point.
Set the current point to (<parameter>x</parameter>, <parameter>y</parameter>.
&return.success;
</para>
<note>
<para>

11
reference/pdf/functions/pdf-new.xml
View file

@ -1,21 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-new">
<refnamediv>
<refname>pdf_new</refname>
<refpurpose>Creates a new pdf object</refpurpose>
<refpurpose>Creates a new pdf resource</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>pdf_new</methodname>
<type>resource</type><methodname>pdf_new</methodname>
<methodparam><parameter/></methodparam>
</methodsynopsis>
<para>
Create a new PDF object, using default error handling
Create a new PDF resource, using default error handling
and memory management.
</para>
<para>
See also <function>pdf_close</function>.
</para>
</refsect1>
</refentry>

4
reference/pdf/functions/pdf-open-ccitt.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-open-ccitt">
<refnamediv>
@ -10,7 +10,7 @@
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>pdf_open_CCITT</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam><type>int</type><parameter>width</parameter></methodparam>
<methodparam><type>int</type><parameter>height</parameter></methodparam>

16
reference/pdf/functions/pdf-open-file.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-open-file">
<refnamediv>
@ -9,16 +9,16 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>pdf_open_file</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_open_file</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
Create a new PDF file using the supplied file name.
If <parameter>filename</parameter> is empty the PDF document
will be generated in memory instead of on file. The result
must be fetched by the client with the
<function>pdf_get_buffer</function> function.
Create a new PDF file using the supplied file name.
If <parameter>filename</parameter> is empty the PDF document
will be generated in memory instead of on file. The result
must be fetched by the client with the
<function>pdf_get_buffer</function> function. &return.success;
</para>
<para>
The following example shows how to create a pdf document in memory

8
reference/pdf/functions/pdf-open-gif.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-open-gif">
<refnamediv>
@ -9,10 +9,8 @@
<refsect1>
<title>Description</title>
<para>
Deprecated.
</para>
<para>
See <function>pdf_open_image</function>,
This function is deprecated, use <function>pdf_open_image</function>
instead.
</para>
</refsect1>
</refentry>

12
reference/pdf/functions/pdf-open-image-file.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-open-image-file">
<refnamediv>
@ -10,16 +10,18 @@
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>pdf_open_image_file</methodname>
<methodparam><type>int</type><parameter>PDF-document</parameter></methodparam>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>imagetype</parameter></methodparam>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>stringparam</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>intparam</parameter></methodparam>
</methodsynopsis>
<para>
Open an image file. Supported types are "jpeg", "tiff", "gif",
and "png". <parameter>stringparam</parameter> is either
"", "mask", "masked", or "page".
Open an image file. Supported types are <literal>jpeg</literal>,
<literal>tiff</literal>, <literal>gif</literal>, and <literal>png</literal>.
<parameter>stringparam</parameter> is either <literal></literal>,
<literal>mask</literal>, <literal>masked</literal>, or
<literal>page</literal>.
<parameter>intparam</parameter>is either 0, the image id
of the applied mask, or the page.
</para>

14
reference/pdf/functions/pdf-open-image.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-open-image">
<refnamediv>
@ -10,7 +10,7 @@
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>pdf_open_image</methodname>
<methodparam><type>int</type><parameter>PDF-document</parameter></methodparam>
<methodparam><type>resource</type><parameter>PDF-document</parameter></methodparam>
<methodparam><type>string</type><parameter>imagetype</parameter></methodparam>
<methodparam><type>string</type><parameter>source</parameter></methodparam>
<methodparam><type>string</type><parameter>data</parameter></methodparam>
@ -22,10 +22,12 @@
<methodparam><type>string</type><parameter>params</parameter></methodparam>
</methodsynopsis>
<para>
Use image data from a variety of data sources. Supported types are
"jpeg", "ccitt", "raw". Supported sources are "memory", "fileref",
"url". len is only used for type="raw", params is only
used for type="ccitt".
Use image data from a variety of data sources. Supported types are
<literal>jpeg</literal>, <literal>ccitt</literal>, <literal>raw</literal>.
Supported sources are <literal>memory</literal>, <literal>fileref</literal>,
<literal>url</literal>. <parameter>len</parameter> is only used when type is
<literal>raw</literal>, <parameter>params</parameter> is only used when type
is <literal>ccitt</literal>.
</para>
</refsect1>
</refentry>

8
reference/pdf/functions/pdf-open-jpeg.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-open-jpeg">
<refnamediv>
@ -9,10 +9,8 @@
<refsect1>
<title>Description</title>
<para>
Deprecated.
</para>
<para>
See also <function>pdf_open_image</function>,
This function is deprecated, use <function>pdf_open_image</function>
instead.
</para>
</refsect1>
</refentry>

31
reference/pdf/functions/pdf-open-memory-image.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.48 -->
<refentry id="function.pdf-open-memory-image">
<refnamediv>
@ -10,34 +10,35 @@
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>pdf_open_memory_image</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<methodparam><type>int</type><parameter>image</parameter></methodparam>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>resource</type><parameter>image</parameter></methodparam>
</methodsynopsis>
<para>
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 object. The function returns a pdf
image identifier.
an <parameter>image</parameter> created with the PHP's image
functions and makes it available for the pdf resource.
The function returns a pdf image identifier.
<example>
<title>Including a memory image</title>
<programlisting>
<programlisting role="php">
<![CDATA[
<?php
$im = ImageCreate(100, 100);
$col = ImageColorAllocate($im, 80, 45, 190);
ImageFill($im, 10, 10, $col);
$im = imagecreate(100, 100);
$col = imagecolorallocate($im, 80, 45, 190);
imagefill($im, 10, 10, $col);
$pim = pdf_open_memory_image($pdf, $im);
ImageDestroy($im);
imagedestroy($im);
pdf_place_image($pdf, $pim, 100, 100, 1);
pdf_close_image($pdf, $pim);
?>
]]>
</programlisting>
</example></para>
</example>
</para>
<para>
See also <function>pdf_close_image</function>,
<function>pdf_place_image</function>.</para>
See also <function>pdf_close_image</function> and
<function>pdf_place_image</function>.
</para>
</refsect1>
</refentry>

4
reference/pdf/functions/pdf-open-pdi-page.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-open-pdi-page">
<refnamediv>
@ -12,7 +12,7 @@
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>pdf_open_pdi_page</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>int</type><parameter>dochandle</parameter></methodparam>
<methodparam><type>int</type><parameter>pagenumber</parameter></methodparam>
<methodparam><type>string</type><parameter>pagelabel</parameter></methodparam>

9
reference/pdf/functions/pdf-open-pdi.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-open-pdi">
<refnamediv>
@ -12,13 +12,16 @@
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>pdf_open_pdi</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam><type>string</type><parameter>stringparam</parameter></methodparam>
<methodparam><type>int</type><parameter>intparam</parameter></methodparam>
</methodsynopsis>
<para>
Open an existing PDF document for later use.
Opens an existing PDF document and prepares it for later use.
</para>
<para>
See also <function>pdf_close_pdi</function>.
</para>
</refsect1>
</refentry>

30
reference/pdf/functions/pdf-open-png.xml
View file

@ -1,22 +1,20 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-open-png">
<refnamediv>
<refname>pdf_open_png</refname>
<refpurpose>
Deprecated: Opens a PNG image
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>
Deprecated.
</para>
<para>
See <function>pdf_open_image</function>.
</para>
</refsect1>
<refnamediv>
<refname>pdf_open_png</refname>
<refpurpose>
Deprecated: Opens a PNG image
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>
This function is deprecated, use <function>pdf_open_image</function>
instead.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file

13
reference/pdf/functions/pdf-open-tiff.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-open-tiff">
<refnamediv>
@ -8,16 +8,9 @@
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>int</type><methodname>pdf_open_tiff</methodname>
<methodparam><type>int</type><parameter>PDF-document</parameter></methodparam>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
</methodsynopsis>
<para>
Deprecated.
</para>
<para>
See also <function>pdf_open_image</function>,
This function is deprecated, use <function>pdf_open_image</function>
instead.
</para>
</refsect1>
</refentry>

11
reference/pdf/functions/pdf-open.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-open">
<refnamediv>
@ -9,13 +9,8 @@
<refsect1>
<title>Description</title>
<para>
<function>pdf_open</function> is deprecated, use
<function>pdf_new</function> plus <function>pdf_open_file</function>
instead.
</para>
<para>
See also <function>pdf_new</function>,
<function>pdf_open_file</function>.
This function is deprecated, use <function>pdf_new</function>
plus <function>pdf_open_file</function> instead.
</para>
</refsect1>
</refentry>

10
reference/pdf/functions/pdf-place-image.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-place-image">
<refnamediv>
@ -9,16 +9,16 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_place_image</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_place_image</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>int</type><parameter>image</parameter></methodparam>
<methodparam><type>float</type><parameter>x</parameter></methodparam>
<methodparam><type>float</type><parameter>y</parameter></methodparam>
<methodparam><type>float</type><parameter>scale</parameter></methodparam>
</methodsynopsis>
<para>
Place an image with the lower left corner at (<parameter>x</parameter>,
<parameter>y</parameter>), and scale it.
Place an image with the lower left corner at (<parameter>x</parameter>,
<parameter>y</parameter>), and scale it. &return.success;
</para>
</refsect1>
</refentry>

8
reference/pdf/functions/pdf-place-pdi-page.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-place-pdi-page">
<refnamediv>
@ -9,8 +9,8 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_place_pdi_page</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_place_pdi_page</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>int</type><parameter>page</parameter></methodparam>
<methodparam><type>float</type><parameter>x</parameter></methodparam>
<methodparam><type>float</type><parameter>y</parameter></methodparam>
@ -19,7 +19,7 @@
</methodsynopsis>
<para>
Place a PDF page with the lower left corner at (<parameter>x</parameter>,
<parameter>y</parameter>), and scale it.
<parameter>y</parameter>), and scale it. &return.success;
</para>
</refsect1>
</refentry>

10
reference/pdf/functions/pdf-rect.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-rect">
<refnamediv>
@ -9,15 +9,17 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_rect</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_rect</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>float</type><parameter>x</parameter></methodparam>
<methodparam><type>float</type><parameter>y</parameter></methodparam>
<methodparam><type>float</type><parameter>width</parameter></methodparam>
<methodparam><type>float</type><parameter>height</parameter></methodparam>
</methodsynopsis>
<para>
Draw a rectangle at lower left (x, y) with width and height.
Draw a (<parameter>width</parameter> * <parameter>height</parameter>)
rectangle at lower left (<parameter>x</parameter>, <parameter>y</parameter>).
&return.success;
</para>
</refsect1>
</refentry>

8
reference/pdf/functions/pdf-restore.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-restore">
<refnamediv>
@ -9,11 +9,11 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_restore</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_restore</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
</methodsynopsis>
<para>
Restore the most recently saved graphics state.
Restore the most recently saved graphics state. &return.success;
</para>
</refsect1>
</refentry>

9
reference/pdf/functions/pdf-rotate.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-rotate">
<refnamediv>
@ -9,12 +9,13 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_rotate</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_rotate</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>float</type><parameter>phi</parameter></methodparam>
</methodsynopsis>
<para>
Rotate the coordinate system by phi degrees.
Rotate the coordinate system by <parameter>phi</parameter> degrees.
&return.success;
</para>
</refsect1>
</refentry>

8
reference/pdf/functions/pdf-save.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-save">
<refnamediv>
@ -9,11 +9,11 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_save</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_save</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
</methodsynopsis>
<para>
Save the current graphics state.
Save the current graphics state. &return.success;
</para>
</refsect1>
</refentry>

8
reference/pdf/functions/pdf-scale.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-scale">
<refnamediv>
@ -9,13 +9,13 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_scale</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_scale</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>float</type><parameter>x-scale</parameter></methodparam>
<methodparam><type>float</type><parameter>y-scale</parameter></methodparam>
</methodsynopsis>
<para>
Scale the coordinate system.
Scale the coordinate system. &return.success;
</para>
</refsect1>
</refentry>

8
reference/pdf/functions/pdf-set-border-color.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-set-border-color">
<refnamediv>
@ -9,14 +9,14 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_set_border_color</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_set_border_color</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>float</type><parameter>red</parameter></methodparam>
<methodparam><type>float</type><parameter>green</parameter></methodparam>
<methodparam><type>float</type><parameter>blue</parameter></methodparam>
</methodsynopsis>
<para>
Set the border color for all kinds of annotations.
Set the border color for all kinds of annotations. &return.success;
</para>
</refsect1>
</refentry>

12
reference/pdf/functions/pdf-set-border-dash.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-set-border-dash">
<refnamediv>
@ -9,14 +9,16 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_set_border_dash</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_set_border_dash</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>float</type><parameter>black</parameter></methodparam>
<methodparam><type>float</type><parameter>white</parameter></methodparam>
</methodsynopsis>
<para>
Set the border dash style for all kinds of annotations.
See <function>pdf_setdash</function>.
Sets the border dash style for all kinds of annotations. &return.success;
</para>
<para>
See also <function>pdf_setdash</function>.
</para>
</refsect1>
</refentry>

11
reference/pdf/functions/pdf-set-border-style.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-set-border-style">
<refnamediv>
@ -9,14 +9,15 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_set_border_style</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_set_border_style</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>style</parameter></methodparam>
<methodparam><type>float</type><parameter>width</parameter></methodparam>
</methodsynopsis>
<para>
Set the border style for all kinds of annotations.
<parameter>style</parameter> is "solid" or "dashed".
Sets the border style for all kinds of annotations.
<parameter>style</parameter> is <parameter>solid</parameter> or
<parameter>dashed</parameter>. &return.success;
</para>
</refsect1>
</refentry>

8
reference/pdf/functions/pdf-set-char-spacing.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-set-char-spacing">
<refnamediv>
@ -9,10 +9,8 @@
<refsect1>
<title>Description</title>
<para>
Deprecated.
</para>
<para>
See also <function>pdf_set_value</function>,
This function is deprecated, use <function>pdf_set_value</function>
instead.
</para>
</refsect1>
</refentry>

8
reference/pdf/functions/pdf-set-duration.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-set-duration">
<refnamediv>
@ -9,10 +9,8 @@
<refsect1>
<title>Description</title>
<para>
Deprecated.
</para>
<para>
See <function>pdf_set_value</function>.
This function is deprecated, use <function>pdf_set_value</function>
instead.
</para>
</refsect1>
</refentry>

10
reference/pdf/functions/pdf-set-font.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-set-font">
<refnamediv>
@ -9,12 +9,8 @@
<refsect1>
<title>Description</title>
<para>
Deprecated. You should use <function>pdf_findfont</function> plus
<function>pdf_setfont</function> instead.
</para>
<para>
See <function>pdf_findfont</function>,
<function>pdf_setfont</function>.
This function is deprecated, use <function>pdf_findfont</function>
plus <function>pdf_setfont</function> instead.
</para>
</refsect1>
</refentry>

13
reference/pdf/functions/pdf-set-horiz-scaling.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-set-horiz-scaling">
<refnamediv>
@ -8,16 +8,9 @@
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_set_horiz_scaling</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<methodparam><type>float</type><parameter>scale</parameter></methodparam>
</methodsynopsis>
<para>
Deprecated.
</para>
<para>
See also <function>pdf_set_value</function>,
This function is deprecated, use <function>pdf_set_value</function>
instead.
</para>
</refsect1>
</refentry>

11
reference/pdf/functions/pdf-set-info-author.xml
View file

@ -1,22 +1,17 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.72 -->
<refentry id='function.pdf-set-info-author'>
<refnamediv>
<refname>pdf_set_info_author</refname>
<refpurpose>
Fills the author field of the document
Deprecated: Fills the author field of the document
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>pdf_set_info_author</methodname>
<methodparam><type>int</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>author</parameter></methodparam>
</methodsynopsis>
<para>
This function is deprecate, use <function>pdf_set_info</function> instead.
This function is deprecated, use <function>pdf_set_info</function> instead.
</para>
</refsect1>
</refentry>

11
reference/pdf/functions/pdf-set-info-creator.xml
View file

@ -1,22 +1,17 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.72 -->
<refentry id='function.pdf-set-info-creator'>
<refnamediv>
<refname>pdf_set_info_creator</refname>
<refpurpose>
Fills the creator field of the document
Deprecated: Fills the creator field of the document
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>pdf_set_info_creator</methodname>
<methodparam><type>int</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>creator</parameter></methodparam>
</methodsynopsis>
<para>
This function is deprecate, use <function>pdf_set_info</function> instead.
This function is deprecated, use <function>pdf_set_info</function> instead.
</para>
</refsect1>
</refentry>

11
reference/pdf/functions/pdf-set-info-keywords.xml
View file

@ -1,22 +1,17 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.72 -->
<refentry id='function.pdf-set-info-keywords'>
<refnamediv>
<refname>pdf_set_info_keywords</refname>
<refpurpose>
Fills the keywords field of the document
Deprecated: Fills the keywords field of the document
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>pdf_set_info_keywords</methodname>
<methodparam><type>int</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>keywords</parameter></methodparam>
</methodsynopsis>
<para>
This function is deprecate, use <function>pdf_set_info</function> instead.
This function is deprecated, use <function>pdf_set_info</function> instead.
</para>
</refsect1>
</refentry>

11
reference/pdf/functions/pdf-set-info-subject.xml
View file

@ -1,22 +1,17 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.72 -->
<refentry id='function.pdf-set-info-subject'>
<refnamediv>
<refname>pdf_set_info_subject</refname>
<refpurpose>
Fills the subject field of the document
Deprecated: Fills the subject field of the document
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>pdf_set_info_subject</methodname>
<methodparam><type>int</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>subject</parameter></methodparam>
</methodsynopsis>
<para>
This function is deprecate, use <function>pdf_set_info</function> instead.
This function is deprecated, use <function>pdf_set_info</function> instead.
</para>
</refsect1>
</refentry>

11
reference/pdf/functions/pdf-set-info-title.xml
View file

@ -1,22 +1,17 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id='function.pdf-set-info-title'>
<refnamediv>
<refname>pdf_set_info_title</refname>
<refpurpose>
Fills the title field of the document
Deprecated: Fills the title field of the document
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>pdf_set_info_title</methodname>
<methodparam><type>int</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>title</parameter></methodparam>
</methodsynopsis>
<para>
This function is deprecate, use <function>pdf_set_info</function> instead.
This function is deprecated, use <function>pdf_set_info</function> instead.
</para>
</refsect1>
</refentry>

15
reference/pdf/functions/pdf-set-info.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.72 -->
<refentry id="function.pdf-set-info">
<refnamediv>
@ -9,15 +9,18 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_set_info</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_set_info</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
Fill document information field key with value.
<parameter>key</parameter> is one of "Subject", "Title", "Creator",
"Author", "Keywords", or a user-defined key.
Fill document information field <parameter>key</parameter> with
<parameter>value</parameter>. &return.success;
<parameter>key</parameter> is one of <literal>Subject</literal>,
<literal>Title</literal>, <literal>Creator</literal>,
<literal>Author</literal>, <literal>Keywords</literal>,
or a user-defined key.
</para>
</refsect1>
</refentry>

8
reference/pdf/functions/pdf-set-leading.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-set-leading">
<refnamediv>
@ -9,10 +9,8 @@
<refsect1>
<title>Description</title>
<para>
Deprecated.
</para>
<para>
See also <function>pdf_set_value</function>,
This function is deprecated, use <function>pdf_set_value</function>
instead.
</para>
</refsect1>
</refentry>

8
reference/pdf/functions/pdf-set-parameter.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-set-parameter">
<refnamediv>
@ -9,13 +9,13 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_set_parameter</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_set_parameter</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>string</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
Set some PDFlib parameter with string type.
Sets some PDFlib parameters with string type. &return.success;
</para>
</refsect1>
</refentry>

5
reference/pdf/functions/pdf-set-text-matrix.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-set-text-matrix">
<refnamediv>
@ -9,7 +9,8 @@
<refsect1>
<title>Description</title>
<para>
See <function>pdf_set_paramter</function>.
This function is deprecated, use <function>pdf_set_paramter</function>
instead.
</para>
</refsect1>
</refentry>

9
reference/pdf/functions/pdf-set-text-pos.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-set-text-pos">
<refnamediv>
@ -9,13 +9,14 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_set_text_pos</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_set_text_pos</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>float</type><parameter>x</parameter></methodparam>
<methodparam><type>float</type><parameter>y</parameter></methodparam>
</methodsynopsis>
<para>
Set the text output position.
Set the text output position specified by <parameter>x</parameter> and
<parameter>y</parameter>. &return.success;
</para>
</refsect1>
</refentry>

8
reference/pdf/functions/pdf-set-text-rendering.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-set-text-rendering">
<refnamediv>
@ -9,10 +9,8 @@
<refsect1>
<title>Description</title>
<para>
Deprecated.
</para>
<para>
See <function>pdf_set_value</function>,
This function is deprecated, use <function>pdf_set_value</function>
instead.
</para>
</refsect1>
</refentry>

8
reference/pdf/functions/pdf-set-text-rise.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-set-text-rise">
<refnamediv>
@ -9,10 +9,8 @@
<refsect1>
<title>Description</title>
<para>
Deprecated.
</para>
<para>
See <function>pdf_set_value</function>,
This function is deprecated, use <function>pdf_set_value</function>
instead.
</para>
</refsect1>
</refentry>

8
reference/pdf/functions/pdf-set-value.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-set-value">
<refnamediv>
@ -9,13 +9,13 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_set_value</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_set_value</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>key</parameter></methodparam>
<methodparam><type>float</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
Set the value of some PDFlib parameter with float type.
Set the value of some PDFlib parameter with float type. &return.success;
</para>
</refsect1>
</refentry>

10
reference/pdf/functions/pdf-set-word-spacing.xml
View file

@ -1,18 +1,16 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-set-word-spacing">
<refnamediv>
<refname>pdf_set_word_spacing</refname>
<refpurpose>Depriciated: Sets spacing between words</refpurpose>
<refpurpose>Deprecated: Sets spacing between words</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>
Deprecated.
</para>
<para>
See <function>pdf_set_value</function>,
This function is deprecated, use <function>pdf_set_value</function>
instead.
</para>
</refsect1>
</refentry>

15
reference/pdf/functions/pdf-setcolor.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-setcolor">
<refnamediv>
@ -9,8 +9,8 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_setcolor</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_setcolor</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>string</type><parameter>type</parameter></methodparam>
<methodparam><type>string</type><parameter>colorspace</parameter></methodparam>
<methodparam><type>float</type><parameter>c1</parameter></methodparam>
@ -19,10 +19,11 @@
<methodparam choice="opt"><type>float</type><parameter>c4</parameter></methodparam>
</methodsynopsis>
<para>
Set the current color space and color. The parameter
<parameter>type</parameter> can be "fill", "stroke", or "both" to
specify that the color is set for filling, stroking or both filling and
stroking. The parameter <parameter>colorspace</parameter> can be
Set the current color space and color. &return.success;
The parameter <parameter>type</parameter> can be <literal>fill</literal>,
<literal>stroke</literal> or <literal>both</literal> to specify that the
color is set for filling, stroking or both filling and stroking.
The parameter <parameter>colorspace</parameter> can be
<literal>gray</literal>, <literal>rgb</literal>,
<literal>cmyk</literal>, <literal>spot</literal> or
<literal>pattern</literal>. The parameters <parameter>c1</parameter>,

8
reference/pdf/functions/pdf-setdash.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-setdash">
<refnamediv>
@ -9,14 +9,14 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_setdash</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_setdash</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>float</type><parameter>b</parameter></methodparam>
<methodparam><type>float</type><parameter>w</parameter></methodparam>
</methodsynopsis>
<para>
Set the current dash pattern to <parameter>b</parameter> black
and <parameter>w</parameter> white units.
and <parameter>w</parameter> white units. &return.success;
</para>
</refsect1>
</refentry>

8
reference/pdf/functions/pdf-setflat.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-setflat">
<refnamediv>
@ -9,12 +9,12 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_setflat</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_setflat</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>float</type><parameter>flatness</parameter></methodparam>
</methodsynopsis>
<para>
Set the flatness to a value between 0 and 100 inclusive.
Sets the flatness to a value between 0 and 100 inclusive. &return.success;
</para>
</refsect1>
</refentry>

12
reference/pdf/functions/pdf-setfont.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.48 -->
<refentry id="function.pdf-setfont">
<refnamediv>
@ -9,15 +9,15 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_setfont</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_setfont</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>int</type><parameter>font</parameter></methodparam>
<methodparam><type>float</type><parameter>size</parameter></methodparam>
</methodsynopsis>
<para>
Set the current font in the given size, using a
<parameter>font</parameter> handle returned by
<function>pdf_findfont</function>
Set the current font in the given <parameter>size</parameter>, using a
<parameter>font</parameter> handle returned by <function>pdf_findfont</function>.
&return.success;
</para>
<para>
See also

7
reference/pdf/functions/pdf-setgray-fill.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-setgray-fill">
<refnamediv>
@ -9,12 +9,13 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_setgray_fill</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_setgray_fill</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>float</type><parameter>gray</parameter></methodparam>
</methodsynopsis>
<para>
Set the current fill color to a gray value between 0 and 1 inclusive.
&return.success;
</para>
<note>
<para>

9
reference/pdf/functions/pdf-setgray-stroke.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-setgray-stroke">
<refnamediv>
@ -9,12 +9,13 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_setgray_stroke</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_setgray_stroke</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>float</type><parameter>gray</parameter></methodparam>
</methodsynopsis>
<para>
Set the current stroke color to a gray value between 0 and 1 inclusive
Set the current stroke color to a <parameter>gray</parameter> value
between 0 and 1 inclusive. &return.success;
</para>
<note>
<para>

8
reference/pdf/functions/pdf-setgray.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-setgray">
<refnamediv>
@ -9,12 +9,12 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_setgray</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_setgray</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>float</type><parameter>gray</parameter></methodparam>
</methodsynopsis>
<para>
Set the current fill and stroke color.
Set the current fill and stroke color. &return.success;
</para>
<note>
<para>

4
reference/pdf/functions/pdf-setlinecap.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-setlinecap">
<refnamediv>
@ -10,7 +10,7 @@
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_setlinecap</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>int</type><parameter>linecap</parameter></methodparam>
</methodsynopsis>
<para>

9
reference/pdf/functions/pdf-setlinejoin.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/pdf.xml, last change in rev 1.42 -->
<refentry id="function.pdf-setlinejoin">
<refnamediv>
@ -9,12 +9,13 @@
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>void</type><methodname>pdf_setlinejoin</methodname>
<methodparam><type>int</type><parameter>pdf_object</parameter></methodparam>
<type>bool</type><methodname>pdf_setlinejoin</methodname>
<methodparam><type>resource</type><parameter>pdfdoc</parameter></methodparam>
<methodparam><type>int</type><parameter>value</parameter></methodparam>
</methodsynopsis>
<para>
Set the line join parameter to a value between 0 and 2 inclusive.
Sets the line join parameter to a <parameter>value</parameter> between
0 and 2 inclusive. &return.success;
</para>
</refsect1>
</refentry>

Some files were not shown because too many files have changed in this diff Show more