/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XProgressHandler.idl,v $
 *
 *  $Revision: 1.8 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 08:10:33 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_ucb_XProgressHandler_idl__
#define __com_sun_star_ucb_XProgressHandler_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif


//=============================================================================

module com { module sun { module star { module ucb {

//=============================================================================
/** Handle a tasks notification that it has made some progress.
*/
published interface XProgressHandler: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /** 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).

        @param Status  An object representing the new activity.  There has to
        be an agreement between caller and callee of methods
        <member>XProgressHandler::push</member> and
        <member>XProgressHandler::update</member> as to which Status
        arguments are meaningful.  For example, a <atom>string</atom> argument
        to <member>XProgressHandler::push</member> should be used to transport
        some status text that describes the progress being made (possibly
        followed by one or more <member>XProgressHandler::update</member>s with
        <atom>string</atom> arguments, if the appropriate status text changes
        as progress is being made).
    */
    void push([in] any Status);

    //-------------------------------------------------------------------------
    /** The task notifies the handler that its current activity is making
        progress.

        @param Status  An object representing the progress made.  See the
        documentation of <member>XProgressHandler::push</member> for more
        information.
    */
    void update([in] any Status);

    //-------------------------------------------------------------------------
    /** The task notifies the handler that it has finished its current
        activity.
    */
    void pop();
};

//=============================================================================

}; }; }; };

#endif
