1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_task_XStatusIndicator_idl__ 24cdf0e10cSrcweir#define __com_sun_star_task_XStatusIndicator_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir//============================================================================= 31cdf0e10cSrcweir 32cdf0e10cSrcweir module com { module sun { module star { module task { 33cdf0e10cSrcweir 34cdf0e10cSrcweir//============================================================================= 35cdf0e10cSrcweir/** controls a status indicator which displays progress of 36cdf0e10cSrcweir longer actions to the user 37cdf0e10cSrcweir 38cdf0e10cSrcweir <p> 39cdf0e10cSrcweir Such objects are provided by a <type>XStatusIndicatorFactory</type>. 40cdf0e10cSrcweir </p> 41cdf0e10cSrcweir 42cdf0e10cSrcweir @see XStatusIndicatorFactory 43cdf0e10cSrcweir */ 44cdf0e10cSrcweirpublished interface XStatusIndicator: com::sun::star::uno::XInterface 45cdf0e10cSrcweir{ 46cdf0e10cSrcweir //------------------------------------------------------------------------- 47cdf0e10cSrcweir /** initialize and start the progress 48cdf0e10cSrcweir 49cdf0e10cSrcweir <p> 50cdf0e10cSrcweir It activates a new created or reactivate an already used inidicator 51cdf0e10cSrcweir (must be finished by calling <member>XStatusIndicator::end()</member> 52cdf0e10cSrcweir before!). By the way it's possible to set first progress description 53cdf0e10cSrcweir and the possible range of progress value. That means that a progress 54cdf0e10cSrcweir can runs from 0 to <var>Range</var>. 55cdf0e10cSrcweir </p> 56cdf0e10cSrcweir 57cdf0e10cSrcweir @param Text 58cdf0e10cSrcweir initial value for progress description for showing 59cdf0e10cSrcweir Value can be updated by calling <member>XStatusIndicator::setText()</member>. 60cdf0e10cSrcweir 61cdf0e10cSrcweir @param Range 62cdf0e10cSrcweir mewns the maximum value of the progress which can be setted by 63cdf0e10cSrcweir calling <member>XStatusIndicator::setValue()</member>. 64cdf0e10cSrcweir */ 65cdf0e10cSrcweir [oneway] void start( 66cdf0e10cSrcweir [in] string Text, 67cdf0e10cSrcweir [in] long Range); 68cdf0e10cSrcweir 69cdf0e10cSrcweir //------------------------------------------------------------------------- 70cdf0e10cSrcweir /** stop the progress 71cdf0e10cSrcweir 72cdf0e10cSrcweir <p> 73cdf0e10cSrcweir Further calls of <member>XStatusIndicator::setText()</member>, 74cdf0e10cSrcweir <member>XStatusIndicator::setValue()</member> or 75cdf0e10cSrcweir <member>XStatusIndicator::reset()</member> must be ignored. 76cdf0e10cSrcweir Only <member>XStatusIndicator::start()</member> can reactivate this 77cdf0e10cSrcweir indicator. 78cdf0e10cSrcweir It's not allowed to destruct the indicator inside this method. 79cdf0e10cSrcweir The instance must be gone by using ref count or disposing. 80cdf0e10cSrcweir </p> 81cdf0e10cSrcweir */ 82cdf0e10cSrcweir [oneway] void end(); 83cdf0e10cSrcweir 84cdf0e10cSrcweir //------------------------------------------------------------------------- 85cdf0e10cSrcweir /** update progress description 86cdf0e10cSrcweir 87cdf0e10cSrcweir <p> 88cdf0e10cSrcweir Initial value can be set during starting of the progress by calling 89cdf0e10cSrcweir <member>XStatusIndicator::start()</member>. 90cdf0e10cSrcweir Stopped indicators must ignore this call. 91cdf0e10cSrcweir </p> 92cdf0e10cSrcweir 93cdf0e10cSrcweir @param Text 94cdf0e10cSrcweir new value for progress description which should be shown now 95cdf0e10cSrcweir */ 96cdf0e10cSrcweir [oneway] void setText( [in] string Text ); 97cdf0e10cSrcweir 98cdf0e10cSrcweir //------------------------------------------------------------------------- 99cdf0e10cSrcweir /** update progress value 100cdf0e10cSrcweir 101cdf0e10cSrcweir <p> 102cdf0e10cSrcweir Wrong values must be ignored and stopped indicators must ignore this 103cdf0e10cSrcweir call generaly. 104cdf0e10cSrcweir </p> 105cdf0e10cSrcweir 106cdf0e10cSrcweir @param Value 107cdf0e10cSrcweir new value for progress which should be shown now 108cdf0e10cSrcweir Must fit the range [0..Range] which was set during 109cdf0e10cSrcweir <member>XStatusIndicator::start()</member>. 110cdf0e10cSrcweir */ 111cdf0e10cSrcweir [oneway] void setValue( [in] long Value ); 112cdf0e10cSrcweir 113cdf0e10cSrcweir //------------------------------------------------------------------------- 114cdf0e10cSrcweir /** clear progress value and description 115cdf0e10cSrcweir 116cdf0e10cSrcweir <p> 117cdf0e10cSrcweir Calling of setValue(0) and setText("") should do the same. 118cdf0e10cSrcweir Stopped indicators must ignore this call. 119cdf0e10cSrcweir </p> 120cdf0e10cSrcweir */ 121cdf0e10cSrcweir [oneway] void reset(); 122cdf0e10cSrcweir}; 123cdf0e10cSrcweir 124cdf0e10cSrcweir}; }; }; }; 125cdf0e10cSrcweir 126cdf0e10cSrcweir#endif 127