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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_ucb_XProgressHandler_idl__
  20 #define __com_sun_star_ucb_XProgressHandler_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24
  25
  26 module com { module sun { module star { module ucb {
  27
  28 /** Handle a tasks notification that it has made some progress.
  29 */
  30 published interface XProgressHandler: com::sun::star::uno::XInterface
  31 {
  32     /** The task notifies the handler that it has started some new activity
  33         (possibly a sub-activity of another activity already making progress;
  34         therefore, these notifications behave in a stack-like manner).
  35
  36         @param Status  An object representing the new activity.  There has to
  37         be an agreement between caller and callee of methods
  38         XProgressHandler::push() and
  39         XProgressHandler::update() as to which Status
  40         arguments are meaningful.  For example, a `string` argument
  41         to XProgressHandler::push() should be used to transport
  42         some status text that describes the progress being made (possibly
  43         followed by one or more XProgressHandler::update()s with
  44         `string` arguments, if the appropriate status text changes
  45         as progress is being made).
  46     */
  47     void push([in] any Status);
  48
  49     /** The task notifies the handler that its current activity is making
  50         progress.
  51
  52         @param Status  An object representing the progress made.  See the
  53         documentation of XProgressHandler::push() for more
  54         information.
  55     */
  56     void update([in] any Status);
  57
  58     /** The task notifies the handler that it has finished its current
  59         activity.
  60     */
  61     void pop();
  62 };
  63
  64
  65 }; }; }; };
  66
  67 #endif
  68
  69 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */