path: root/src/declarative/util/qmlanimation.h

/****************************************************************************
**
** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
** Contact: Qt Software Information (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 either Technology Preview License Agreement or the
** Beta Release License Agreement.
**
** 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.0, included in the file LGPL_EXCEPTION.txt in this
** package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at qt-sales@nokia.com.
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QMLANIMATION_H
#define QMLANIMATION_H

#include <QtCore/qvariant.h>
#include <QtCore/QAbstractAnimation>
#include <QtGui/qcolor.h>
#include <QtDeclarative/qmltransition.h>
#include <QtDeclarative/qmlpropertyvaluesource.h>
#include <QtDeclarative/qmlstate.h>
#include <QtDeclarative/qml.h>

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

QT_MODULE(Declarative)

class QmlAbstractAnimationPrivate;
class QmlAnimationGroup;
class QmlAbstractAnimation : public QmlPropertyValueSource, public QmlParserStatus
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(QmlAbstractAnimation)

    Q_INTERFACES(QmlParserStatus);
    Q_PROPERTY(bool running READ isRunning WRITE setRunning NOTIFY runningChanged);
    Q_PROPERTY(bool finishPlaying READ finishPlaying WRITE setFinishPlaying NOTIFY finishPlayingChanged());
    Q_PROPERTY(bool repeat READ repeat WRITE setRepeat NOTIFY repeatChanged);
    Q_PROPERTY(QObject *target READ target WRITE setTarget NOTIFY targetChanged);
    Q_PROPERTY(QString property READ property WRITE setProperty NOTIFY targetChanged);
    Q_CLASSINFO("DefaultMethod", "start()");
    Q_INTERFACES(QmlParserStatus)

public:
    QmlAbstractAnimation(QObject *parent=0);
    virtual ~QmlAbstractAnimation();

    bool isRunning() const;
    void setRunning(bool);
    bool finishPlaying() const;
    void setFinishPlaying(bool);
    bool repeat() const;
    void setRepeat(bool);

    QmlAnimationGroup *group() const;
    void setGroup(QmlAnimationGroup *);

    QObject *target() const;
    void setTarget(QObject *);
    QString property() const;
    void setProperty(const QString &);

    void classBegin();
    void componentComplete();

Q_SIGNALS:
    void started();
    void completed();
    void runningChanged(bool);
    void repeatChanged(bool);
    void targetChanged(QObject *, const QString &);
    void finishPlayingChanged(bool);

public Q_SLOTS:
    void restart();
    void start();
    void stop();
    void complete();

protected:
    virtual void setTarget(const QmlMetaProperty &);
    QmlAbstractAnimation(QmlAbstractAnimationPrivate &dd, QObject *parent);

public:
    enum TransitionDirection { Forward, Backward };
    virtual void transition(QmlStateActions &actions,
                            QmlMetaProperties &modified,
                            TransitionDirection direction);
    virtual void prepare(QmlMetaProperty &);
    virtual QAbstractAnimation *qtAnimation() = 0;

private Q_SLOTS:
    void timelineComplete();
};

QML_DECLARE_TYPE(QmlAbstractAnimation)

class QmlPauseAnimationPrivate;
class QmlPauseAnimation : public QmlAbstractAnimation
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(QmlPauseAnimation);

    Q_PROPERTY(int duration READ duration WRITE setDuration NOTIFY durationChanged);

public:
    QmlPauseAnimation(QObject *parent=0);
    virtual ~QmlPauseAnimation();

    int duration() const;
    void setDuration(int);

Q_SIGNALS:
    void durationChanged(int);

protected:
    virtual QAbstractAnimation *qtAnimation();
    virtual void prepare(QmlMetaProperty &);
};
QML_DECLARE_TYPE(QmlPauseAnimation)

class QmlColorAnimationPrivate;
class QmlColorAnimation : public QmlAbstractAnimation
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(QmlColorAnimation);
    Q_PROPERTY(int duration READ duration WRITE setDuration NOTIFY durationChanged);
    Q_PROPERTY(QColor from READ from WRITE setFrom NOTIFY fromChanged);
    Q_PROPERTY(QColor to READ to WRITE setTo NOTIFY toChanged);
    Q_PROPERTY(QString easing READ easing WRITE setEasing NOTIFY easingChanged);
    Q_PROPERTY(QList<QObject *>* filter READ filter);
    Q_PROPERTY(QList<QObject *>* exclude READ exclude);

public:
    QmlColorAnimation(QObject *parent=0);
    virtual ~QmlColorAnimation();

    int duration() const;
    void setDuration(int);

    QColor from() const;
    void setFrom(const QColor &);

    QColor to() const;
    void setTo(const QColor &);

    QString easing() const;
    void setEasing(const QString &);

    QList<QObject *> *filter();

    QList<QObject *> *exclude();

protected:
    virtual void transition(QmlStateActions &actions,
                            QmlMetaProperties &modified,
                            TransitionDirection direction);
    virtual QAbstractAnimation *qtAnimation();
    virtual void prepare(QmlMetaProperty &);

Q_SIGNALS:
    void durationChanged(int);
    void fromChanged(const QColor &);
    void toChanged(const QColor &);
    void easingChanged(const QString &);
};
QML_DECLARE_TYPE(QmlColorAnimation)

class QmlRunScriptActionPrivate;
class QmlRunScriptAction : public QmlAbstractAnimation
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(QmlRunScriptAction);

    Q_PROPERTY(QString script READ script WRITE setScript NOTIFY scriptChanged);
    Q_PROPERTY(QString file READ file WRITE setFile NOTIFY fileChanged);

public:
    QmlRunScriptAction(QObject *parent=0);
    virtual ~QmlRunScriptAction();

    QString script() const;
    void setScript(const QString &);

    QString file() const;
    void setFile(const QString &);

Q_SIGNALS:
    void fileChanged(const QString &);
    void scriptChanged(const QString &);

protected:
    virtual QAbstractAnimation *qtAnimation();
};
QML_DECLARE_TYPE(QmlRunScriptAction)

class QmlSetPropertyActionPrivate;
class QmlSetPropertyAction : public QmlAbstractAnimation
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(QmlSetPropertyAction);

    Q_PROPERTY(QString properties READ properties WRITE setProperties NOTIFY propertiesChanged);
    Q_PROPERTY(QList<QObject *>* filter READ filter);
    Q_PROPERTY(QList<QObject *>* exclude READ exclude);
    Q_PROPERTY(QVariant value READ value WRITE setValue NOTIFY valueChanged);

public:
    QmlSetPropertyAction(QObject *parent=0);
    virtual ~QmlSetPropertyAction();

    QString properties() const;
    void setProperties(const QString &);

    QList<QObject *> *filter();
    QList<QObject *> *exclude();

    QVariant value() const;
    void setValue(const QVariant &);

Q_SIGNALS:
    void valueChanged(const QVariant &);
    void propertiesChanged(const QString &);

protected:
    virtual void transition(QmlStateActions &actions,
                            QmlMetaProperties &modified,
                            TransitionDirection direction);
    virtual QAbstractAnimation *qtAnimation();
    virtual void prepare(QmlMetaProperty &);
};
QML_DECLARE_TYPE(QmlSetPropertyAction)

class QmlParentChangeActionPrivate;
class QmlParentChangeAction : public QmlAbstractAnimation
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(QmlParentChangeAction);

    //XXX should have parent property as well for when it isn't part of a transition

public:
    QmlParentChangeAction(QObject *parent=0);
    virtual ~QmlParentChangeAction();

protected:
    virtual void transition(QmlStateActions &actions,
                            QmlMetaProperties &modified,
                            TransitionDirection direction);
    virtual QAbstractAnimation *qtAnimation();
    virtual void prepare(QmlMetaProperty &);
};
QML_DECLARE_TYPE(QmlParentChangeAction)

class QmlNumericAnimationPrivate;
class QmlNumericAnimation : public QmlAbstractAnimation
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(QmlNumericAnimation);

    Q_PROPERTY(int duration READ duration WRITE setDuration NOTIFY durationChanged);
    Q_PROPERTY(qreal from READ from WRITE setFrom NOTIFY fromChanged);
    Q_PROPERTY(qreal to READ to WRITE setTo NOTIFY toChanged);
    Q_PROPERTY(QString easing READ easing WRITE setEasing NOTIFY easingChanged);
    Q_PROPERTY(QString properties READ properties WRITE setProperties NOTIFY propertiesChanged);
    Q_PROPERTY(QList<QObject *>* filter READ filter);
    Q_PROPERTY(QList<QObject *>* exclude READ exclude);

public:
    QmlNumericAnimation(QObject *parent=0);
    virtual ~QmlNumericAnimation();

    int duration() const;
    void setDuration(int);

    qreal from() const;
    void setFrom(qreal);

    qreal to() const;
    void setTo(qreal);

    QString easing() const;
    void setEasing(const QString &);

    QString properties() const;
    void setProperties(const QString &);

    QList<QObject *> *filter();
    QList<QObject *> *exclude();

protected:
    virtual void transition(QmlStateActions &actions,
                            QmlMetaProperties &modified,
                            TransitionDirection direction);
    virtual QAbstractAnimation *qtAnimation();
    virtual void prepare(QmlMetaProperty &);

Q_SIGNALS:
    void durationChanged(int);
    void fromChanged(qreal);
    void toChanged(qreal);
    void easingChanged(const QString &);
    void propertiesChanged(const QString &);
};
QML_DECLARE_TYPE(QmlNumericAnimation)

#if 0
class QmlDiscreteAnimation : public QmlAbstractAnimation
{
Q_OBJECT
};
#endif

class QmlAnimationGroupPrivate;
class QmlAnimationGroup : public QmlAbstractAnimation
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(QmlAnimationGroup);

    Q_CLASSINFO("DefaultProperty", "animations");
    Q_PROPERTY(QmlList<QmlAbstractAnimation *> *animations READ animations);

public:
    QmlAnimationGroup(QObject *parent);
    virtual ~QmlAnimationGroup();

    QmlList<QmlAbstractAnimation *>* animations();
};

class QmlSequentialAnimation : public QmlAnimationGroup
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(QmlAnimationGroup);

public:
    QmlSequentialAnimation(QObject *parent=0);
    virtual ~QmlSequentialAnimation();

protected:
    virtual void transition(QmlStateActions &actions,
                            QmlMetaProperties &modified,
                            TransitionDirection direction);
    virtual QAbstractAnimation *qtAnimation();
    virtual void prepare(QmlMetaProperty &);
};
QML_DECLARE_TYPE(QmlSequentialAnimation)

class QmlParallelAnimation : public QmlAnimationGroup
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(QmlAnimationGroup);

public:
    QmlParallelAnimation(QObject *parent=0);
    virtual ~QmlParallelAnimation();

protected:
    virtual void transition(QmlStateActions &actions,
                            QmlMetaProperties &modified,
                            TransitionDirection direction);
    virtual QAbstractAnimation *qtAnimation();
    virtual void prepare(QmlMetaProperty &);
};
QML_DECLARE_TYPE(QmlParallelAnimation)

class QmlVariantAnimationPrivate;
class QmlVariantAnimation : public QmlAbstractAnimation
{
    Q_OBJECT
    Q_DECLARE_PRIVATE(QmlVariantAnimation);

    Q_PROPERTY(int duration READ duration WRITE setDuration NOTIFY durationChanged);
    Q_PROPERTY(QVariant from READ from WRITE setFrom NOTIFY fromChanged);
    Q_PROPERTY(QVariant to READ to WRITE setTo NOTIFY toChanged);
    Q_PROPERTY(QString easing READ easing WRITE setEasing NOTIFY easingChanged);
    Q_PROPERTY(QString properties READ properties WRITE setProperties NOTIFY propertiesChanged);
    Q_PROPERTY(QList<QObject *>* filter READ filter);
    Q_PROPERTY(QList<QObject *>* exclude READ exclude);

public:
    QmlVariantAnimation(QObject *parent=0);
    virtual ~QmlVariantAnimation();

    int duration() const;
    void setDuration(int);

    QVariant from() const;
    void setFrom(const QVariant &);

    QVariant to() const;
    void setTo(const QVariant &);

    QString easing() const;
    void setEasing(const QString &);

    QString properties() const;
    void setProperties(const QString &);

    QList<QObject *> *filter();
    QList<QObject *> *exclude();

protected:
    virtual void transition(QmlStateActions &actions,
                            QmlMetaProperties &modified,
                            TransitionDirection direction);
    virtual QAbstractAnimation *qtAnimation();
    virtual void prepare(QmlMetaProperty &);

Q_SIGNALS:
    void durationChanged(int);
    void fromChanged(QVariant);
    void toChanged(QVariant);
    void easingChanged(const QString &);
    void propertiesChanged(const QString &);
};
QML_DECLARE_TYPE(QmlVariantAnimation)

#endif // QMLANIMATION_H

QT_END_NAMESPACE

QT_END_HEADER