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 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 QABSTRACTTRANSITION_H
41#define QABSTRACTTRANSITION_H
42
43#include <QtCore/qobject.h>
44
45#include <QtCore/qlist.h>
46
47QT_REQUIRE_CONFIG(statemachine);
48
49QT_BEGIN_NAMESPACE
50
51class QEvent;
52class QAbstractState;
53class QState;
54class QStateMachine;
55
56#if QT_CONFIG(animation)
57class QAbstractAnimation;
58#endif
59
60class QAbstractTransitionPrivate;
61class Q_CORE_EXPORT QAbstractTransition : public QObject
62{
63 Q_OBJECT
64 Q_PROPERTY(QState* sourceState READ sourceState)
65 Q_PROPERTY(QAbstractState* targetState READ targetState WRITE setTargetState NOTIFY targetStateChanged)
66 Q_PROPERTY(QList<QAbstractState*> targetStates READ targetStates WRITE setTargetStates NOTIFY targetStatesChanged)
67 Q_PROPERTY(TransitionType transitionType READ transitionType WRITE setTransitionType REVISION 1)
68public:
69 enum TransitionType {
70 ExternalTransition,
71 InternalTransition
72 };
73 Q_ENUM(TransitionType)
74
75 QAbstractTransition(QState *sourceState = nullptr);
76 virtual ~QAbstractTransition();
77
78 QState *sourceState() const;
79 QAbstractState *targetState() const;
80 void setTargetState(QAbstractState* target);
81 QList<QAbstractState*> targetStates() const;
82 void setTargetStates(const QList<QAbstractState*> &targets);
83
84 TransitionType transitionType() const;
85 void setTransitionType(TransitionType type);
86
87 QStateMachine *machine() const;
88
89#if QT_CONFIG(animation)
90 void addAnimation(QAbstractAnimation *animation);
91 void removeAnimation(QAbstractAnimation *animation);
92 QList<QAbstractAnimation*> animations() const;
93#endif
94
95Q_SIGNALS:
96 void triggered(QPrivateSignal);
97 void targetStateChanged(QPrivateSignal);
98 void targetStatesChanged(QPrivateSignal);
99
100protected:
101 virtual bool eventTest(QEvent *event) = 0;
102
103 virtual void onTransition(QEvent *event) = 0;
104
105 bool event(QEvent *e) override;
106
107protected:
108 QAbstractTransition(QAbstractTransitionPrivate &dd, QState *parent);
109
110private:
111 Q_DISABLE_COPY(QAbstractTransition)
112 Q_DECLARE_PRIVATE(QAbstractTransition)
113};
114
115QT_END_NAMESPACE
116
117#endif
118