/****************************************************************************

**

** Copyright (C) 2010 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 "private/qdeclarativetimer_p.h"

#include <QtCore/qcoreapplication.h>

#include <QtCore/qpauseanimation.h>

#include <qdebug.h>

#include <private/qobject_p.h>

QT_BEGIN_NAMESPACE

class QDeclarativeTimerPrivate : public QObjectPrivate

{

    Q_DECLARE_PUBLIC(QDeclarativeTimer)

public:

    QDeclarativeTimerPrivate()

        : interval(1000), running(false), repeating(false), triggeredOnStart(false)

        , classBegun(false), componentComplete(false), firstTick(true) {}

    int interval;

    QPauseAnimation pause;

    bool running : 1;

    bool repeating : 1;

    bool triggeredOnStart : 1;

    bool classBegun : 1;

    bool componentComplete : 1;

    bool firstTick : 1;

};

/*!

    \qmlclass Timer QDeclarativeTimer

    \since 4.7

    \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.

    Here is a timer that shows the current date and time, and updates

    the text every 500 milliseconds:

    \qml

    Timer {

        interval: 500; running: true; repeat: true

        onTriggered: time.text = Date().toString()

    }

    Text {

        id: time

    }

    \endqml

    QDeclarativeTimer is synchronized with the animation timer.  Since the animation

    timer is usually set to 60fps, the resolution of QDeclarativeTimer will be

    at best 16ms.

    If the Timer is running and one of its properties is changed, the

    elapsed time will be reset.  For example, if a Timer with interval of

    1000ms has its \e repeat property changed 500ms after starting, the

    elapsed time will be reset to 0, and the Timer will be triggered

    1000ms later.

    \sa {QtDeclarative}

*/

QDeclarativeTimer::QDeclarativeTimer(QObject *parent)

    : QObject(*(new QDeclarativeTimerPrivate), parent)

{

    Q_D(QDeclarativeTimer);

    connect(&d->pause, SIGNAL(currentLoopChanged(int)), this, SLOT(ticked()));

    connect(&d->pause, SIGNAL(finished()), this, SLOT(finished()));

    d->pause.setLoopCount(1);

    d->pause.setDuration(d->interval);

}

/*!

    \qmlproperty int Timer::interval

    Sets the \a interval between triggers, in milliseconds.

    The default interval is 1000 milliseconds.

*/

void QDeclarativeTimer::setInterval(int interval)

{

    Q_D(QDeclarativeTimer);

    if (interval != d->interval) {

        d->interval = interval;

        update();

        emit intervalChanged();

    }

}

int QDeclarativeTimer::interval() const

{

    Q_D(const QDeclarativeTimer);

    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 is set to false after the

    timer has been triggered.

    \a running defaults to false.

    \sa repeat

*/

bool QDeclarativeTimer::isRunning() const

{

    Q_D(const QDeclarativeTimer);

    return d->running;

}

void QDeclarativeTimer::setRunning(bool running)

{

    Q_D(QDeclarativeTimer);

    if (d->running != running) {

        d->running = running;

        d->firstTick = true;

        emit runningChanged();

        update();

    }

}

/*!

    \qmlproperty bool Timer::repeat

    If \a repeat is true the timer is 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 QDeclarativeTimer::isRepeating() const

{

    Q_D(const QDeclarativeTimer);

    return d->repeating;

}

void QDeclarativeTimer::setRepeating(bool repeating)

{

    Q_D(QDeclarativeTimer);

    if (repeating != d->repeating) {

        d->repeating = repeating;

        update();

        emit repeatChanged();

    }

}

/*!

    \qmlproperty bool Timer::triggeredOnStart

    When a timer is started, the first trigger is usually after the specified

    interval has elapsed.  It is sometimes desirable to trigger immediately

    when the timer is started; for example, to establish an initial

    state.

    If \a triggeredOnStart is true, the timer is triggered immediately

    when started, and subsequently at the specified interval. Note that if

    \e repeat is set to false, the timer is triggered twice; once on start,

    and again at the interval.

    \a triggeredOnStart defaults to false.

    \sa running

*/

bool QDeclarativeTimer::triggeredOnStart() const

{

    Q_D(const QDeclarativeTimer);

    return d->triggeredOnStart;

}

void QDeclarativeTimer::setTriggeredOnStart(bool triggeredOnStart)

{

    Q_D(QDeclarativeTimer);

    if (d->triggeredOnStart != triggeredOnStart) {

        d->triggeredOnStart = triggeredOnStart;

        update();

        emit triggeredOnStartChanged();

    }

}

/*!

    \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 QDeclarativeTimer::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 QDeclarativeTimer::stop()

{

    setRunning(false);

}

/*!

    \qmlmethod Timer::restart()

    \brief Restarts the timer.

    If the Timer is not running it will be started, otherwise it will be

    stopped, reset to initial state and started.  The \c running property

    will be true following a call to \c restart().

*/

void QDeclarativeTimer::restart()

{

    setRunning(false);

    setRunning(true);

}

void QDeclarativeTimer::update()

{

    Q_D(QDeclarativeTimer);

    if (d->classBegun && !d->componentComplete)

        return;

    d->pause.stop();

    if (d->running) {

        d->pause.setCurrentTime(0);

        d->pause.setLoopCount(d->repeating ? -1 : 1);

        d->pause.setDuration(d->interval);

        d->pause.start();

        if (d->triggeredOnStart && d->firstTick) {

            QCoreApplication::removePostedEvents(this, QEvent::MetaCall);

            QMetaObject::invokeMethod(this, "ticked", Qt::QueuedConnection);

        }

    }

}

void QDeclarativeTimer::classBegin()

{

    Q_D(QDeclarativeTimer);

    d->classBegun = true;

}

void QDeclarativeTimer::componentComplete()

{

    Q_D(QDeclarativeTimer);

    d->componentComplete = true;

    update();

}

/*!

    \qmlsignal Timer::onTriggered()

    This handler is called when the Timer is triggered.

*/

void QDeclarativeTimer::ticked()

{

    Q_D(QDeclarativeTimer);

    if (d->running && (d->pause.currentTime() > 0 || (d->triggeredOnStart && d->firstTick)))

        emit triggered();

    d->firstTick = false;

}

void QDeclarativeTimer::finished()

{

    Q_D(QDeclarativeTimer);

    if (d->repeating || !d->running)

        return;

    emit triggered();

    d->running = false;

    d->firstTick = false;

    emit runningChanged();

}

QT_END_NAMESPACE