Sophie

Sophie

distrib > PLD > ac > amd64 > media > dist > by-pkgid > 82c55661c0e72fc211ea70d3eba10d72 > files > 17

php-pear-HTML_Progress-1.2.5-2.noarch.rpm

<html>
<head>
<title>Docs For Class HTML_Progress_Monitor</title>
<link rel="stylesheet" type="text/css" href="../../media/style.css">
</head>
<body>

<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
  <tr>
    <td class="header_top">HTML_Progress</td>
  </tr>
  <tr><td class="header_line"><img src="../../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
  <tr>
    <td class="header_menu">
  		  [ <a href="../../classtrees_HTML_Progress.html" class="menu">class tree: HTML_Progress</a> ]
		  [ <a href="../../elementindex_HTML_Progress.html" class="menu">index: HTML_Progress</a> ]
		  [ <a href="../../elementindex.html" class="menu">all elements</a> ]
    </td>
  </tr>
  <tr><td class="header_line"><img src="../../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
</table>

<table width="100%" border="0" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td>
      <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">

<h1>Class: HTML_Progress_Monitor</h1>
Source Location: /Progress/monitor.php<br /><br />


<table width="100%" border="0">
<tr><td valign="top">

<h3><a href="#class_details">Class Overview</a></h3>
<pre></pre><br />
<div class="description"></div><br /><br />







</td>

<td valign="top">
<h3><a href="#class_vars">Variables</a></h3>
<ul>
    <li><a href="../../HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#var$buttonCancel">$buttonCancel</a></li>
    <li><a href="../../HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#var$buttonStart">$buttonStart</a></li>
    <li><a href="../../HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#var$windowname">$windowname</a></li>
  </ul>
</td>


<td valign="top">
<h3><a href="#class_methods">Methods</a></h3>
<ul>
    <li><a href="../../HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#methodHTML_Progress_Monitor">HTML_Progress_Monitor</a></li>
    <li><a href="../../HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#methodaccept">accept</a></li>
    <li><a href="../../HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#methodcallProgressHandler">callProgressHandler</a></li>
    <li><a href="../../HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#methodgetProgressElement">getProgressElement</a></li>
    <li><a href="../../HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#methodgetScript">getScript</a></li>
    <li><a href="../../HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#methodgetStyle">getStyle</a></li>
    <li><a href="../../HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#methodisCanceled">isCanceled</a></li>
    <li><a href="../../HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#methodisStarted">isStarted</a></li>
    <li><a href="../../HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#methodnotify">notify</a></li>
    <li><a href="../../HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#methodrun">run</a></li>
    <li><a href="../../HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#methodsetCaption">setCaption</a></li>
    <li><a href="../../HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#methodsetProgressElement">setProgressElement</a></li>
    <li><a href="../../HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#methodsetProgressHandler">setProgressHandler</a></li>
    <li><a href="../../HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#methodtoHtml">toHtml</a></li>
  </ul>
</td>

</tr></table>
<hr />

<table width="100%" border="0"><tr>






</tr></table>
<hr />

<a name="class_details"></a>
<h3>Class Details</h3>
<div class="tags">
[line 35]<br />
</div><br /><br />
<div class="top">[ <a href="#top">Top</a> ]</div><br />

<hr />
<a name="class_vars"></a>
<h3>Class Variables</h3>
<div class="tags">
	<a name="var$buttonCancel"></a>
	<p></p>
	<h4>$buttonCancel = <span class="value"></span></h4>
	<p>[line 55]</p>
  Attributes of monitor form.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.1</td>
  </tr>
</table>
</div>

  <br />
	<div class="tags">
  <table border="0" cellspacing="0" cellpadding="0">
    <tr>
      <td><b>Type:</b>&nbsp;&nbsp;</td>
      <td>string</td>
    </tr>
      </table>
	</div><br /><br />
	<div class="top">[ <a href="#top">Top</a> ]</div><br />
	<a name="var$buttonStart"></a>
	<p></p>
	<h4>$buttonStart = <span class="value"></span></h4>
	<p>[line 54]</p>
  Attributes of monitor form.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.1</td>
  </tr>
</table>
</div>

  <br />
	<div class="tags">
  <table border="0" cellspacing="0" cellpadding="0">
    <tr>
      <td><b>Type:</b>&nbsp;&nbsp;</td>
      <td>string</td>
    </tr>
      </table>
	</div><br /><br />
	<div class="top">[ <a href="#top">Top</a> ]</div><br />
	<a name="var$windowname"></a>
	<p></p>
	<h4>$windowname = <span class="value"></span></h4>
	<p>[line 53]</p>
  Attributes of monitor form.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.1</td>
  </tr>
</table>
</div>

  <br />
	<div class="tags">
  <table border="0" cellspacing="0" cellpadding="0">
    <tr>
      <td><b>Type:</b>&nbsp;&nbsp;</td>
      <td>string</td>
    </tr>
      </table>
	</div><br /><br />
	<div class="top">[ <a href="#top">Top</a> ]</div><br />
</div><br />

<hr />
<a name="class_methods"></a>
<h3>Class Methods</h3>
<div class="tags">
  <hr />
	<a name="methodHTML_Progress_Monitor"></a>
	<h3>constructor HTML_Progress_Monitor <span class="smalllinenumber">[line 117]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>HTML_Progress_Monitor HTML_Progress_Monitor(
[string
$formName = 'ProgressMonitor'], [array
$attributes = array()], [array
$errorPrefs = array()])</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Constructor Summary<br /><br /><p><ul><li>Creates a standard progress bar into a dialog box (QuickForm).
   Form name, buttons 'start', 'cancel' labels and style, and
   title of dialog box may also be changed.
   <div class="listing"><pre><ol><li>   <span class="src-var">$monitor </span>= <span class="src-key">new </span><a href="../../HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#methodHTML_Progress_Monitor">HTML_Progress_Monitor</a><span class="src-sym">(</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
</ol></pre></div></li></ul> <ul><li>Creates a progress bar into a dialog box, with only a new
   form name.
   <div class="listing"><pre><ol><li>   <span class="src-var">$monitor </span>= <span class="src-key">new </span><a href="../../HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#methodHTML_Progress_Monitor">HTML_Progress_Monitor</a><span class="src-sym">(</span><span class="src-var">$formName</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
</ol></pre></div></li></ul> <ul><li>Creates a progress bar into a dialog box, with a new form name,
   new buttons name and style, and also a different title box.
   <div class="listing"><pre><ol><li>   <span class="src-var">$monitor </span>= <span class="src-key">new </span><a href="../../HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#methodHTML_Progress_Monitor">HTML_Progress_Monitor</a><span class="src-sym">(</span><span class="src-var">$formName</span><span class="src-sym">, </span><span class="src-var">$attributes</span><span class="src-sym">)</span><span class="src-sym">;</span></li>
</ol></pre></div></li></ul></p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>throws:</b>&nbsp;&nbsp;</td><td>HTML_PROGRESS_ERROR_INVALID_INPUT</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$formName</b>&nbsp;&nbsp;</td>
        <td>(optional) Name of monitor dialog box (QuickForm)</td>
      </tr>
          <tr>
        <td class="type">array&nbsp;&nbsp;</td>
        <td><b>$attributes</b>&nbsp;&nbsp;</td>
        <td>(optional) List of renderer options</td>
      </tr>
          <tr>
        <td class="type">array&nbsp;&nbsp;</td>
        <td><b>$errorPrefs</b>&nbsp;&nbsp;</td>
        <td>(optional) Hash of params to configure error handler</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodaccept"></a>
	<h3>method accept <span class="smalllinenumber">[line 378]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void accept(
object
&$renderer)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Accepts a renderer<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.1</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">object&nbsp;&nbsp;</td>
        <td><b>$renderer</b>&nbsp;&nbsp;</td>
        <td>An HTML_QuickForm_Renderer object</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodcallProgressHandler"></a>
	<h3>method callProgressHandler <span class="smalllinenumber">[line 242]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void callProgressHandler(
integer
$arg)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Calls a user-defined progress handler function.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#methodsetProgressHandler">HTML_Progress_Monitor::setProgressHandler()</a>, <a href="../../HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#methodnotify">HTML_Progress_Monitor::notify()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.1</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">integer&nbsp;&nbsp;</td>
        <td><b>$arg</b>&nbsp;&nbsp;</td>
        <td>Current value of the progress bar.</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetProgressElement"></a>
	<h3>method getProgressElement <span class="smalllinenumber">[line 327]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>object &amp;getProgressElement(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns a reference to the progress bar object  used with the monitor.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#methodsetProgressElement">HTML_Progress_Monitor::setProgressElement()</a></td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.1</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetScript"></a>
	<h3>method getScript <span class="smalllinenumber">[line 351]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>string getScript(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns progress javascript.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodgetStyle"></a>
	<h3>method getStyle <span class="smalllinenumber">[line 339]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>string getStyle(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns progress styles (StyleSheet).<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodisCanceled"></a>
	<h3>method isCanceled <span class="smalllinenumber">[line 271]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>bool isCanceled(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns TRUE if progress was canceled by user, FALSE otherwise.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodisStarted"></a>
	<h3>method isStarted <span class="smalllinenumber">[line 258]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>bool isStarted(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns TRUE if progress was started by user, FALSE otherwise.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.1</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodnotify"></a>
	<h3>method notify <span class="smalllinenumber">[line 178]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void notify(
mixed
$event)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Listens all progress events from this monitor.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/HTML_Progress.html#methodprocess">HTML_Progress::process()</a></td>
  </tr>
  <tr>
    <td><b>throws:</b>&nbsp;&nbsp;</td><td>HTML_PROGRESS_ERROR_INVALID_INPUT</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">mixed&nbsp;&nbsp;</td>
        <td><b>$event</b>&nbsp;&nbsp;</td>
        <td>A hash describing the progress event.</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodrun"></a>
	<h3>method run <span class="smalllinenumber">[line 284]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void run(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Display Monitor and catch user action (cancel button).<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetCaption"></a>
	<h3>method setCaption <span class="smalllinenumber">[line 410]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void setCaption(
[string
$caption = '&nbsp;'], [array
$args = array()])</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Display a caption on action in progress.<br /><br /><p>The idea of a simple utility function for replacing variables  with values in an message template, come from sprintfErrorMessage  function of Error_Raise package by Greg Beaver.</p><p>This simple str_replace-based function can be used to have an  order-independent sprintf, so messages can be passed in  with different grammar ordering, or other possibilities without  changing the source code.</p><p>Variables should simply be surrounded by % as in %varname%</p><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.1</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">string&nbsp;&nbsp;</td>
        <td><b>$caption</b>&nbsp;&nbsp;</td>
        <td>(optional) message template</td>
      </tr>
          <tr>
        <td class="type">array&nbsp;&nbsp;</td>
        <td><b>$args</b>&nbsp;&nbsp;</td>
        <td>(optional) associative array of                                       template var -&gt; message text</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetProgressElement"></a>
	<h3>method setProgressElement <span class="smalllinenumber">[line 302]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void setProgressElement(
object
$bar)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Attach a progress bar to this monitor.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/Progress_Observer/HTML_Progress_Monitor.html#methodgetProgressElement">HTML_Progress_Monitor::getProgressElement()</a></td>
  </tr>
  <tr>
    <td><b>throws:</b>&nbsp;&nbsp;</td><td>HTML_PROGRESS_ERROR_INVALID_INPUT</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.1</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">object&nbsp;&nbsp;</td>
        <td><b>$bar</b>&nbsp;&nbsp;</td>
        <td>a html_progress instance</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodsetProgressHandler"></a>
	<h3>method setProgressHandler <span class="smalllinenumber">[line 217]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>void setProgressHandler(
mixed
$handler)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Sets a user-defined progress handler function.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>see:</b>&nbsp;&nbsp;</td><td><a href="../../HTML_Progress/HTML_Progress.html#methodsetProgressHandler">HTML_Progress::setProgressHandler()</a></td>
  </tr>
  <tr>
    <td><b>throws:</b>&nbsp;&nbsp;</td><td>HTML_PROGRESS_ERROR_INVALID_CALLBACK</td>
  </tr>
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.1</td>
  </tr>
</table>
</div>
<br /><br />


        <h4>Parameters:</h4>
    <div class="tags">
    <table border="0" cellspacing="0" cellpadding="0">
          <tr>
        <td class="type">mixed&nbsp;&nbsp;</td>
        <td><b>$handler</b>&nbsp;&nbsp;</td>
        <td>Name of function or a class-method.</td>
      </tr>
        </table>
    </div><br />
        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
  <hr />
	<a name="methodtoHtml"></a>
	<h3>method toHtml <span class="smalllinenumber">[line 364]</span></h3>
	<div class="function">
    <table width="90%" border="0" cellspacing="0" cellpadding="1"><tr><td class="code_border">
    <table width="100%" border="0" cellspacing="0" cellpadding="2"><tr><td class="code">
		<code>string toHtml(
)</code>
    </td></tr></table>
    </td></tr></table><br />
	
		Returns Monitor forms as a Html string.<br /><br /><br /><br />
<h4>Tags:</h4>
<div class="tags">
<table border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td><b>access:</b>&nbsp;&nbsp;</td><td>public</td>
  </tr>
  <tr>
    <td><b>since:</b>&nbsp;&nbsp;</td><td>1.0</td>
  </tr>
</table>
</div>
<br /><br />


        <div class="top">[ <a href="#top">Top</a> ]</div>
  </div>
</div><br />


        <div class="credit">
		    <hr />
		    Documentation generated on Sun, 12 Sep 2004 20:23:41 +0200 by <a href="http://www.phpdoc.org">phpDocumentor 1.3.0RC3</a>
	      </div>
      </td></tr></table>
    </td>
  </tr>
</table>

</body>
</html>