<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Set transition style for the page</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="harupage.setsize.html">HaruPage::setSize</a></div>
<div class="next" style="text-align: right; float: right;"><a href="harupage.settextleading.html">HaruPage::setTextLeading</a></div>
<div class="up"><a href="class.harupage.html">HaruPage</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="harupage.setslideshow" class="refentry">
<div class="refnamediv">
<h1 class="refname">HaruPage::setSlideShow</h1>
<p class="verinfo">(PECL haru >= 0.0.1)</p><p class="refpurpose"><span class="refname">HaruPage::setSlideShow</span> — <span class="dc-title">Set transition style for the page</span></p>
</div>
<div class="refsect1 description" id="refsect1-harupage.setslideshow-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>HaruPage::setSlideShow</strong></span>
( <span class="methodparam"><span class="type">int</span> <code class="parameter">$type</code></span>
, <span class="methodparam"><span class="type">float</span> <code class="parameter">$disp_time</code></span>
, <span class="methodparam"><span class="type">float</span> <code class="parameter">$trans_time</code></span>
)</div>
<p class="para rdfs-comment">
Defines transition style for the page.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-harupage.setslideshow-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">type</code></dt>
<dd>
<p class="para">
Must be one of the following values:
<ul class="simplelist">
<li class="member">
<strong><code>HaruPage::TS_WIPE_RIGHT</code></strong>
</li>
<li class="member">
<strong><code>HaruPage::TS_WIPE_LEFT</code></strong>
</li>
<li class="member">
<strong><code>HaruPage::TS_WIPE_UP</code></strong>
</li>
<li class="member">
<strong><code>HaruPage::TS_WIPE_DOWN</code></strong>
</li>
<li class="member">
<strong><code>HaruPage::TS_BARN_DOORS_HORIZONTAL_OUT</code></strong>
</li>
<li class="member">
<strong><code>HaruPage::TS_BARN_DOORS_HORIZONTAL_IN</code></strong>
</li>
<li class="member">
<strong><code>HaruPage::TS_BARN_DOORS_VERTICAL_OUT</code></strong>
</li>
<li class="member">
<strong><code>HaruPage::TS_BARN_DOORS_VERTICAL_IN</code></strong>
</li>
<li class="member">
<strong><code>HaruPage::TS_BOX_OUT</code></strong>
</li>
<li class="member">
<strong><code>HaruPage::TS_BOX_IN</code></strong>
</li>
<li class="member">
<strong><code>HaruPage::TS_BLINDS_HORIZONTAL</code></strong>
</li>
<li class="member">
<strong><code>HaruPage::TS_BLINDS_VERTICAL</code></strong>
</li>
<li class="member">
<strong><code>HaruPage::TS_DISSOLVE</code></strong>
</li>
<li class="member">
<strong><code>HaruPage::TS_GLITTER_RIGHT</code></strong>
</li>
<li class="member">
<strong><code>HaruPage::TS_GLITTER_DOWN</code></strong>
</li>
<li class="member">
<strong><code>HaruPage::TS_GLITTER_TOP_LEFT_TO_BOTTOM_RIGHT</code></strong>
</li>
<li class="member">
<strong><code>HaruPage::TS_REPLACE</code></strong>
</li>
</ul>
</p>
</dd>
<dt>
<code class="parameter">disp_time</code></dt>
<dd>
<p class="para">
The display duration of the page in seconds.
</p>
</dd>
<dt>
<code class="parameter">trans_time</code></dt>
<dd>
<p class="para">
The duration of the transition effect in seconds.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-harupage.setslideshow-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success.
</p>
</div>
<div class="refsect1 errors" id="refsect1-harupage.setslideshow-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">Throws a <a href="class.haruexception.html" class="classname">HaruException</a> on error.</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="harupage.setsize.html">HaruPage::setSize</a></div>
<div class="next" style="text-align: right; float: right;"><a href="harupage.settextleading.html">HaruPage::setTextLeading</a></div>
<div class="up"><a href="class.harupage.html">HaruPage</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
