1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27#ifndef __com_sun_star_ucb_XProgressHandler_idl__ 28#define __com_sun_star_ucb_XProgressHandler_idl__ 29 30#ifndef __com_sun_star_uno_XInterface_idl__ 31#include <com/sun/star/uno/XInterface.idl> 32#endif 33 34 35//============================================================================= 36 37module com { module sun { module star { module ucb { 38 39//============================================================================= 40/** Handle a tasks notification that it has made some progress. 41*/ 42published interface XProgressHandler: com::sun::star::uno::XInterface 43{ 44 //------------------------------------------------------------------------- 45 /** The task notifies the handler that it has started some new activity 46 (possibly a sub-activity of another activity already making progress; 47 therefore, these notifications behave in a stack-like manner). 48 49 @param Status An object representing the new activity. There has to 50 be an agreement between caller and callee of methods 51 <member>XProgressHandler::push</member> and 52 <member>XProgressHandler::update</member> as to which Status 53 arguments are meaningful. For example, a <atom>string</atom> argument 54 to <member>XProgressHandler::push</member> should be used to transport 55 some status text that describes the progress being made (possibly 56 followed by one or more <member>XProgressHandler::update</member>s with 57 <atom>string</atom> arguments, if the appropriate status text changes 58 as progress is being made). 59 */ 60 void push([in] any Status); 61 62 //------------------------------------------------------------------------- 63 /** The task notifies the handler that its current activity is making 64 progress. 65 66 @param Status An object representing the progress made. See the 67 documentation of <member>XProgressHandler::push</member> for more 68 information. 69 */ 70 void update([in] any Status); 71 72 //------------------------------------------------------------------------- 73 /** The task notifies the handler that it has finished its current 74 activity. 75 */ 76 void pop(); 77}; 78 79//============================================================================= 80 81}; }; }; }; 82 83#endif 84