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