offapi/com/sun/star/task/XStatusIndicator.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: XStatusIndicator.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_task_XStatusIndicator_idl__
  31 #define __com_sun_star_task_XStatusIndicator_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39  module com {  module sun {  module star {  module task {
  40
  41 //=============================================================================
  42 /** controls a status indicator which displays progress of
  43     longer actions to the user
  44
  45     <p>
  46     Such objects are provided by a <type>XStatusIndicatorFactory</type>.
  47     </p>
  48
  49     @see XStatusIndicatorFactory
  50  */
  51 published interface XStatusIndicator: com::sun::star::uno::XInterface
  52 {
  53     //-------------------------------------------------------------------------
  54     /** initialize and start the progress
  55
  56         <p>
  57         It activates a new created or reactivate an already used inidicator
  58         (must be finished by calling <member>XStatusIndicator::end()</member>
  59         before!). By the way it's possible to set first progress description
  60         and the possible range of progress value. That means that a progress
  61         can runs from 0 to <var>Range</var>.
  62         </p>
  63
  64         @param Text
  65             initial value for progress description for showing
  66             Value can be updated by calling <member>XStatusIndicator::setText()</member>.
  67
  68         @param Range
  69             mewns the maximum value of the progress which can be setted by
  70             calling <member>XStatusIndicator::setValue()</member>.
  71      */
  72     [oneway] void start(
  73         [in] string Text,
  74         [in] long Range);
  75
  76     //-------------------------------------------------------------------------
  77     /** stop the progress
  78
  79         <p>
  80         Further calls of <member>XStatusIndicator::setText()</member>,
  81         <member>XStatusIndicator::setValue()</member> or
  82         <member>XStatusIndicator::reset()</member> must be ignored.
  83         Only <member>XStatusIndicator::start()</member> can reactivate this
  84         indicator.
  85         It's not allowed to destruct the indicator inside this method.
  86         The instance must be gone by using ref count or disposing.
  87         </p>
  88      */
  89     [oneway] void end();
  90
  91     //-------------------------------------------------------------------------
  92     /** update progress description
  93
  94         <p>
  95         Initial value can be set during starting of the progress by calling
  96         <member>XStatusIndicator::start()</member>.
  97         Stopped indicators must ignore this call.
  98         </p>
  99
 100         @param Text
 101             new value for progress description which should be shown now
 102      */
 103     [oneway] void setText( [in] string Text );
 104
 105     //-------------------------------------------------------------------------
 106     /** update progress value
 107
 108         <p>
 109         Wrong values must be ignored and stopped indicators must ignore this
 110         call generaly.
 111         </p>
 112
 113         @param Value
 114             new value for progress which should be shown now
 115             Must fit the range [0..Range] which was set during
 116             <member>XStatusIndicator::start()</member>.
 117      */
 118     [oneway] void setValue( [in] long Value );
 119
 120     //-------------------------------------------------------------------------
 121     /** clear progress value and description
 122
 123         <p>
 124         Calling of setValue(0) and setText("") should do the same.
 125         Stopped indicators must ignore this call.
 126         </p>
 127      */
 128     [oneway] void reset();
 129 };
 130
 131 }; }; }; };
 132
 133 #endif