1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtCore module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qabstractstate.h"
#include "qabstractstate_p.h"
#include "qstate.h"
#include "qstate_p.h"
#include "qstatemachine.h"
#include "qstatemachine_p.h"
QT_BEGIN_NAMESPACE
/*!
\class QAbstractState
\inmodule QtCore
\brief The QAbstractState class is the base class of states of a QStateMachine.
\since 4.6
\ingroup statemachine
The QAbstractState class is the abstract base class of states that are part
of a QStateMachine. It defines the interface that all state objects have in
common. QAbstractState is part of \l{The State Machine Framework}.
The entered() signal is emitted when the state has been entered. The
exited() signal is emitted when the state has been exited.
The parentState() function returns the state's parent state. The machine()
function returns the state machine that the state is part of.
\section1 Subclassing
The onEntry() function is called when the state is entered; reimplement this
function to perform custom processing when the state is entered.
The onExit() function is called when the state is exited; reimplement this
function to perform custom processing when the state is exited.
*/
/*!
\property QAbstractState::active
\since 5.4
\brief the active property of this state. A state is active between
entered() and exited() signals.
*/
QAbstractStatePrivate::QAbstractStatePrivate(StateType type)
: stateType(type), isMachine(false), active(false), parentState(nullptr)
{
}
QStateMachine *QAbstractStatePrivate::machine() const
{
QObject *par = parent;
while (par != nullptr) {
if (QStateMachine *mach = qobject_cast<QStateMachine*>(par))
return mach;
par = par->parent();
}
return nullptr;
}
void QAbstractStatePrivate::callOnEntry(QEvent *e)
{
Q_Q(QAbstractState);
q->onEntry(e);
}
void QAbstractStatePrivate::callOnExit(QEvent *e)
{
Q_Q(QAbstractState);
q->onExit(e);
}
void QAbstractStatePrivate::emitEntered()
{
Q_Q(QAbstractState);
emit q->entered(QAbstractState::QPrivateSignal());
if (!active) {
active = true;
emit q->activeChanged(true);
}
}
void QAbstractStatePrivate::emitExited()
{
Q_Q(QAbstractState);
if (active) {
active = false;
emit q->activeChanged(false);
}
emit q->exited(QAbstractState::QPrivateSignal());
}
/*!
Constructs a new state with the given \a parent state.
*/
QAbstractState::QAbstractState(QState *parent)
: QObject(*new QAbstractStatePrivate(QAbstractStatePrivate::AbstractState), parent)
{
}
/*!
\internal
*/
QAbstractState::QAbstractState(QAbstractStatePrivate &dd, QState *parent)
: QObject(dd, parent)
{
}
/*!
Destroys this state.
*/
QAbstractState::~QAbstractState()
{
}
/*!
Returns this state's parent state, or \nullptr if the state has no
parent state.
*/
QState *QAbstractState::parentState() const
{
Q_D(const QAbstractState);
if (d->parentState != parent())
d->parentState = qobject_cast<QState*>(parent());
return d->parentState;
}
/*!
Returns the state machine that this state is part of, or \nullptr if
the state is not part of a state machine.
*/
QStateMachine *QAbstractState::machine() const
{
Q_D(const QAbstractState);
return d->machine();
}
/*!
Returns whether this state is active.
\sa activeChanged(bool), entered(), exited()
*/
bool QAbstractState::active() const
{
Q_D(const QAbstractState);
return d->active;
}
/*!
\fn QAbstractState::onExit(QEvent *event)
This function is called when the state is exited. The given \a event is what
caused the state to be exited. Reimplement this function to perform custom
processing when the state is exited.
*/
/*!
\fn QAbstractState::onEntry(QEvent *event)
This function is called when the state is entered. The given \a event is
what caused the state to be entered. Reimplement this function to perform
custom processing when the state is entered.
*/
/*!
\fn QAbstractState::entered()
This signal is emitted when the state has been entered (after onEntry() has
been called).
*/
/*!
\fn QAbstractState::exited()
This signal is emitted when the state has been exited (after onExit() has
been called).
*/
/*!
\fn QAbstractState::activeChanged(bool active)
\since 5.4
This signal is emitted when the active property is changed with \a active as argument.
\sa QAbstractState::active, entered(), exited()
*/
/*!
\reimp
*/
bool QAbstractState::event(QEvent *e)
{
return QObject::event(e);
}
QT_END_NAMESPACE
#include "moc_qabstractstate.cpp"
|
