offapi/com/sun/star/ucb/XProgressHandler.idl

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