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 /**
  26  * Allows to show a progress of synchronous operations. Sample code:
  27  * \code
  28  * const int operationsCount = 100;
  29  * ProgressIndicator progressIndicator(i18n("Loading..."),
  30  *                                     i18n("Loading finished."),
  31  *                                     operationsCount);
  32  * for (int i = 0; i < operationsCount; ++i) {
  33  *     progressIndicator.execOperation();
  34  *     // do synchronous operation...
  35  * }
  36  * \endcode
  37  * The progress indicator takes care to show the progress bar only after
  38  * a delay of around 500 milliseconds. This means if all operations are
  39  * executing within 500 milliseconds, no progress bar is shown at all.
  40  * As soon as the progress bar is shown, the application still may process
  41  * events, but the the Dolphin main widget is disabled.
  42  *
  43  *      @author Peter Penz <peter.penz@gmx.at>
  44  */
  45 class ProgressIndicator
  46 {
  47 public:
  48     /**
  49      * @param progressText      Text for the progress bar (e. g. "Loading...").
  50      * @param finishedText      Text which is displayed after the operations have been finished
  51      *                          (e. g. "Loading finished.").
  52      * @param operationsCount   Number of operations.
  53      */
  54     ProgressIndicator(const QString& progressText,
  55                       const QString& finishedText,
  56                       int operationsCount);
  57
  58     /**
  59      * Sets the progress to 100 % and displays the 'finishedText' property
  60      *  in the status bar.
  61      */
  62     ~ProgressIndicator();
  63
  64     /**
  65      * Increases the progress and should be invoked
  66      * before each operation.
  67      */
  68     void execOperation();
  69
  70 private:
  71     bool m_showProgress;
  72     int m_operationsCount;
  73     int m_operationsIndex;
  74     QTime m_startTime;
  75     QString m_finishedText;
  76 };
  77
  78 #endif