1 /****************************************************************************
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
6 ** This file is part of the QtQml module of the Qt Toolkit.
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** GNU Lesser General Public License Usage
10 ** This file may be used under the terms of the GNU Lesser General Public
11 ** License version 2.1 as published by the Free Software Foundation and
12 ** appearing in the file LICENSE.LGPL included in the packaging of this
13 ** file. Please review the following information to ensure the GNU Lesser
14 ** General Public License version 2.1 requirements will be met:
15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
17 ** In addition, as a special exception, Nokia gives you certain additional
18 ** rights. These rights are described in the Nokia Qt LGPL Exception
19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
21 ** GNU General Public License Usage
22 ** Alternatively, this file may be used under the terms of the GNU General
23 ** Public License version 3.0 as published by the Free Software Foundation
24 ** and appearing in the file LICENSE.GPL included in the packaging of this
25 ** file. Please review the following information to ensure the GNU General
26 ** Public License version 3.0 requirements will be met:
27 ** http://www.gnu.org/copyleft/gpl.html.
30 ** Alternatively, this file may be used in accordance with the terms and
31 ** conditions contained in a signed written agreement between you and Nokia.
40 ****************************************************************************/
42 #ifndef QQUICKTIMELINE_H
43 #define QQUICKTIMELINE_H
49 // This file is not part of the Qt API. It exists purely as an
50 // implementation detail. This header file may change from version to
51 // version without notice, or even be removed.
56 #include <QtCore/QObject>
57 #include "private/qabstractanimationjob_p.h"
62 class QQuickTimeLineValue;
63 class QQuickTimeLineCallback;
64 struct QQuickTimeLinePrivate;
65 class QQuickTimeLineObject;
66 class Q_AUTOTEST_EXPORT QQuickTimeLine : public QObject, QAbstractAnimationJob
70 QQuickTimeLine(QObject *parent = 0);
73 enum SyncMode { LocalSync, GlobalSync };
74 SyncMode syncMode() const;
75 void setSyncMode(SyncMode);
77 void pause(QQuickTimeLineObject &, int);
78 void callback(const QQuickTimeLineCallback &);
79 void set(QQuickTimeLineValue &, qreal);
81 int accel(QQuickTimeLineValue &, qreal velocity, qreal accel);
82 int accel(QQuickTimeLineValue &, qreal velocity, qreal accel, qreal maxDistance);
83 int accelDistance(QQuickTimeLineValue &, qreal velocity, qreal distance);
85 void move(QQuickTimeLineValue &, qreal destination, int time = 500);
86 void move(QQuickTimeLineValue &, qreal destination, const QEasingCurve &, int time = 500);
87 void moveBy(QQuickTimeLineValue &, qreal change, int time = 500);
88 void moveBy(QQuickTimeLineValue &, qreal change, const QEasingCurve &, int time = 500);
91 void setSyncPoint(int);
92 int syncPoint() const;
94 void sync(QQuickTimeLineValue &);
95 void sync(QQuickTimeLineValue &, QQuickTimeLineValue &);
97 void reset(QQuickTimeLineValue &);
101 bool isActive() const;
105 virtual int duration() const;
111 virtual void updateCurrentTime(int);
114 void remove(QQuickTimeLineObject *);
115 friend class QQuickTimeLineObject;
116 friend struct QQuickTimeLinePrivate;
117 QQuickTimeLinePrivate *d;
120 class Q_AUTOTEST_EXPORT QQuickTimeLineObject
123 QQuickTimeLineObject();
124 virtual ~QQuickTimeLineObject();
127 friend class QQuickTimeLine;
128 friend struct QQuickTimeLinePrivate;
132 class Q_AUTOTEST_EXPORT QQuickTimeLineValue : public QQuickTimeLineObject
135 QQuickTimeLineValue(qreal v = 0.) : _v(v) {}
137 virtual qreal value() const { return _v; }
138 virtual void setValue(qreal v) { _v = v; }
140 QQuickTimeLine *timeLine() const { return _t; }
142 operator qreal() const { return _v; }
143 QQuickTimeLineValue &operator=(qreal v) { setValue(v); return *this; }
145 friend class QQuickTimeLine;
146 friend struct QQuickTimeLinePrivate;
150 class Q_AUTOTEST_EXPORT QQuickTimeLineCallback
153 typedef void (*Callback)(void *);
155 QQuickTimeLineCallback();
156 QQuickTimeLineCallback(QQuickTimeLineObject *b, Callback, void * = 0);
157 QQuickTimeLineCallback(const QQuickTimeLineCallback &o);
159 QQuickTimeLineCallback &operator=(const QQuickTimeLineCallback &o);
160 QQuickTimeLineObject *callbackObject() const;
163 friend struct QQuickTimeLinePrivate;
166 QQuickTimeLineObject *d2;
170 class QQuickTimeLineValueProxy : public QQuickTimeLineValue
173 QQuickTimeLineValueProxy(T *cls, void (T::*func)(qreal), qreal v = 0.)
174 : QQuickTimeLineValue(v), _class(cls), _setFunctionReal(func), _setFunctionInt(0)
179 QQuickTimeLineValueProxy(T *cls, void (T::*func)(int), qreal v = 0.)
180 : QQuickTimeLineValue(v), _class(cls), _setFunctionReal(0), _setFunctionInt(func)
185 virtual void setValue(qreal v)
187 QQuickTimeLineValue::setValue(v);
188 if (_setFunctionReal) (_class->*_setFunctionReal)(v);
189 else if (_setFunctionInt) (_class->*_setFunctionInt)((int)v);
194 void (T::*_setFunctionReal)(qreal);
195 void (T::*_setFunctionInt)(int);