- more documentation of clibpdf

- corrected some cross references


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@10150 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Uwe Steinmann 1999-06-28 18:54:29 +00:00
parent b86879ad2f
commit 373dfd6694

View file

@ -285,16 +285,20 @@ cpdf_close($pdf);
output with <function>cpdf_output_buffer</function>.
<note><simpara>
The return value will be needed in futher versons as the
first parameter in all other functions writing to the pdf document.
The return value will be needed in futher versions of ClibPDF as the
first parameter in all other functions which are writing to the pdf
document.
</simpara><simpara>
The ClibPDF library takes the filename "-" as a synonym for stdout.
If PHP is compiled as an apache module this will not work because the
way ClibPDF outputs to stdout does not work with apache.
way ClibPDF outputs to stdout does not work with apache. You can solve
this problem by skipping the filename and using
<function>cpdf_output_buffer</function> to output the pdf document.
</simpara></note>
<para>
See also <function>cpdf_close</function>.
See also <function>cpdf_close</function>,
<function>cpdf_output_buffer</function>.
</refsect1>
</refentry>
@ -380,6 +384,75 @@ cpdf_close($pdf);
</refsect1>
</refentry>
<refentry id="function.cpdf-finalize">
<refnamediv>
<refname>cpdf_finalize</refname>
<refpurpose>Ends document</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcdef>void <function>cpdf_finalize</function></funcdef>
<paramdef>int <parameter>pdf document</parameter></paramdef>
</funcsynopsis>
<para>
The <function>cpdf_finalize</function> function ends the document.
You still have to call <function>cpdf_close</function>.
<para>
See also <function>cpdf_close</function>.
</refsect1>
</refentry>
<refentry id="function.cpdf-output-buffer">
<refnamediv>
<refname>cpdf_output_buffer</refname>
<refpurpose>Outputs the pdf document in memory buffer</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcdef>void <function>cpdf_output_buffer</function></funcdef>
<paramdef>int <parameter>pdf document</parameter></paramdef>
</funcsynopsis>
<para>
The <function>cpdf_output_buffer</function> function outputs
the pdf document to stdout. The document has to be created in memory which
is the case if <function>cpdf_open</function> has been called with
no filename parameter.
<para>
See also <function>cpdf_open</function>.
</refsect1>
</refentry>
<refentry id="function.cpdf-save-to-file">
<refnamediv>
<refname>cpdf_save_to_file</refname>
<refpurpose>Writes the pdf document into a file</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcdef>void <function>cpdf_save_to_file</function></funcdef>
<paramdef>int <parameter>pdf document</parameter></paramdef>
<paramdef>string <parameter>filename</parameter></paramdef>
</funcsynopsis>
<para>
The <function>cpdf_save_to_file</function> function outputs
the pdf document into a file if it has been created in memory.
This function is not needed if the pdf document has been open
by specifying a filename as a parameter of <function>cpdf_open</function>.
<para>
See also <function>cpdf_output_buffer</function>,
<function>cpdf_open</function>.
</refsect1>
</refentry>
<refentry id="function.cpdf-set-current-page">
<refnamediv>
<refname>cpdf_set_current_page</refname>
@ -512,7 +585,7 @@ cpdf_end_text($pdf) ?>
<note>
<simpara>The function <function>cpdf_show_xy</function> is identical
to <function>cpdf_text</function>.</simpara></note>
to <function>cpdf_text</function> without the optional parameters.</simpara></note>
<para>
See also <function>cpdf_text</function>.
@ -520,6 +593,42 @@ cpdf_end_text($pdf) ?>
</refsect1>
</refentry>
<refentry id="function.cpdf-text">
<refnamediv>
<refname>cpdf_text</refname>
<refpurpose>Output text with parameters</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcdef>void <function>cpdf_text</function></funcdef>
<paramdef>int <parameter>pdf document</parameter></paramdef>
<paramdef>string <parameter>text</parameter></paramdef>
<paramdef>double <parameter>x-koor</parameter></paramdef>
<paramdef>double <parameter>y-koor</parameter></paramdef>
<paramdef>int <parameter>mode</parameter></paramdef>
<paramdef>double <parameter>orientation</parameter></paramdef>
<paramdef>int <parameter>alignmode</parameter></paramdef>
</funcsynopsis>
<para>
The <function>cpdf_text</function> function outputs the
string <parameter>text</parameter> at position with
coordinates (<parameter>x-koor</parameter>, <parameter>y-koor</parameter>).
The optional parameter determines the unit length. If is 0 or omitted
the default unit as specified for the page is used.
Otherwise the koodinates
are measured in postscript points disregarding the current unit.
The optional parameter <parameter>orientation</parameter> is the rotation
of the text in degree. The optional parameter
<parameter>alignmode</parameter> determines how the text is align.
See the ClibPDF documentation for possible values.
<para>
See also <function>cpdf_show_xy</function>.
</refsect1>
</refentry>
<refentry id="function.cpdf-set-font">
<refnamediv>
<refname>cpdf_set_font</refname>
@ -543,9 +652,6 @@ cpdf_end_text($pdf) ?>
2 = macroman, 3 = macexpert, 4 = winansi.
Any other value selects the font's buildin encoding.
<para>
See also <function>cpdf_set_font_directories</function>.
</refsect1>
</refentry>
@ -666,11 +772,12 @@ cpdf_end_text($pdf) ?>
<para>
The <function>cpdf_set_text_pos</function> function sets the
position of text for the next <function>cpdf_show</function>
function call. The optional parameter <parameter>mode</parameter>
function call.
<para>
The last optional parameter determines the unit length. If is 0 or omitted
the default unit as specified for the page is used. Otherwise the koodinates
The last optional parameter <parameter>mode</parameter> determines
the unit length. If is 0 or omitted the default unit as specified
for the page is used. Otherwise the koodinates
are measured in postscript points disregarding the current unit.
<para>
@ -696,7 +803,7 @@ cpdf_end_text($pdf) ?>
spacing between characters.
<para>
See also <function>cpdf_set_word_spacing</function>,
<function>cpdf_set_text_leading</function>.
<function>cpdf_set_leading</function>.
</refsect1>
</refentry>
@ -719,7 +826,7 @@ cpdf_end_text($pdf) ?>
<para>
See also <function>cpdf_set_char_spacing</function>,
<function>cpdf_set_text_leading</function>.
<function>cpdf_set_leading</function>.
</refsect1>
</refentry>
@ -743,7 +850,7 @@ cpdf_end_text($pdf) ?>
<para>
See also <function>cpdf_show_xy</function>,
<function>cpdf_text</function>,
<function>cpdf_set_text_leading</function>,
<function>cpdf_set_leading</function>,
<function>cpdf_set_text_pos</function>.
</refsect1>