summaryrefslogtreecommitdiffstats
path: root/src/declarative/util/qmltimer.cpp
blob: 0be62f47d0a8b69415bb48307bee1c7b1c77ec67 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** All rights reserved.
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** This file is part of the QtDeclarative module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** No Commercial Usage
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights.  These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
**
**
**
**
**
**
**
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include "QtCore/qcoreapplication.h"
#include "QtCore/qpauseanimation.h"
#include "private/qobject_p.h"
#include "qmltimer_p.h"
#include "qdebug.h"

QT_BEGIN_NAMESPACE

QML_DEFINE_TYPE(Qt,4,6,Timer,QmlTimer)

class QmlTimerPrivate : public QObjectPrivate
{
    Q_DECLARE_PUBLIC(QmlTimer)
public:
    QmlTimerPrivate()
        : interval(1000), running(false), repeating(false), triggeredOnStart(false)
        , classBegun(false), componentComplete(false) {}
    int interval;
    QPauseAnimation pause;
    bool running : 1;
    bool repeating : 1;
    bool triggeredOnStart : 1;
    bool classBegun : 1;
    bool componentComplete : 1;
};

/*!
    \qmlclass Timer QmlTimer
    \brief The Timer item triggers a handler at a specified interval.

    A timer can be used to trigger an action either once, or repeatedly
    at a given interval.

    \qml
    Timer {
        interval: 500; running: true; repeat: true
        onTriggered: time.text = Date().toString()
    }
    Text {
        id: time
    }
    \endqml

    QmlTimer is synchronized with the animation timer.  Since the animation
    timer is usually set to 60fps, the resolution of QmlTimer will be
    at best 16ms.
*/

QmlTimer::QmlTimer(QObject *parent)
    : QObject(*(new QmlTimerPrivate), parent)
{
    Q_D(QmlTimer);
    connect(&d->pause, SIGNAL(currentLoopChanged(int)), this, SLOT(ticked()));
    connect(&d->pause, SIGNAL(stateChanged(QAbstractAnimation::State,QAbstractAnimation::State))
            , this, SLOT(stateChanged(QAbstractAnimation::State,QAbstractAnimation::State)));
    d->pause.setLoopCount(1);
    d->pause.setDuration(d->interval);
}

/*!
    \qmlproperty int Timer::interval

    Sets the \a interval in milliseconds between triggering.

    The default interval is 1000 milliseconds.
*/
void QmlTimer::setInterval(int interval)
{
    Q_D(QmlTimer);
    if (interval != d->interval) {
        d->interval = interval;
        update();
    }
}

int QmlTimer::interval() const
{
    Q_D(const QmlTimer);
    return d->interval;
}

/*!
    \qmlproperty bool Timer::running

    If set to true, starts the timer; otherwise stops the timer.
    For a non-repeating timer, \a running  will be set to false after the
    timer has been triggered.

    \a running defaults to false.

    \sa repeat
*/
bool QmlTimer::isRunning() const
{
    Q_D(const QmlTimer);
    return d->running;
}

void QmlTimer::setRunning(bool running)
{
    Q_D(QmlTimer);
    if (d->running != running) {
        d->running = running;
        emit runningChanged();
        update();
    }
}

/*!
    \qmlproperty bool Timer::repeat

    If \a repeat is true the timer will be triggered repeatedly at the
    specified interval; otherwise, the timer will trigger once at the
    specified interval and then stop (i.e. running will be set to false).

    \a repeat defaults to false.

    \sa running
*/
bool QmlTimer::isRepeating() const
{
    Q_D(const QmlTimer);
    return d->repeating;
}

void QmlTimer::setRepeating(bool repeating)
{
    Q_D(QmlTimer);
    if (repeating != d->repeating) {
        d->repeating = repeating;
        update();
    }
}

/*!
    \qmlproperty bool Timer::triggeredOnStart

    When the Timer is started the first trigger is normally after the specified
    interval has elapsed.  It is sometimes desireable to trigger immediately
    when the timer is started, for example to establish an initial
    state.

    If \a triggeredOnStart is true, the timer will be triggered immediately
    when started, and subsequently at the specified interval.  Note that for
    a Timer with \e repeat set to false, this will result in the timer being
    triggered twice; once on start, and again at the interval.

    \a triggeredOnStart defaults to false.

    \sa running
*/
bool QmlTimer::triggeredOnStart() const
{
    Q_D(const QmlTimer);
    return d->triggeredOnStart;
}

void QmlTimer::setTriggeredOnStart(bool triggeredOnStart)
{
    Q_D(QmlTimer);
    if (d->triggeredOnStart != triggeredOnStart) {
        d->triggeredOnStart = triggeredOnStart;
        update();
    }
}

/*!
    \qmlmethod Timer::start()
    \brief Starts the timer.

    If the timer is already running, calling this method has no effect.  The
    \c running property will be true following a call to \c start().
*/
void QmlTimer::start()
{
    setRunning(true);
}

/*!
    \qmlmethod Timer::stop()
    \brief stops the timer.

    If the timer is not running, calling this method has no effect.  The
    \c running property will be false following a call to \c stop().
*/
void QmlTimer::stop()
{
    setRunning(false);
}

void QmlTimer::update()
{
    Q_D(QmlTimer);
    if (d->classBegun && !d->componentComplete)
        return;
    d->pause.stop();
    if (d->running) {
        d->pause.setLoopCount(d->repeating ? -1 : 1);
        d->pause.setDuration(d->interval);
        d->pause.start();
        if (d->triggeredOnStart) {
            QCoreApplication::removePostedEvents(this, QEvent::MetaCall);
            QMetaObject::invokeMethod(this, "ticked", Qt::QueuedConnection);
        }
    }
}

void QmlTimer::classBegin()
{
    Q_D(QmlTimer);
    d->classBegun = true;
}

void QmlTimer::componentComplete()
{
    Q_D(QmlTimer);
    d->componentComplete = true;
    update();
}

/*!
    \qmlsignal Timer::onTriggered()

    This handler is called when the Timer is triggered.
*/
void QmlTimer::ticked()
{
    Q_D(QmlTimer);
    if (d->running)
        emit triggered();
}

void QmlTimer::stateChanged(QAbstractAnimation::State state, QAbstractAnimation::State)
{
    Q_D(QmlTimer);
    if (d->running && state != QAbstractAnimation::Running) {
        d->running = false;
        emit triggered();
        emit runningChanged();
    }
}

QT_END_NAMESPACE