1/****************************************************************************
2**
3** Copyright (C) 2020 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtCore 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 QTIMELINE_H
41#define QTIMELINE_H
42
43#include <QtCore/qglobal.h>
44
45QT_REQUIRE_CONFIG(easingcurve);
46
47#include <QtCore/qeasingcurve.h>
48#include <QtCore/qobject.h>
49
50QT_BEGIN_NAMESPACE
51
52
53class QTimeLinePrivate;
54class Q_CORE_EXPORT QTimeLine : public QObject
55{
56 Q_OBJECT
57 Q_PROPERTY(int duration READ duration WRITE setDuration)
58 Q_PROPERTY(int updateInterval READ updateInterval WRITE setUpdateInterval)
59 Q_PROPERTY(int currentTime READ currentTime WRITE setCurrentTime)
60 Q_PROPERTY(Direction direction READ direction WRITE setDirection)
61 Q_PROPERTY(int loopCount READ loopCount WRITE setLoopCount)
62 Q_PROPERTY(QEasingCurve easingCurve READ easingCurve WRITE setEasingCurve)
63public:
64 enum State {
65 NotRunning,
66 Paused,
67 Running
68 };
69 enum Direction {
70 Forward,
71 Backward
72 };
73
74 explicit QTimeLine(int duration = 1000, QObject *parent = nullptr);
75 virtual ~QTimeLine();
76
77 State state() const;
78
79 int loopCount() const;
80 void setLoopCount(int count);
81
82 Direction direction() const;
83 void setDirection(Direction direction);
84
85 int duration() const;
86 void setDuration(int duration);
87
88 int startFrame() const;
89 void setStartFrame(int frame);
90 int endFrame() const;
91 void setEndFrame(int frame);
92 void setFrameRange(int startFrame, int endFrame);
93
94 int updateInterval() const;
95 void setUpdateInterval(int interval);
96
97 QEasingCurve easingCurve() const;
98 void setEasingCurve(const QEasingCurve &curve);
99
100 int currentTime() const;
101 int currentFrame() const;
102 qreal currentValue() const;
103
104 int frameForTime(int msec) const;
105 virtual qreal valueForTime(int msec) const;
106
107public Q_SLOTS:
108 void start();
109 void resume();
110 void stop();
111 void setPaused(bool paused);
112 void setCurrentTime(int msec);
113 void toggleDirection();
114
115Q_SIGNALS:
116 void valueChanged(qreal x, QPrivateSignal);
117 void frameChanged(int, QPrivateSignal);
118 void stateChanged(QTimeLine::State newState, QPrivateSignal);
119 void finished(QPrivateSignal);
120
121protected:
122 void timerEvent(QTimerEvent *event) override;
123
124private:
125 Q_DISABLE_COPY(QTimeLine)
126 Q_DECLARE_PRIVATE(QTimeLine)
127};
128
129QT_END_NAMESPACE
130
131#endif
132
133