src/progressindicator.h

   1 /***************************************************************************
   2  *   Copyright (C) 2006 by Peter Penz                                      *
   3  *   peter.penz@gmx.at                                                     *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20 #ifndef PROGRESSINDICATOR_H
  21 #define PROGRESSINDICATOR_H
  22
  23 #include <qdatetime.h>
  24
  25 class DolphinMainWindow;
  26
  27 /**
  28  * Allows to show a progress of synchronous operations. Sample code:
  29  * \code
  30  * const int operationsCount = 100;
  31  * ProgressIndicator progressIndicator(i18n("Loading..."),
  32  *                                     i18n("Loading finished."),
  33  *                                     operationsCount);
  34  * for (int i = 0; i < operationsCount; ++i) {
  35  *     progressIndicator.execOperation();
  36  *     // do synchronous operation...
  37  * }
  38  * \endcode
  39  * The progress indicator takes care to show the progress bar only after
  40  * a delay of around 500 milliseconds. This means if all operations are
  41  * executing within 500 milliseconds, no progress bar is shown at all.
  42  * As soon as the progress bar is shown, the application still may process
  43  * events, but the the Dolphin main widget is disabled.
  44  *
  45  *      @author Peter Penz <peter.penz@gmx.at>
  46  */
  47 class ProgressIndicator
  48 {
  49 public:
  50     /**
  51      * @param mainWindow        The mainwindow this statusbar should operate on
  52      * @param progressText      Text for the progress bar (e. g. "Loading...").
  53      * @param finishedText      Text which is displayed after the operations have been finished
  54      *                          (e. g. "Loading finished.").
  55      * @param operationsCount   Number of operations.
  56      */
  57     ProgressIndicator(DolphinMainWindow *mainWindow,
  58                       const QString& progressText,
  59                       const QString& finishedText,
  60                       int operationsCount);
  61
  62     /**
  63      * Sets the progress to 100 % and displays the 'finishedText' property
  64      *  in the status bar.
  65      */
  66     ~ProgressIndicator();
  67
  68     /**
  69      * Increases the progress and should be invoked
  70      * before each operation.
  71      */
  72     void execOperation();
  73
  74 private:
  75     DolphinMainWindow *m_mainWindow;
  76     bool m_showProgress;
  77     int m_operationsCount;
  78     int m_operationsIndex;
  79     QTime m_startTime;
  80     QString m_finishedText;
  81 };
  82
  83 #endif