Qt 4.8
qtimeline.h
Go to the documentation of this file.
1 /****************************************************************************
2 **
3 ** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
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 Digia. For licensing terms and
14 ** conditions see http://qt.digia.com/licensing. For further information
15 ** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24 **
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights. These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28 **
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file. Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
36 **
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41 
42 #ifndef QTIMELINE_H
43 #define QTIMELINE_H
44 
45 #include <QtCore/qeasingcurve.h>
46 #include <QtCore/qobject.h>
47 
48 QT_BEGIN_HEADER
49 
50 QT_BEGIN_NAMESPACE
51 
52 QT_MODULE(Core)
53 
54 class QTimeLinePrivate;
55 class Q_CORE_EXPORT QTimeLine : public QObject
56 {
57  Q_OBJECT
58  int duration;
59  int updateInterval;
60  int currentTime;
61  Direction direction;
62  int loopCount;
63  CurveShape curveShape;
64  QEasingCurve easingCurve;
65 public:
66  enum State {
67  NotRunning,
68  Paused,
69  Running
70  };
71  enum Direction {
72  Forward,
73  Backward
74  };
75  enum CurveShape {
76  EaseInCurve,
77  EaseOutCurve,
78  EaseInOutCurve,
79  LinearCurve,
80  SineCurve,
81  CosineCurve
82  };
83 
84  explicit QTimeLine(int duration = 1000, QObject *parent = 0);
85  virtual ~QTimeLine();
86 
87  State state() const;
88 
89  int loopCount() const;
90  void setLoopCount(int count);
91 
92  Direction direction() const;
93  void setDirection(Direction direction);
94 
95  int duration() const;
96  void setDuration(int duration);
97 
98  int startFrame() const;
99  void setStartFrame(int frame);
100  int endFrame() const;
101  void setEndFrame(int frame);
102  void setFrameRange(int startFrame, int endFrame);
103 
104  int updateInterval() const;
105  void setUpdateInterval(int interval);
106 
107  CurveShape curveShape() const;
108  void setCurveShape(CurveShape shape);
109 
110  QEasingCurve easingCurve() const;
111  void setEasingCurve(const QEasingCurve &curve);
112 
113  int currentTime() const;
114  int currentFrame() const;
115  qreal currentValue() const;
116 
117  int frameForTime(int msec) const;
118  virtual qreal valueForTime(int msec) const;
119 
120 public Q_SLOTS:
121  void start();
122  void resume();
123  void stop();
124  void setPaused(bool paused);
125  void setCurrentTime(int msec);
126  void toggleDirection();
127 
128 Q_SIGNALS:
129  void valueChanged(qreal x);
130  void frameChanged(int);
131  void stateChanged(QTimeLine::State newState);
132  void finished();
133 
134 protected:
135  void timerEvent(QTimerEvent *event);
136 
137 private:
138  Q_DISABLE_COPY(QTimeLine)
139  Q_DECLARE_PRIVATE(QTimeLine)
140 };
141 
142 QT_END_NAMESPACE
143 
144 QT_END_HEADER
145 
146 #endif
147 
QTimeLine::currentTime
int currentTime
the current time of the time line.
Definition: qtimeline.h:60
QTimeLine::direction
Direction direction
the direction of the timeline when QTimeLine is in Running state.
Definition: qtimeline.h:61
qreal
double qreal
Definition: qglobal.h:1193
QT_END_NAMESPACE
#define QT_END_NAMESPACE
This macro expands to.
Definition: qglobal.h:90
event
EventRef event
Definition: qapplication_mac.mm:880
QTimeLine::easingCurve
QEasingCurve easingCurve
Specifies the easing curve that the timeline will use.
Definition: qtimeline.h:64
QT_MODULE
#define QT_MODULE(x)
Definition: qglobal.h:2783
QEasingCurve
The QEasingCurve class provides easing curves for controlling animation.
Definition: qeasingcurve.h:55
QT_BEGIN_HEADER
#define QT_BEGIN_HEADER
Definition: qglobal.h:136
QTimeLine::CurveShape
CurveShape
This enum describes the default shape of QTimeLine&#39;s value curve.
Definition: qtimeline.h:75
QObject::timerEvent
virtual void timerEvent(QTimerEvent *)
This event handler can be reimplemented in a subclass to receive timer events for the object...
Definition: qobject.cpp:1294
QTimeLine::curveShape
CurveShape curveShape
the shape of the timeline curve.
Definition: qtimeline.h:63
Q_DISABLE_COPY
#define Q_DISABLE_COPY(Class)
Disables the use of copy constructors and assignment operators for the given Class.
Definition: qglobal.h:2523
QTimeLine::State
State
This enum describes the state of the timeline.
Definition: qtimeline.h:66
Q_SLOTS
#define Q_SLOTS
Definition: qobjectdefs.h:71
QObject
The QObject class is the base class of all Qt objects.
Definition: qobject.h:111
Q_SIGNALS
#define Q_SIGNALS
Definition: qobjectdefs.h:72
QTimeLine::duration
int duration
the total duration of the timeline in milliseconds.
Definition: qtimeline.h:58
QTimeLine
The QTimeLine class provides a timeline for controlling animations.
Definition: qtimeline.h:55
QT_BEGIN_NAMESPACE
#define QT_BEGIN_NAMESPACE
This macro expands to.
Definition: qglobal.h:89
QTimeLine::Direction
Direction
This enum describes the direction of the timeline when in Running state.
Definition: qtimeline.h:71
State
The State element defines configurations of objects and properties.
Q_OBJECT
#define Q_OBJECT
Definition: qobjectdefs.h:157
Q_CORE_EXPORT
#define Q_CORE_EXPORT
Definition: qglobal.h:1449
QTimerEvent
The QTimerEvent class contains parameters that describe a timer event.
Definition: qcoreevent.h:341
QTimeLine::updateInterval
int updateInterval
the time in milliseconds between each time QTimeLine updates its current time.
Definition: qtimeline.h:59
Q_DECLARE_PRIVATE
#define Q_DECLARE_PRIVATE(Class)
Definition: qglobal.h:2467
QTimeLine::loopCount
int loopCount
the number of times the timeline should loop before it&#39;s finished.
Definition: qtimeline.h:62
QT_END_HEADER
#define QT_END_HEADER
Definition: qglobal.h:137
direction
Qt::LayoutDirection direction
Definition: qkeymapper_x11_p.cpp:48
Qt 4.8 Source Code Browser