1 | /**************************************************************************** |
2 | ** |
3 | ** Copyright (C) 2016 The Qt Company Ltd. |
4 | ** Contact: https://www.qt.io/licensing/ |
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 The Qt Company. For licensing terms |
14 | ** and conditions see https://www.qt.io/terms-conditions. For further |
15 | ** information use the contact form at https://www.qt.io/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 3 as published by the Free Software |
20 | ** Foundation and appearing in the file LICENSE.LGPL3 included in the |
21 | ** packaging of this file. Please review the following information to |
22 | ** ensure the GNU Lesser General Public License version 3 requirements |
23 | ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. |
24 | ** |
25 | ** GNU General Public License Usage |
26 | ** Alternatively, this file may be used under the terms of the GNU |
27 | ** General Public License version 2.0 or (at your option) the GNU General |
28 | ** Public license version 3 or any later version approved by the KDE Free |
29 | ** Qt Foundation. The licenses are as published by the Free Software |
30 | ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 |
31 | ** included in the packaging of this file. Please review the following |
32 | ** information to ensure the GNU General Public License requirements will |
33 | ** be met: https://www.gnu.org/licenses/gpl-2.0.html and |
34 | ** https://www.gnu.org/licenses/gpl-3.0.html. |
35 | ** |
36 | ** $QT_END_LICENSE$ |
37 | ** |
38 | ****************************************************************************/ |
39 | |
40 | #ifndef QQMLTIMER_H |
41 | #define QQMLTIMER_H |
42 | |
43 | // |
44 | // W A R N I N G |
45 | // ------------- |
46 | // |
47 | // This file is not part of the Qt API. It exists purely as an |
48 | // implementation detail. This header file may change from version to |
49 | // version without notice, or even be removed. |
50 | // |
51 | // We mean it. |
52 | // |
53 | |
54 | #include <qqml.h> |
55 | |
56 | #include <QtCore/qobject.h> |
57 | |
58 | #include <private/qtqmlglobal_p.h> |
59 | |
60 | QT_REQUIRE_CONFIG(qml_animation); |
61 | |
62 | QT_BEGIN_NAMESPACE |
63 | |
64 | class QQmlTimerPrivate; |
65 | class Q_QML_PRIVATE_EXPORT QQmlTimer : public QObject, public QQmlParserStatus |
66 | { |
67 | Q_OBJECT |
68 | Q_DECLARE_PRIVATE(QQmlTimer) |
69 | Q_INTERFACES(QQmlParserStatus) |
70 | Q_PROPERTY(int interval READ interval WRITE setInterval NOTIFY intervalChanged) |
71 | Q_PROPERTY(bool running READ isRunning WRITE setRunning NOTIFY runningChanged) |
72 | Q_PROPERTY(bool repeat READ isRepeating WRITE setRepeating NOTIFY repeatChanged) |
73 | Q_PROPERTY(bool triggeredOnStart READ triggeredOnStart WRITE setTriggeredOnStart NOTIFY triggeredOnStartChanged) |
74 | Q_PROPERTY(QObject *parent READ parent CONSTANT) |
75 | QML_NAMED_ELEMENT(Timer) |
76 | |
77 | public: |
78 | QQmlTimer(QObject *parent=nullptr); |
79 | |
80 | void setInterval(int interval); |
81 | int interval() const; |
82 | |
83 | bool isRunning() const; |
84 | void setRunning(bool running); |
85 | |
86 | bool isRepeating() const; |
87 | void setRepeating(bool repeating); |
88 | |
89 | bool triggeredOnStart() const; |
90 | void setTriggeredOnStart(bool triggeredOnStart); |
91 | |
92 | protected: |
93 | void classBegin() override; |
94 | void componentComplete() override; |
95 | |
96 | bool event(QEvent *) override; |
97 | |
98 | public Q_SLOTS: |
99 | void start(); |
100 | void stop(); |
101 | void restart(); |
102 | |
103 | Q_SIGNALS: |
104 | void triggered(); |
105 | void runningChanged(); |
106 | void intervalChanged(); |
107 | void repeatChanged(); |
108 | void triggeredOnStartChanged(); |
109 | |
110 | private: |
111 | void update(); |
112 | |
113 | private Q_SLOTS: |
114 | void ticked(); |
115 | }; |
116 | |
117 | QT_END_NAMESPACE |
118 | |
119 | QML_DECLARE_TYPE(QQmlTimer) |
120 | |
121 | #endif |
122 | |