/**
 * @file
 * $Id$
 * $Revision$
 * $Author$
 * $Date$
 *
 * This file is part of The iWear Framework.
 *
 * The iWear Framework is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by the
 * Free Software Foundation as in version 2 of the License.

 * 
 * The iWear Framework is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 * 
 * You should have received a copy of the GNU General Public License along with
 * The iWear Framework; if not, write to the Free Software Foundation, Inc., 59
 * Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef __IWEAR_PROGRESSINDICATOR
#define __IWEAR_PROGRESSINDICATOR

#ifndef __IWEAR_IWEAR_H
#include <iwear/iwear.h>
#endif

#include "iwear/cstdint.h"

namespace iwear {

/**
 * This is a basic Object for a Progress Indicator. A derived object will
 * choose by itself how to actuall display the progress (As a Bar, In Number,
 * As percent etc.)
 */
class ProgressIndicator
{
public:
    virtual ~ProgressIndicator() {}
 
   /**
    * @param current is the current value how far the stuff is
    * @param max is the maximum value the progress can go to
    * @return 0 If everything is ok, otherwise if the current process should be
    * aborted
    */   
    virtual uint32_t update_progress( double current, double max ) = 0;

   /**
    * Tell the Indicator that the process has finished, so it can undisplay any
    * progress bar or whatever
    */
    virtual void finished( void ) = 0;

    virtual void set_progress_msg( const string& ) = 0;
};

}

#endif