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 QSTATE_H
41#define QSTATE_H
42
43#include <QtCore/qabstractstate.h>
44#include <QtCore/qlist.h>
45#include <QtCore/qmetaobject.h>
46
47QT_REQUIRE_CONFIG(statemachine);
48
49QT_BEGIN_NAMESPACE
50
51class QAbstractTransition;
52class QSignalTransition;
53
54class QStatePrivate;
55class Q_CORE_EXPORT QState : public QAbstractState
56{
57 Q_OBJECT
58 Q_PROPERTY(QAbstractState* initialState READ initialState WRITE setInitialState NOTIFY initialStateChanged)
59 Q_PROPERTY(QAbstractState* errorState READ errorState WRITE setErrorState NOTIFY errorStateChanged)
60 Q_PROPERTY(ChildMode childMode READ childMode WRITE setChildMode NOTIFY childModeChanged)
61public:
62 enum ChildMode {
63 ExclusiveStates,
64 ParallelStates
65 };
66 Q_ENUM(ChildMode)
67
68 enum RestorePolicy {
69 DontRestoreProperties,
70 RestoreProperties
71 };
72 Q_ENUM(RestorePolicy)
73
74 QState(QState *parent = nullptr);
75 QState(ChildMode childMode, QState *parent = nullptr);
76 ~QState();
77
78 QAbstractState *errorState() const;
79 void setErrorState(QAbstractState *state);
80
81 void addTransition(QAbstractTransition *transition);
82 QSignalTransition *addTransition(const QObject *sender, const char *signal, QAbstractState *target);
83#ifdef Q_QDOC
84 template<typename PointerToMemberFunction>
85 QSignalTransition *addTransition(const QObject *sender, PointerToMemberFunction signal,
86 QAbstractState *target);
87#else
88 template <typename Func>
89 QSignalTransition *addTransition(const typename QtPrivate::FunctionPointer<Func>::Object *obj,
90 Func signal, QAbstractState *target)
91 {
92 const QMetaMethod signalMetaMethod = QMetaMethod::fromSignal(signal);
93 return addTransition(obj, signalMetaMethod.methodSignature().constData(), target);
94 }
95#endif // Q_QDOC
96 QAbstractTransition *addTransition(QAbstractState *target);
97 void removeTransition(QAbstractTransition *transition);
98 QList<QAbstractTransition*> transitions() const;
99
100 QAbstractState *initialState() const;
101 void setInitialState(QAbstractState *state);
102
103 ChildMode childMode() const;
104 void setChildMode(ChildMode mode);
105
106#ifndef QT_NO_PROPERTIES
107 void assignProperty(QObject *object, const char *name,
108 const QVariant &value);
109#endif
110
111Q_SIGNALS:
112 void finished(QPrivateSignal);
113 void propertiesAssigned(QPrivateSignal);
114 void childModeChanged(QPrivateSignal);
115 void initialStateChanged(QPrivateSignal);
116 void errorStateChanged(QPrivateSignal);
117
118protected:
119 void onEntry(QEvent *event) override;
120 void onExit(QEvent *event) override;
121
122 bool event(QEvent *e) override;
123
124protected:
125 QState(QStatePrivate &dd, QState *parent);
126
127private:
128 Q_DISABLE_COPY(QState)
129 Q_DECLARE_PRIVATE(QState)
130};
131
132QT_END_NAMESPACE
133
134#endif
135