workspace/kcontrol/randr/ktimerdialog.h

   1 /*
   2  *  This file is part of the KDE Libraries
   3  *  Copyright (C) 2002 Hamish Rodda <rodda@kde.org>
   4  *
   5  *  This library is free software; you can redistribute it and/or
   6  *  modify it under the terms of the GNU Library General Public
   7  *  License as published by the Free Software Foundation; either
   8  *  version 2 of the License, or (at your option) any later version.
   9  *
  10  *  This library 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 GNU
  13  *  Library General Public License for more details.
  14  *
  15  *  You should have received a copy of the GNU Library General Public License
  16  *  along with this library; see the file COPYING.LIB.  If not, write to
  17  *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  18  *  Boston, MA 02110-1301, USA.
  19  *
  20  */
  21 #ifndef _KTIMERDIALOG_H_
  22 #define _KTIMERDIALOG_H_
  23
  24 #include <QLabel>
  25
  26 #include <kdialog.h>
  27 #include <kvbox.h>
  28
  29 class QTimer;
  30 class KHBox;
  31 class QProgressBar;
  32 class QLabel;
  33
  34 /**
  35  * Provides a dialog that is only available for a specified amount
  36  * of time, and reports the time remaining to the user.
  37  *
  38  * The timer is capable of counting up or down, for any number of milliseconds.
  39  *
  40  * The button which is activated upon timeout can be specified, as can the
  41  * update interval for the dialog box.
  42  *
  43  * In addition, this class retains all of the functionality of @see KDialog.
  44  *
  45  * @short A dialog with a time limit and corresponding UI features.
  46  * @author Hamish Rodda <rodda@kde.org>
  47  */
  48 class KTimerDialog : public KDialog
  49 {
  50   Q_OBJECT
  51
  52   public:
  53
  54     /**
  55      * @li @p CountDown - The timer counts downwards from the seconds given.
  56      * @li @p CountUp - The timer counts up to the number of seconds given.
  57      * @li @p Manual - The timer is not invoked; the caller must update the
  58      * progress.
  59      */
  60     enum TimerStyle
  61     {
  62         CountDown,
  63         CountUp,
  64         Manual
  65     };
  66
  67     /**
  68      * Constructor for the standard mode where you must specify the main
  69      * widget with @ref setMainWidget() . See @see KDialog for further details.
  70      *
  71      * For the rest of the arguments, See @see KDialog .
  72      */
  73     explicit KTimerDialog( int msec, TimerStyle style=CountDown, QWidget *parent=0,
  74                            const char *name=0, bool modal=true,
  75                            const QString &caption=QString(),
  76                            int buttonMask=Ok|Apply|Cancel, ButtonCode defaultButton=Ok,
  77                            bool separator=false,
  78                            const KGuiItem &user1=KGuiItem(),
  79                            const KGuiItem &user2=KGuiItem(),
  80                            const KGuiItem &user3=KGuiItem() );
  81
  82     /**
  83      * Destructor.
  84      */
  85     ~KTimerDialog();
  86
  87     /**
  88      * Execute the dialog modelessly - see @see QDialog .
  89      */
  90     virtual void setVisible( bool visible );
  91
  92     /**
  93      * Set the refresh interval for the timer progress. Defaults to one second.
  94      */
  95     void setRefreshInterval( int msec );
  96
  97     /**
  98      * Retrieves the @ref ButtonCode which will be activated once the timer
  99      * times out. @see setTimeoutButton
 100      */
 101     int timeoutButton() const;
 102
 103     /**
 104      * Sets the @ref ButtonCode to determine which button will be activated
 105      * once the timer times out. @see timeoutButton
 106      */
 107     void setTimeoutButton( ButtonCode newButton );
 108
 109     /**
 110      * Retrieves the current @ref TimerStyle. @see setTimerStyle
 111      */
 112     int timerStyle() const;
 113
 114     /**
 115      * Sets the @ref TimerStyle. @see timerStyle
 116      */
 117     void setTimerStyle( TimerStyle newStyle );
 118
 119     /**
 120      * Overridden function which is used to set the main widget of the dialog.
 121      * @see KDialog::setMainWidget.
 122      */
 123     void setMainWidget( QWidget *widget );
 124
 125   Q_SIGNALS:
 126     /**
 127      * Signal which is emitted once the timer has timed out.
 128      */
 129     void timerTimeout();
 130
 131   public Q_SLOTS:
 132     /**
 133      * Execute the dialog modally - see @see QDialog .
 134      */
 135     int exec();
 136
 137   private Q_SLOTS:
 138     /**
 139      * Updates the dialog with the current progress levels.
 140      */
 141     void slotUpdateTime( bool update = true );
 142
 143     /**
 144      * The internal
 145      */
 146     void slotInternalTimeout();
 147
 148   private:
 149     /**
 150      * Prepares the layout that manages the widgets of the dialog
 151      */
 152     void setupLayout();
 153
 154     QTimer *totalTimer;
 155     QTimer *updateTimer;
 156     int msecRemaining, updateInterval, msecTotal;
 157
 158     ButtonCode buttonOnTimeout;
 159     TimerStyle tStyle;
 160
 161     KHBox *timerWidget;
 162     QProgressBar *timerProgress;
 163     QLabel *timerLabel;
 164     KVBox *mainWidget;
 165
 166     class KTimerDialogPrivate;
 167     KTimerDialogPrivate *d;
 168 };
 169
 170 #endif
 171
 172
 173