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