Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > media > main-testing > by-pkgid > 2c50825dd66d0497b96a67f7fab2ee84 > files > 7288

openoffice.org64-devel-doc-2.4.1.10-1mdv2008.1.x86_64.rpm

<html>
<head>
<title>Interface XProgressHandler</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="../../../../idl.css">
</head>
<body>
<div id="adc-idlref">

<a name="_top_"> </a><table class="navimain" border="0" cellpadding="3">
<tr>
<td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td>
<td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td>
<td class="navimain"><a href="XProgressHandler-xref.html" class="navimain">Use</a></td>
<td class="navimainnone">Devguide</td>
<td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td>
</tr>
</table>
<table class="navisub" border="0" cellpadding="0">
<tr>
<td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td>
<td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td>
<td class="navisub">Attributes' Summary</td>
<td class="navisub">Attributes' Details</td>
</tr>
</table>
<hr>
<table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;">
<tr>
<td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">ucb</a> :: </p>
</td>
</tr>
<tr>
<td class="title">interface XProgressHandler</td>
</tr>
<tr>
<td/></tr>
<tr>
<td><dl>
<dt><b>Description</b></dt>
<dd>Handle a tasks notification that it has made some progress.
</dd>
</dl>
</td>
</tr>
</table>
<hr>
<a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle" colspan="2">Methods' Summary</td>
</tr>
<tr>
<td class="imsum_left"><a href="#push">push</a></td>
<td class="imsum_right">The task notifies the handler that it has started some new activity
 (possibly a sub-activity of another activity already making progress;
 therefore, these notifications behave in a stack-like manner).

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#update">update</a></td>
<td class="imsum_right">The task notifies the handler that its current activity is making
 progress.

 &nbsp;</td>
</tr>
<tr>
<td class="imsum_left"><a href="#pop">pop</a></td>
<td class="imsum_right">The task notifies the handler that it has finished its current
 activity.
 &nbsp;</td>
</tr>
</table>
<a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle">
<tr>
<td class="subtitle">Methods' Details</td>
</tr>
<tr>
<td class="imdetail"><a name="push" class="membertitle">push</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>push</b>(</td>
<td valign="top">[in] any</td>
<td valign="bottom">&nbsp;Status );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>The task notifies the handler that it has started some new activity
 (possibly a sub-activity of another activity already making progress;
 therefore, these notifications behave in a stack-like manner).

 </dd>
<dt><b>Parameter Status</b></dt>
<dd>An object representing the new activity. There has to
 be an agreement between caller and callee of methods
 <a href="XProgressHandler.html">XProgressHandler</a>::<a href="XProgressHandler.html#push">push</a> and 
 <a href="XProgressHandler.html">XProgressHandler</a>::<a href="XProgressHandler.html#update">update</a> as to which Status
 arguments are meaningful. For example, a <code>string</code> argument
 to <a href="XProgressHandler.html">XProgressHandler</a>::<a href="XProgressHandler.html#push">push</a> should be used to transport
 some status text that describes the progress being made (possibly 
 followed by one or more <a href="XProgressHandler.html">XProgressHandler</a>::<a href="XProgressHandler.html#update">update</a>s with
 <code>string</code> arguments, if the appropriate status text changes 
 as progress is being made).
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="update" class="membertitle">update</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>update</b>(</td>
<td valign="top">[in] any</td>
<td valign="bottom">&nbsp;Status );</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>The task notifies the handler that its current activity is making
 progress.

 </dd>
<dt><b>Parameter Status</b></dt>
<dd>An object representing the progress made. See the
 documentation of <a href="XProgressHandler.html">XProgressHandler</a>::<a href="XProgressHandler.html#push">push</a> for more 
 information.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td class="imdetail"><a name="pop" class="membertitle">pop</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center">
<tr>
<td><table class="table-in-method" border="0">
<tr>
<td valign="top" colspan="3">void</td>
</tr>
<tr>
<td valign="top"><b>pop</b>();</td>
</tr>
</table>
<hr>
<dl>
<dt><b>Description</b></dt>
<dd>The task notifies the handler that it has finished its current
 activity.
 </dd>
</dl>
</td>
</tr>
</table>
</td>
</tr>
</table>
<a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright &copy; 2008 Sun Microsystems, Inc.</p>

</div> <!-- id="adc-idlref" -->
</body>

</html>