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