src/declarative/util/qdeclarativetimer_p.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 QtDeclarative module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** No Commercial Usage
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 ** Alternatively, this file may be used under the terms of the GNU Lesser
  18 ** General Public License version 2.1 as published by the Free Software
  19 ** Foundation and appearing in the file LICENSE.LGPL included in the
  20 ** packaging of this file.  Please review the following information to
  21 ** ensure the GNU Lesser General Public License version 2.1 requirements
  22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  23 **
  24 ** In addition, as a special exception, Nokia gives you certain additional
  25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **
  32 **
  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/qdeclarativeglobal_p.h>
  51
  52 QT_BEGIN_HEADER
  53
  54 QT_BEGIN_NAMESPACE
  55
  56 QT_MODULE(Declarative)
  57
  58 class QDeclarativeTimerPrivate;
  59 class Q_DECLARATIVE_PRIVATE_EXPORT QDeclarativeTimer : public QObject, public QDeclarativeParserStatus
  60 {
  61     Q_OBJECT
  62     Q_DECLARE_PRIVATE(QDeclarativeTimer)
  63     Q_INTERFACES(QDeclarativeParserStatus)
  64     Q_PROPERTY(int interval READ interval WRITE setInterval NOTIFY intervalChanged)
  65     Q_PROPERTY(bool running READ isRunning WRITE setRunning NOTIFY runningChanged)
  66     Q_PROPERTY(bool repeat READ isRepeating WRITE setRepeating NOTIFY repeatChanged)
  67     Q_PROPERTY(bool triggeredOnStart READ triggeredOnStart WRITE setTriggeredOnStart NOTIFY triggeredOnStartChanged)
  68     Q_PROPERTY(QObject *parent READ parent CONSTANT)
  69
  70 public:
  71     QDeclarativeTimer(QObject *parent=0);
  72
  73     void setInterval(int interval);
  74     int interval() const;
  75
  76     bool isRunning() const;
  77     void setRunning(bool running);
  78
  79     bool isRepeating() const;
  80     void setRepeating(bool repeating);
  81
  82     bool triggeredOnStart() const;
  83     void setTriggeredOnStart(bool triggeredOnStart);
  84
  85 protected:
  86     void classBegin();
  87     void componentComplete();
  88
  89 public Q_SLOTS:
  90     void start();
  91     void stop();
  92     void restart();
  93
  94 Q_SIGNALS:
  95     void triggered();
  96     void runningChanged();
  97     void intervalChanged();
  98     void repeatChanged();
  99     void triggeredOnStartChanged();
 100
 101 private:
 102     void update();
 103
 104 private Q_SLOTS:
 105     void ticked();
 106     void finished();
 107 };
 108
 109 QT_END_NAMESPACE
 110
 111 QML_DECLARE_TYPE(QDeclarativeTimer)
 112
 113 QT_END_HEADER
 114
 115 #endif