src/quick/util/qquicktimer_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the QtQml module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/contact-us.
  16 **
  17 ** GNU Lesser General Public License Usage
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QQUICKTIMER_H
  43 #define QQUICKTIMER_H
  44
  45 #include <qqml.h>
  46
  47 #include <QtCore/qobject.h>
  48
  49 #include <private/qtquickglobal_p.h>
  50
  51 QT_BEGIN_HEADER
  52
  53 QT_BEGIN_NAMESPACE
  54
  55 class QQuickTimerPrivate;
  56 class Q_AUTOTEST_EXPORT QQuickTimer : public QObject, public QQmlParserStatus
  57 {
  58     Q_OBJECT
  59     Q_DECLARE_PRIVATE(QQuickTimer)
  60     Q_INTERFACES(QQmlParserStatus)
  61     Q_PROPERTY(int interval READ interval WRITE setInterval NOTIFY intervalChanged)
  62     Q_PROPERTY(bool running READ isRunning WRITE setRunning NOTIFY runningChanged)
  63     Q_PROPERTY(bool repeat READ isRepeating WRITE setRepeating NOTIFY repeatChanged)
  64     Q_PROPERTY(bool triggeredOnStart READ triggeredOnStart WRITE setTriggeredOnStart NOTIFY triggeredOnStartChanged)
  65     Q_PROPERTY(QObject *parent READ parent CONSTANT)
  66
  67 public:
  68     QQuickTimer(QObject *parent=0);
  69
  70     void setInterval(int interval);
  71     int interval() const;
  72
  73     bool isRunning() const;
  74     void setRunning(bool running);
  75
  76     bool isRepeating() const;
  77     void setRepeating(bool repeating);
  78
  79     bool triggeredOnStart() const;
  80     void setTriggeredOnStart(bool triggeredOnStart);
  81
  82 protected:
  83     void classBegin();
  84     void componentComplete();
  85
  86 public Q_SLOTS:
  87     void start();
  88     void stop();
  89     void restart();
  90
  91 Q_SIGNALS:
  92     void triggered();
  93     void runningChanged();
  94     void intervalChanged();
  95     void repeatChanged();
  96     void triggeredOnStartChanged();
  97
  98 private:
  99     void update();
 100
 101 private Q_SLOTS:
 102     void ticked();
 103 };
 104
 105 QT_END_NAMESPACE
 106
 107 QML_DECLARE_TYPE(QQuickTimer)
 108
 109 QT_END_HEADER
 110
 111 #endif