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 QABSTRACTSTATE_H
41#define QABSTRACTSTATE_H
42
43#include <QtCore/qobject.h>
44
45QT_REQUIRE_CONFIG(statemachine);
46
47QT_BEGIN_NAMESPACE
48
49class QState;
50class QStateMachine;
51
52class QAbstractStatePrivate;
53class Q_CORE_EXPORT QAbstractState : public QObject
54{
55 Q_OBJECT
56 Q_PROPERTY(bool active READ active NOTIFY activeChanged)
57public:
58 ~QAbstractState();
59
60 QState *parentState() const;
61 QStateMachine *machine() const;
62
63 bool active() const;
64
65Q_SIGNALS:
66 void entered(QPrivateSignal);
67 void exited(QPrivateSignal);
68 void activeChanged(bool active);
69
70protected:
71 QAbstractState(QState *parent = nullptr);
72
73 virtual void onEntry(QEvent *event) = 0;
74 virtual void onExit(QEvent *event) = 0;
75
76 bool event(QEvent *e) override;
77
78protected:
79 QAbstractState(QAbstractStatePrivate &dd, QState *parent);
80
81private:
82 Q_DISABLE_COPY(QAbstractState)
83 Q_DECLARE_PRIVATE(QAbstractState)
84};
85
86QT_END_NAMESPACE
87
88#endif
89