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 QSTATEMACHINE_H
43#define QSTATEMACHINE_H
44
45#include <QtCore/qstate.h>
46
47#include <QtCore/qcoreevent.h>
48#include <QtCore/qlist.h>
49#include <QtCore/qobject.h>
50#include <QtCore/qset.h>
51#include <QtCore/qvariant.h>
52
53QT_BEGIN_HEADER
54
55QT_BEGIN_NAMESPACE
56
57QT_MODULE(Core)
58
59#ifndef QT_NO_STATEMACHINE
60
61class QStateMachinePrivate;
62class QAbstractAnimation;
63class Q_CORE_EXPORT QStateMachine : public QState
64{
65 Q_OBJECT
66 Q_PROPERTY(QString errorString READ errorString)
67 Q_PROPERTY(RestorePolicy globalRestorePolicy READ globalRestorePolicy WRITE setGlobalRestorePolicy)
68 Q_ENUMS(RestorePolicy)
69#ifndef QT_NO_ANIMATION
70 Q_PROPERTY(bool animated READ isAnimated WRITE setAnimated)
71#endif
72public:
73 class Q_CORE_EXPORT SignalEvent : public QEvent
74 {
75 public:
76 SignalEvent(QObject *sender, int signalIndex,
77 const QList<QVariant> &arguments);
78 ~SignalEvent();
79
80 inline QObject *sender() const { return m_sender; }
81 inline int signalIndex() const { return m_signalIndex; }
82 inline QList<QVariant> arguments() const { return m_arguments; }
83
84 private:
85 QObject *m_sender;
86 int m_signalIndex;
87 QList<QVariant> m_arguments;
88
89 friend class QSignalTransitionPrivate;
90 };
91
92 class Q_CORE_EXPORT WrappedEvent : public QEvent
93 {
94 public:
95 WrappedEvent(QObject *object, QEvent *event);
96 ~WrappedEvent();
97
98 inline QObject *object() const { return m_object; }
99 inline QEvent *event() const { return m_event; }
100
101 private:
102 QObject *m_object;
103 QEvent *m_event;
104 };
105
106 enum EventPriority {
107 NormalPriority,
108 HighPriority
109 };
110
111 enum RestorePolicy {
112 DontRestoreProperties,
113 RestoreProperties
114 };
115
116 enum Error {
117 NoError,
118 NoInitialStateError,
119 NoDefaultStateInHistoryStateError,
120 NoCommonAncestorForTransitionError
121 };
122
123 QStateMachine(QObject *parent = 0);
124 ~QStateMachine();
125
126 void addState(QAbstractState *state);
127 void removeState(QAbstractState *state);
128
129 Error error() const;
130 QString errorString() const;
131 void clearError();
132
133 bool isRunning() const;
134
135#ifndef QT_NO_ANIMATION
136 bool isAnimated() const;
137 void setAnimated(bool enabled);
138
139 void addDefaultAnimation(QAbstractAnimation *animation);
140 QList<QAbstractAnimation *> defaultAnimations() const;
141 void removeDefaultAnimation(QAbstractAnimation *animation);
142#endif // QT_NO_ANIMATION
143
144 QStateMachine::RestorePolicy globalRestorePolicy() const;
145 void setGlobalRestorePolicy(QStateMachine::RestorePolicy restorePolicy);
146
147 void postEvent(QEvent *event, EventPriority priority = NormalPriority);
148 int postDelayedEvent(QEvent *event, int delay);
149 bool cancelDelayedEvent(int id);
150
151 QSet<QAbstractState*> configuration() const;
152
153#ifndef QT_NO_STATEMACHINE_EVENTFILTER
154 bool eventFilter(QObject *watched, QEvent *event);
155#endif
156
157public Q_SLOTS:
158 void start();
159 void stop();
160
161Q_SIGNALS:
162 void started();
163 void stopped();
164
165protected:
166 void onEntry(QEvent *event);
167 void onExit(QEvent *event);
168
169 virtual void beginSelectTransitions(QEvent *event);
170 virtual void endSelectTransitions(QEvent *event);
171
172 virtual void beginMicrostep(QEvent *event);
173 virtual void endMicrostep(QEvent *event);
174
175 bool event(QEvent *e);
176
177protected:
178 QStateMachine(QStateMachinePrivate &dd, QObject *parent);
179
180private:
181 Q_DISABLE_COPY(QStateMachine)
182 Q_DECLARE_PRIVATE(QStateMachine)
183 Q_PRIVATE_SLOT(d_func(), void _q_start())
184 Q_PRIVATE_SLOT(d_func(), void _q_process())
185#ifndef QT_NO_ANIMATION
186 Q_PRIVATE_SLOT(d_func(), void _q_animationFinished())
187#endif
188};
189
190#endif //QT_NO_STATEMACHINE
191
192QT_END_NAMESPACE
193
194QT_END_HEADER
195
196#endif
197