php-doc-en/reference/cpdf/functions/cpdf-set-page-animation.xml
Jakub Vrana 8214cac81b Fix protos from sources
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@166691 c90b9560-bf6c-de11-be94-00142212c4b1
2004-08-18 14:15:21 +00:00

74 lines
2.5 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/cpdf.xml, last change in rev 1.2 -->
<refentry id="function.cpdf-set-page-animation">
<refnamediv>
<refname>cpdf_set_page_animation</refname>
<refpurpose>Sets duration between pages</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>bool</type><methodname>cpdf_set_page_animation</methodname>
<methodparam><type>int</type><parameter>pdf_document</parameter></methodparam>
<methodparam><type>int</type><parameter>transition</parameter></methodparam>
<methodparam><type>float</type><parameter>duration</parameter></methodparam>
<methodparam><type>float</type><parameter>direction</parameter></methodparam>
<methodparam><type>int</type><parameter>orientation</parameter></methodparam>
<methodparam><type>int</type><parameter>inout</parameter></methodparam>
</methodsynopsis>
<para>
The <function>cpdf_set_page_animation</function> function set the
transition between following pages. &return.success;
</para>
<para>
The value of <parameter>transition</parameter>
can be
<simplelist>
<member>0 for none,</member>
<member>
1 for two lines sweeping across the screen reveal the page,
</member>
<member>
2 for multiple lines sweeping across the screen reveal the page,
</member>
<member>3 for a box reveals the page,</member>
<member>
4 for a single line sweeping across the screen reveals the page,
</member>
<member>5 for the old page dissolves to reveal the page,</member>
<member>
6 for the dissolve effect moves from one screen edge to another,
</member>
<member>
7 for the old page is simply replaced by the new page (default)
</member>
</simplelist>
</para>
<para>
The value of <parameter>duration</parameter> is the number of seconds
between page flipping.
</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
-->