src/quick/util/qdeclarativetimer_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: http://www.qt-project.org/
   6 **
   7 ** This file is part of the QtDeclarative 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 QDECLARATIVETIMER_H
  43 #define QDECLARATIVETIMER_H
  44
  45 #include <qdeclarative.h>
  46
  47 #include <QtCore/qobject.h>
  48 #include <QtCore/qabstractanimation.h>
  49
  50 #include <private/qtquickglobal_p.h>
  51
  52 QT_BEGIN_HEADER
  53
  54 QT_BEGIN_NAMESPACE
  55
  56 class QDeclarativeTimerPrivate;
  57 class Q_QUICK_PRIVATE_EXPORT QDeclarativeTimer : public QObject, public QDeclarativeParserStatus
  58 {
  59     Q_OBJECT
  60     Q_DECLARE_PRIVATE(QDeclarativeTimer)
  61     Q_INTERFACES(QDeclarativeParserStatus)
  62     Q_PROPERTY(int interval READ interval WRITE setInterval NOTIFY intervalChanged)
  63     Q_PROPERTY(bool running READ isRunning WRITE setRunning NOTIFY runningChanged)
  64     Q_PROPERTY(bool repeat READ isRepeating WRITE setRepeating NOTIFY repeatChanged)
  65     Q_PROPERTY(bool triggeredOnStart READ triggeredOnStart WRITE setTriggeredOnStart NOTIFY triggeredOnStartChanged)
  66     Q_PROPERTY(QObject *parent READ parent CONSTANT)
  67
  68 public:
  69     QDeclarativeTimer(QObject *parent=0);
  70
  71     void setInterval(int interval);
  72     int interval() const;
  73
  74     bool isRunning() const;
  75     void setRunning(bool running);
  76
  77     bool isRepeating() const;
  78     void setRepeating(bool repeating);
  79
  80     bool triggeredOnStart() const;
  81     void setTriggeredOnStart(bool triggeredOnStart);
  82
  83 protected:
  84     void classBegin();
  85     void componentComplete();
  86
  87 public Q_SLOTS:
  88     void start();
  89     void stop();
  90     void restart();
  91
  92 Q_SIGNALS:
  93     void triggered();
  94     void runningChanged();
  95     void intervalChanged();
  96     void repeatChanged();
  97     void triggeredOnStartChanged();
  98
  99 private:
 100     void update();
 101
 102 private Q_SLOTS:
 103     void ticked();
 104     void finished();
 105 };
 106
 107 QT_END_NAMESPACE
 108
 109 QML_DECLARE_TYPE(QDeclarativeTimer)
 110
 111 QT_END_HEADER
 112
 113 #endif