src/corelib/kernel/qtimer.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtCore module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QTIMER_H
  43 #define QTIMER_H
  44
  45 #ifndef QT_NO_QOBJECT
  46
  47 #include <QtCore/qbasictimer.h> // conceptual inheritance
  48 #include <QtCore/qobject.h>
  49
  50 QT_BEGIN_HEADER
  51
  52 QT_BEGIN_NAMESPACE
  53
  54 QT_MODULE(Core)
  55
  56 class Q_CORE_EXPORT QTimer : public QObject
  57 {
  58     Q_OBJECT
  59     Q_PROPERTY(bool singleShot READ isSingleShot WRITE setSingleShot)
  60     Q_PROPERTY(int interval READ interval WRITE setInterval)
  61     Q_PROPERTY(bool active READ isActive)
  62 public:
  63     explicit QTimer(QObject *parent = 0);
  64 #ifdef QT3_SUPPORT
  65     QT3_SUPPORT_CONSTRUCTOR QTimer(QObject *parent, const char *name);
  66 #endif
  67     ~QTimer();
  68
  69     inline bool isActive() const { return id >= 0; }
  70     int timerId() const { return id; }
  71
  72     void setInterval(int msec);
  73     int interval() const { return inter; }
  74
  75     inline void setSingleShot(bool singleShot);
  76     inline bool isSingleShot() const { return single; }
  77
  78     static void singleShot(int msec, QObject *receiver, const char *member);
  79
  80 public Q_SLOTS:
  81     void start(int msec);
  82
  83     void start();
  84     void stop();
  85
  86 #ifdef QT3_SUPPORT
  87     inline QT_MOC_COMPAT void changeInterval(int msec) { start(msec); }
  88     QT_MOC_COMPAT int start(int msec, bool sshot);
  89 #endif
  90
  91 Q_SIGNALS:
  92     void timeout();
  93
  94 protected:
  95     void timerEvent(QTimerEvent *);
  96
  97 private:
  98     Q_DISABLE_COPY(QTimer)
  99
 100     inline int startTimer(int){ return -1;}
 101     inline void killTimer(int){}
 102
 103     int id, inter, del;
 104     uint single : 1;
 105     uint nulltimer : 1;
 106 };
 107
 108 inline void QTimer::setSingleShot(bool asingleShot) { single = asingleShot; }
 109
 110 QT_END_NAMESPACE
 111
 112 QT_END_HEADER
 113
 114 #endif // QT_NO_QOBJECT
 115
 116 #endif // QTIMER_H