ProgressBar.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (c) 2004 Werner Mayer <wmayer[at]users.sourceforge.net>     *
 *                                                                         *
 *   This file is part of the FreeCAD CAx development system.              *
 *                                                                         *
 *   This library is free software; you can redistribute it and/or         *
 *   modify it under the terms of the GNU Library General Public           *
 *   License as published by the Free Software Foundation; either          *
 *   version 2 of the License, or (at your option) any later version.      *
 *                                                                         *
 *   This library  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 Library General Public License for more details.                  *
 *                                                                         *
 *   You should have received a copy of the GNU Library General Public     *
 *   License along with this library; see the file COPYING.LIB. If not,    *
 *   write to the Free Software Foundation, Inc., 59 Temple Place,         *
 *   Suite 330, Boston, MA  02111-1307, USA                                *
 *                                                                         *
 ***************************************************************************/


#ifndef GUI_PROGRESSBAR_H
#define GUI_PROGRESSBAR_H

#include <QProgressBar>

#include <Base/Sequencer.h>

namespace Gui {

struct SequencerPrivate;
struct ProgressBarPrivate;
class ProgressBar;

class GuiExport Sequencer : public Base::SequencerBase
{
public:
    static Sequencer* instance();
    void pause();
    void resume();
    bool isBlocking() const;
    QProgressBar* getProgressBar(QWidget* parent=0);

protected:
    Sequencer ();
    ~Sequencer ();

    void setText (const char* pszTxt);
    void startStep();
    void nextStep(bool canAbort);
    void setProgress(size_t);
    void resetData();
    void showRemainingTime();

private:
    void setValue(int step);
    void abort();
    SequencerPrivate* d;
    static Sequencer* _pclSingleton;

    friend class ProgressBar;
};

class ProgressBar : public QProgressBar
{
    Q_OBJECT

public:
    ProgressBar (Sequencer* s, QWidget * parent=0);
    ~ProgressBar ();

    bool eventFilter(QObject* o, QEvent* e);
    int minimumDuration() const;

public Q_SLOTS:
    void setMinimumDuration (int ms);

    bool canAbort() const;

protected:
    void showEvent(QShowEvent*);
    void hideEvent(QHideEvent*);

protected Q_SLOTS:
    /* Shows the progress bar if it is still hidden after the operation has been started
    * and minimumDuration milliseconds have passed.
    */
    void delayedShow();
    void aboutToShow();

private:
    void resetObserveEventFilter();
    void enterControlEvents();
    void leaveControlEvents();
    ProgressBarPrivate* d;
    Sequencer* sequencer;

    friend class Sequencer;
};

} // namespace Gui

#endif // GUI_PROGRESSBAR_H