<?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> Chapter 19. API - Application Programming Interface </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="pt04.html" title= "Part IV. Reference Guide" /> <link rel="prev" href="ch18s02.html" title= "Quick-Cards Atttributes Reference " /> <link rel="next" href="re01.html" title="HTML_Progress2::raiseError" /> <style type="text/css"> /*<![CDATA[*/ body { background-color: white; color: black; } :link { color: #0000FF } :visited { color: #840084 } :active { color: #0000FF } h2.c2 {clear: both} p.c1 {font-weight: bold} /*]]>*/ </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"> Chapter 19. API - Application Programming Interface </th> </tr> <tr> <td width="20%" align="left"> <a accesskey="p" href="ch18s02.html">Prev</a> </td> <th width="60%" align="center"> Part IV. Reference Guide </th> <td width="20%" align="right"> <a accesskey="n" href="re01.html">Next</a> </td> </tr> </table> </div> </td> </tr> </table> <div class="chapter" lang="en" xml:lang="en"> <div class="titlepage"> <h2 class="title"> <a name="reference.api" id= "reference.api"></a>Chapter 19. API - Application Programming Interface </h2> </div> <div class="toc"> <p class="c1"> Table of Contents </p> <dl> <dt> <span class="sect1"><a href= "ch19.html#reference.api.errorhandler">Error Handler</a></span> </dt> <dt> <span class="sect1"><a href="ch19s02.html">Listener</a></span> </dt> <dt> <span class="sect1"><a href="ch19s03.html">Data Handler</a></span> </dt> <dd> <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> </dd> <dt> <span class="sect1"><a href="ch19s04.html">Graphical Handler</a></span> </dt> <dd> <dl> <dt> <span class="sect2"><a href= "ch19s04.html#reference.api.graph.orientation">Orientation</a></span> </dt> <dt> <span class="sect2"><a href= "ch19s04.html#reference.api.graph.fill">Fill option</a></span> </dt> <dt> <span class="sect2"><a href= "ch19s04.html#reference.api.graph.cell">Cells</a></span> </dt> <dt> <span class="sect2"><a href= "ch19s04.html#reference.api.graph.border">Border</a></span> </dt> <dt> <span class="sect2"><a href= "ch19s04.html#reference.api.graph.frame">Frame</a></span> </dt> <dt> <span class="sect2"><a href= "ch19s04.html#reference.api.graph.label">Labels</a></span> </dt> <dt> <span class="sect2"><a href= "ch19s04.html#reference.api.graph.bg">Background color and size</a></span> </dt> <dt> <span class="sect2"><a href= "ch19s04.html#reference.api.graph.js">JavaScript handler</a></span> </dt> <dt> <span class="sect2"><a href= "ch19s04.html#reference.api.graph.circle">Circle/Ellipse</a></span> </dt> </dl> </dd> <dt> <span class="sect1"><a href="ch19s05.html">Common functions</a></span> </dt> <dd> <dl> <dt> <span class="sect2"><a href= "ch19s05.html#reference.api.common.ident">Identification</a></span> </dt> <dt> <span class="sect2"><a href= "ch19s05.html#reference.api.common.speed">Animation speed</a></span> </dt> <dt> <span class="sect2"><a href= "ch19s05.html#reference.api.common.css">Stylesheet</a></span> </dt> <dt> <span class="sect2"><a href= "ch19s05.html#reference.api.common.display">Rendering</a></span> </dt> <dt> <span class="sect2"><a href= "ch19s05.html#reference.api.common.process">Process</a></span> </dt> </dl> </dd> </dl> </div> <div class="sect1" lang="en" xml:lang="en"> <div class="titlepage"> <h2 class="title c2"> <a name="reference.api.errorhandler" id= "reference.api.errorhandler"></a>Error Handler </h2> </div> <div class="toc"> <dl> <dt> <span class="refentrytitle"><a href="re01.html"><code class= "function">HTML_Progress2::raiseError</code></a></span> <span class="refpurpose">- A basic wrapper around the default PEAR_Error object</span> </dt> <dt> <span class="refentrytitle"><a href="re02.html"><code class= "function">HTML_Progress2::hasErrors</code></a></span> <span class="refpurpose">- Determine whether there are errors into the HTML_Progress2 stack</span> </dt> <dt> <span class="refentrytitle"><a href="re03.html"><code class= "function">HTML_Progress2::getError</code></a></span> <span class="refpurpose">- Pop an error off of the HTML_Progress2 stack</span> </dt> </dl> </div> <p> Unless you want to create extends of HTML_Progress2 class and check new function arguments with <code class= "methodname">raiseError()</code> method, you should only use <code class="methodname">hasErrors()</code> and <code class= "methodname">getError()</code> methods to catch any API error (wrong programming). </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="ch18s02.html">Prev</a> </td> <td width="20%" align="center"> <a accesskey="u" href="pt04.html">Up</a> </td> <td width="40%" align="right"> <a accesskey="n" href="re01.html">Next</a> </td> </tr> <tr> <td width="40%" align="left" valign="top"> Quick-Cards Atttributes Reference </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::raiseError</code> </td> </tr> </table> </div> </body> </html>