| Current File : //opt/RZphp5/includes/doc/HTML_Progress2/docs/TDG/ch17s02.html |
<?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>
Additional Events informations
</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="ch17.html" title=
"Chapter 17. Events to observe" />
<link rel="prev" href="ch17.html" title=
"Chapter 17. Events to observe" />
<link rel="next" href="ch18.html" title=
"Chapter 18. HTML_Progress2_Lite" />
<style type="text/css">
/*<![CDATA[*/
body {
background-color: white;
color: black;
}
:link { color: #0000FF }
:visited { color: #840084 }
:active { color: #0000FF }
div.c2 {margin-left: 0.5in; margin-right: 0.5in;}
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">
Additional Events informations
</th>
</tr>
<tr>
<td width="20%" align="left">
<a accesskey="p" href="ch17.html">Prev</a>
</td>
<th width="60%" align="center">
Chapter 17. Events to observe
</th>
<td width="20%" align="right">
<a accesskey="n" href="ch18.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="id4805671" id="id4805671"></a>Additional Events informations
</h2>
</div>
<div class="variablelist">
<dl>
<dt>
<span class="term">handler</span>
</dt>
<dd>
<p>
Function (method) that triggered event.
</p>
<div class="caution c2">
<table border="0" summary="Caution">
<tr>
<td rowspan="2" align="center" valign="top" width="48">
<img alt="[Caution]" src="img/admons/caution.png" />
</td>
<th align="left">
Caution
</th>
</tr>
<tr>
<td align="left" valign="top">
Function name is case sensitive: <code class=
"function">setvalue</code> does not match <code class=
"function">setValue</code>.
</td>
</tr>
</table>
</div>
<p>
Function is one of them: <code class=
"function">setMinimum</code>, <code class=
"function">setMaximum</code>, <code class=
"function">setValue</code>, <code class=
"function">incValue</code>, <code class=
"function">moveStep</code>, <code class=
"function">moveNext</code>, <code class="function">run</code>.
</p>
</dd>
</dl>
</div>
<div class="variablelist">
<dl>
<dt>
<span class="term">value</span>
</dt>
<dd>
<p>
Current value of progress meter. Between minimum and maximum
limits defined by <code class="methodname">setMinimum</code> and
<code class="methodname">setMaximum</code> methods.
</p>
</dd>
</dl>
</div>
<div class="variablelist">
<dl>
<dt>
<span class="term">sender</span>
</dt>
<dd>
<p>
Origin of call. In most cases it should be <span class=
"emphasis"><em>html_progress2</em></span> class.
</p>
<div class="note c2">
<table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="48">
<img alt="[Note]" src="img/admons/note.png" />
</td>
<th align="left">
Note
</th>
</tr>
<tr>
<td align="left" valign="top">
It could be different if you extends the main class. Or in
special case of progress monitor and onCancel event.
</td>
</tr>
</table>
</div>
</dd>
</dl>
</div>
<div class="variablelist">
<dl>
<dt>
<span class="term">time</span>
</dt>
<dd>
<p>
Current Unix timestamp of event triggered. Given by PHP <a class=
"external" href=
"http://www.php.net/manual-lookup.php?pattern=microtime" title=
"http://www.php.net/manual-lookup.php?pattern=microtime">microtime</a>
function.
</p>
</dd>
</dl>
</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="ch17.html">Prev</a>
</td>
<td width="20%" align="center">
<a accesskey="u" href="ch17.html">Up</a>
</td>
<td width="40%" align="right">
<a accesskey="n" href="ch18.html">Next</a>
</td>
</tr>
<tr>
<td width="40%" align="left" valign="top">
Chapter 17. Events to observe
</td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top">
Chapter 18. HTML_Progress2_Lite
</td>
</tr>
</table>
</div>
</body>
</html>