1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_ucb_XProgressHandler_idl__
24#define __com_sun_star_ucb_XProgressHandler_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30
31//=============================================================================
32
33module com { module sun { module star { module ucb {
34
35//=============================================================================
36/** Handle a tasks notification that it has made some progress.
37*/
38published interface XProgressHandler: com::sun::star::uno::XInterface
39{
40	//-------------------------------------------------------------------------
41	/** The task notifies the handler that it has started some new activity
42		(possibly a sub-activity of another activity already making progress;
43		therefore, these notifications behave in a stack-like manner).
44
45		@param Status  An object representing the new activity.  There has to
46		be an agreement between caller and callee of methods
47		<member>XProgressHandler::push</member> and
48        <member>XProgressHandler::update</member> as to which Status
49		arguments are meaningful.  For example, a <atom>string</atom> argument
50		to <member>XProgressHandler::push</member> should be used to transport
51        some status text that describes the progress being made (possibly
52        followed by one or more <member>XProgressHandler::update</member>s with
53        <atom>string</atom> arguments, if the appropriate status text changes
54        as progress is being made).
55	*/
56	void push([in] any Status);
57
58	//-------------------------------------------------------------------------
59	/** The task notifies the handler that its current activity is making
60		progress.
61
62		@param Status  An object representing the progress made.  See the
63		documentation of <member>XProgressHandler::push</member> for more
64        information.
65	*/
66	void update([in] any Status);
67
68	//-------------------------------------------------------------------------
69	/** The task notifies the handler that it has finished its current
70		activity.
71	*/
72	void pop();
73};
74
75//=============================================================================
76
77}; }; }; };
78
79#endif
80