1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtQuick 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 QQUICKTRANSITION_H
41#define QQUICKTRANSITION_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists purely as an
48// implementation detail. This header file may change from version to
49// version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include "qquickstate_p.h"
55#include <private/qabstractanimationjob_p.h>
56#include <private/qqmlguard_p.h>
57#include <qqml.h>
58
59#include <QtCore/qobject.h>
60
61QT_BEGIN_NAMESPACE
62
63class QQuickAbstractAnimation;
64class QQuickTransitionPrivate;
65class QQuickTransitionManager;
66class QQuickTransition;
67
68class QQuickTransitionInstance : QAnimationJobChangeListener
69{
70public:
71 QQuickTransitionInstance(QQuickTransition *transition, QAbstractAnimationJob *anim);
72 ~QQuickTransitionInstance();
73
74 void start();
75 void stop();
76
77 bool isRunning() const;
78
79protected:
80 void animationStateChanged(QAbstractAnimationJob *, QAbstractAnimationJob::State, QAbstractAnimationJob::State) override;
81
82 void removeStateChangeListener()
83 {
84 m_anim->removeAnimationChangeListener(this, QAbstractAnimationJob::StateChange);
85 }
86
87private:
88 QQmlGuard<QQuickTransition> m_transition;
89 QAbstractAnimationJob *m_anim;
90 friend class QQuickTransition;
91};
92
93class Q_QUICK_PRIVATE_EXPORT QQuickTransition : public QObject
94{
95 Q_OBJECT
96 Q_DECLARE_PRIVATE(QQuickTransition)
97
98 Q_PROPERTY(QString from READ fromState WRITE setFromState NOTIFY fromChanged)
99 Q_PROPERTY(QString to READ toState WRITE setToState NOTIFY toChanged)
100 Q_PROPERTY(bool reversible READ reversible WRITE setReversible NOTIFY reversibleChanged)
101 Q_PROPERTY(bool running READ running NOTIFY runningChanged)
102 Q_PROPERTY(QQmlListProperty<QQuickAbstractAnimation> animations READ animations)
103 Q_PROPERTY(bool enabled READ enabled WRITE setEnabled NOTIFY enabledChanged)
104 Q_CLASSINFO("DefaultProperty", "animations")
105 Q_CLASSINFO("DeferredPropertyNames", "animations")
106
107public:
108 QQuickTransition(QObject *parent=nullptr);
109 ~QQuickTransition();
110
111 QString fromState() const;
112 void setFromState(const QString &);
113
114 QString toState() const;
115 void setToState(const QString &);
116
117 bool reversible() const;
118 void setReversible(bool);
119
120 bool enabled() const;
121 void setEnabled(bool enabled);
122
123 bool running() const;
124
125 QQmlListProperty<QQuickAbstractAnimation> animations();
126
127 QQuickTransitionInstance *prepare(QQuickStateOperation::ActionList &actions,
128 QList<QQmlProperty> &after,
129 QQuickTransitionManager *end,
130 QObject *defaultTarget);
131
132 void setReversed(bool r);
133
134Q_SIGNALS:
135 void fromChanged();
136 void toChanged();
137 void reversibleChanged();
138 void enabledChanged();
139 void runningChanged();
140};
141
142QT_END_NAMESPACE
143
144QML_DECLARE_TYPE(QQuickTransition)
145
146#endif // QQUICKTRANSITION_H
147