com :: sun :: star :: ucb :: interface XProgressHandler
- Base Interface
- com::sun::star::uno::XInterface
- Description
- Handle a tasks notification that it has made some progress.
Methods' Summary
|
push |
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).
|
update |
The task notifies the handler that its current activity is making
progress.
|
pop |
The task notifies the handler that it has finished its current
activity.
|
Methods' Details
|
- push
-  
- void
push(
-
- Description
- 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).
- Parameter Status
- An object representing the new activity. There has to
be an agreement between caller and callee of methods
XProgressHandler::push and
XProgressHandler::update as to which Status
arguments are meaningful. For example, a
string argument
to XProgressHandler::push should be used to transport
some status text that describes the progress being made (possibly
followed by one or more XProgressHandler::update s with
string arguments, if the appropriate status text changes
as progress is being made).
|
- update
-  
- void
update(
-
- Description
- The task notifies the handler that its current activity is making
progress.
- Parameter Status
- An object representing the progress made. See the
documentation of XProgressHandler::push for more
information.
|
- pop
-  
void
pop();
- Description
- The task notifies the handler that it has finished its current
activity.
|
Top of Page
Copyright 2002 Sun Microsystems, Inc., 901 San Antonio Road, Palo Alto, CA 94303 USA.