php-doc-en/reference/cpdf/functions/cpdf-page-init.xml
Mehdi Achour 7218bcc708 updating protos
fixed missing params
added role to programlisting
added para arround the examples
added one example and a note about the rgb values (users notes)
WS for the See Also
using cpdf.ul; as shorthand


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@137849 c90b9560-bf6c-de11-be94-00142212c4b1
2003-08-15 14:29:05 +00:00

57 lines
2.2 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 -->
<refentry id="function.cpdf-page-init">
<refnamediv>
<refname>cpdf_page_init</refname>
<refpurpose>Starts new page</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>cpdf_page_init</methodname>
<methodparam><type>int</type><parameter>pdf_document</parameter></methodparam>
<methodparam><type>int</type><parameter>page_number</parameter></methodparam>
<methodparam><type>int</type><parameter>orientation</parameter></methodparam>
<methodparam><type>float</type><parameter>height</parameter></methodparam>
<methodparam><type>float</type><parameter>width</parameter></methodparam>
<methodparam choice="opt"><type>float</type><parameter>unit</parameter></methodparam>
</methodsynopsis>
<para>
The <function>cpdf_page_init</function> function starts a new
page with height <parameter>height</parameter> and width
<parameter>width</parameter>. &return.success;
The page has number <parameter>page_number</parameter> and orientation
<parameter>orientation</parameter>. <parameter>orientation</parameter>
can be 0 for portrait and 1 for landscape. The last optional parameter
<parameter>unit</parameter> sets the unit for the coordinate system.
The value should be the number of postscript points per unit. Since
one inch is equal to 72 points, a value of 72 would set the unit
to one inch. The default is also 72.
</para>
<para>
See also <function>cpdf_set_current_page</function>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->