<?xml version="1.0" encoding="iso-8859-1"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> <title> Data Handler </title> <link rel="stylesheet" href="book.css" type="text/css" /> <meta name="generator" content="DocBook XSL Stylesheets V1.69.1" /> <link rel="start" href="index.html" title="HTML_Progress2 Manual" /> <link rel="up" href="ch19.html" title= "Chapter 19. API - Application Programming Interface" /> <link rel="prev" href="re05.html" title="HTML_Progress2::removeListener" /> <link rel="next" href="re06.html" title="HTML_Progress2::getIncrement" /> <style type="text/css"> /*<![CDATA[*/ body { background-color: white; color: black; } :link { color: #0000FF } :visited { color: #840084 } :active { color: #0000FF } h2.c1 {clear: both} /*]]>*/ </style> </head> <body> <table class="progress2Header"> <tr> <td> <img src="img/pear_progress2.gif" align="left" alt= "PEAR Progress2 logo" /> <h1> HTML_Progress2 : The Definitive Guide </h1> <div class="navheader"> <table width="100%" summary="Navigation header"> <tr> <th colspan="3" align="center"> Data Handler </th> </tr> <tr> <td width="20%" align="left"> <a accesskey="p" href="re05.html">Prev</a> </td> <th width="60%" align="center"> Chapter 19. API - Application Programming Interface </th> <td width="20%" align="right"> <a accesskey="n" href="re06.html">Next</a> </td> </tr> </table> </div> </td> </tr> </table> <div class="sect1" lang="en" xml:lang="en"> <div class="titlepage"> <h2 class="title c1"> <a name="reference.api.math" id="reference.api.math"></a>Data Handler </h2> </div> <div class="toc"> <dl> <dt> <span class="sect2"><a href= "ch19s03.html#reference.api.math.increment">Increment</a></span> </dt> <dt> <span class="sect2"><a href= "ch19s03.html#reference.api.math.min">Minimum</a></span> </dt> <dt> <span class="sect2"><a href= "ch19s03.html#reference.api.math.max">Maximum</a></span> </dt> <dt> <span class="sect2"><a href= "ch19s03.html#reference.api.math.current">Current value</a></span> </dt> <dt> <span class="sect2"><a href= "ch19s03.html#reference.api.math.step">Go to next step</a></span> </dt> </dl> </div> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <h3 class="title"> <a name="reference.api.math.increment" id= "reference.api.math.increment"></a>Increment </h3> </div> <div class="toc"> <dl> <dt> <span class="refentrytitle"><a href="re06.html"><code class= "function">HTML_Progress2::getIncrement</code></a></span> <span class="refpurpose">- Returns the progress meter increment value</span> </dt> <dt> <span class="refentrytitle"><a href="re07.html"><code class= "function">HTML_Progress2::setIncrement</code></a></span> <span class="refpurpose">- Sets the progress meter increment value</span> </dt> </dl> </div> <p> <code class="methodname">getIncrement()</code> and <code class= "methodname">setIncrement()</code> methods provides reading and setting of the progress meter's step property. </p> </div> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <h3 class="title"> <a name="reference.api.math.min" id= "reference.api.math.min"></a>Minimum </h3> </div> <div class="toc"> <dl> <dt> <span class="refentrytitle"><a href="re08.html"><code class= "function">HTML_Progress2::getMinimum</code></a></span> <span class="refpurpose">- Returns the progress meter minimum value</span> </dt> <dt> <span class="refentrytitle"><a href="re09.html"><code class= "function">HTML_Progress2::setMinimum</code></a></span> <span class="refpurpose">- Sets the progress meter minimum value</span> </dt> </dl> </div> <p> <code class="methodname">getMinimum()</code> and <code class= "methodname">setMinimum()</code> methods provides reading and setting of the progress meter's minimum property. </p> </div> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <h3 class="title"> <a name="reference.api.math.max" id= "reference.api.math.max"></a>Maximum </h3> </div> <div class="toc"> <dl> <dt> <span class="refentrytitle"><a href="re10.html"><code class= "function">HTML_Progress2::getMaximum</code></a></span> <span class="refpurpose">- Returns the progress meter maximum value</span> </dt> <dt> <span class="refentrytitle"><a href="re11.html"><code class= "function">HTML_Progress2::setMaximum</code></a></span> <span class="refpurpose">- Sets the progress bar's maximum value.</span> </dt> </dl> </div> <p> <code class="methodname">getMaximum()</code> and <code class= "methodname">setMaximum()</code> methods provides reading and setting of the progress meter's maximum property. </p> </div> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <h3 class="title"> <a name="reference.api.math.current" id= "reference.api.math.current"></a>Current value </h3> </div> <div class="toc"> <dl> <dt> <span class="refentrytitle"><a href="re12.html"><code class= "function">HTML_Progress2::getValue</code></a></span> <span class="refpurpose">- Returns the progress meter current value</span> </dt> <dt> <span class="refentrytitle"><a href="re13.html"><code class= "function">HTML_Progress2::setValue</code></a></span> <span class="refpurpose">- Sets the progress meter current value</span> </dt> </dl> </div> <p> <code class="methodname">getValue()</code> and <code class= "methodname">setValue()</code> methods provides reading and setting of the progress meter's current value property. </p> </div> <div class="sect2" lang="en" xml:lang="en"> <div class="titlepage"> <h3 class="title"> <a name="reference.api.math.step" id= "reference.api.math.step"></a>Go to next step </h3> </div> <div class="toc"> <dl> <dt> <span class="refentrytitle"><a href="re14.html"><code class= "function">HTML_Progress2::incValue</code></a></span> <span class="refpurpose">- Updates the internal progress meter current value</span> </dt> <dt> <span class="refentrytitle"><a href="re15.html"><code class= "function">HTML_Progress2::moveStep</code></a></span> <span class="refpurpose">- Changes new value of the progress meter by step increase</span> </dt> <dt> <span class="refentrytitle"><a href="re16.html"><code class= "function">HTML_Progress2::moveNext</code></a></span> <span class="refpurpose">- Changes new value of the progress meter by increment increase</span> </dt> <dt> <span class="refentrytitle"><a href="re17.html"><code class= "function">HTML_Progress2::getPercentComplete</code></a></span> <span class="refpurpose">- Returns the percent complete of the progress meter</span> </dt> </dl> </div> <p> These methods provides setting to go to next step/value of the progress meter, and reading <code class= "methodname">getPercentComplete()</code> to detect if task is completed. </p> </div> </div> <table class="progress2Footer"> <tr> <td align="left"> HTML_Progress2 : The Definitive Guide </td> <td align="right"> v 2.4.0 : April 20, 2007 </td> </tr> </table> <div class="navfooter"> <hr /> <table width="100%" summary="Navigation footer"> <tr> <td width="40%" align="left"> <a accesskey="p" href="re05.html">Prev</a> </td> <td width="20%" align="center"> <a accesskey="u" href="ch19.html">Up</a> </td> <td width="40%" align="right"> <a accesskey="n" href="re06.html">Next</a> </td> </tr> <tr> <td width="40%" align="left" valign="top"> <code class="function">HTML_Progress2::removeListener</code> </td> <td width="20%" align="center"> <a accesskey="h" href="index.html">Home</a> </td> <td width="40%" align="right" valign="top"> <code class="function">HTML_Progress2::getIncrement</code> </td> </tr> </table> </div> </body> </html>