/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */


 module com {  module sun {  module star {  module task {

/** controls a status indicator which displays progress of
    longer actions to the user

    <p>
    Such objects are provided by a XStatusIndicatorFactory.
    </p>

    @see XStatusIndicatorFactory
 */
published interface XStatusIndicator: com::sun::star::uno::XInterface
{
    /** initialize and start the progress

        <p>
        It activates a new created or reactivate an already used indicator
        (must be finished by calling XStatusIndicator::end()
        before!). By the way it's possible to set first progress description
        and the possible range of progress value. That means that a progress
        can runs from 0 to <var>Range</var>.
        </p>

        @param Text
            initial value for progress description for showing
            Value can be updated by calling XStatusIndicator::setText().

        @param Range
            means the maximum value of the progress which can be set by
            calling XStatusIndicator::setValue().
     */
    void start(
        [in] string Text,
        [in] long Range);

    /** stop the progress

        <p>
        Further calls of XStatusIndicator::setText(),
        XStatusIndicator::setValue() or
        XStatusIndicator::reset() must be ignored.
        Only XStatusIndicator::start() can reactivate this
        indicator.
        It's not allowed to destruct the indicator inside this method.
        The instance must be gone by using ref count or disposing.
        </p>
     */
    void end();

    /** update progress description

        <p>
        Initial value can be set during starting of the progress by calling
        XStatusIndicator::start().
        Stopped indicators must ignore this call.
        </p>

        @param Text
            new value for progress description which should be shown now
     */
    void setText( [in] string Text );

    /** update progress value

        <p>
        Wrong values must be ignored and stopped indicators must ignore this
        call generally.
        </p>

        @param Value
            new value for progress which should be shown now
            Must fit the range [0..Range] which was set during
            XStatusIndicator::start().
     */
    void setValue( [in] long Value );

    /** clear progress value and description

        <p>
        Calling of setValue(0) and setText("") should do the same.
        Stopped indicators must ignore this call.
        </p>
     */
    void reset();
};

}; }; }; };

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
