ProgressDisplay.h

Go to the documentation of this file.

// -*- c-basic-offset: 4 -*-
#ifndef _APPBASE_PROGRESSDISPLAY_H
#define _APPBASE_PROGRESSDISPLAY_H

#include <iostream>
#include <string>

#include <hugin_shared.h>
#include <hugin_utils/utils.h>


namespace AppBase {

class IMPEX ProgressDisplay
{
protected:
    explicit ProgressDisplay(int maximum=0) : m_canceled(false), m_maximum(maximum), m_progress(0) {};
public:
    /* virtual destructor */
    virtual ~ProgressDisplay() {};
    void setMessage(const std::string& message, const std::string& filename="");
    void taskFinished();
    bool updateDisplay();
    bool updateDisplay(const std::string& message);
    bool updateDisplayValue();
    void setMaximum(int newMaximum);
    bool wasCancelled();

protected:
    virtual void updateProgressDisplay() = 0;

protected:
    bool m_canceled;
    std::string m_message;
    std::string m_filename;
    int m_maximum;
    int m_progress;
};


class IMPEX DummyProgressDisplay : public ProgressDisplay
{
protected:
    virtual void updateProgressDisplay() {};
};

class IMPEX StreamProgressDisplay : public ProgressDisplay
{
    public:
        explicit StreamProgressDisplay(std::ostream & o) : ProgressDisplay(), m_stream(o) {};
        virtual void updateProgressDisplay();
    protected:
        std::ostream & m_stream;
};

}; //namespace

#endif // _H