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 QHISTORYSTATE_H
41 #define QHISTORYSTATE_H
42 
43 #include <QtCore/qabstractstate.h>
44 
45 QT_REQUIRE_CONFIG(statemachine);
46 
47 QT_BEGIN_NAMESPACE
48 
49 class QAbstractTransition;
50 class QHistoryStatePrivate;
51 class Q_CORE_EXPORT QHistoryState : public QAbstractState
52 {
53     Q_OBJECT
54     Q_PROPERTY(QAbstractState* defaultState READ defaultState WRITE setDefaultState NOTIFY defaultStateChanged)
55     Q_PROPERTY(QAbstractTransition* defaultTransition READ defaultTransition WRITE setDefaultTransition NOTIFY defaultTransitionChanged)
56     Q_PROPERTY(HistoryType historyType READ historyType WRITE setHistoryType NOTIFY historyTypeChanged)
57 public:
58     enum HistoryType {
59         ShallowHistory,
60         DeepHistory
61     };
62     Q_ENUM(HistoryType)
63 
64     QHistoryState(QState *parent = nullptr);
65     QHistoryState(HistoryType type, QState *parent = nullptr);
66     ~QHistoryState();
67 
68     QAbstractTransition *defaultTransition() const;
69     void setDefaultTransition(QAbstractTransition *transition);
70 
71     QAbstractState *defaultState() const;
72     void setDefaultState(QAbstractState *state);
73 
74     HistoryType historyType() const;
75     void setHistoryType(HistoryType type);
76 
77 Q_SIGNALS:
78     void defaultTransitionChanged(QPrivateSignal);
79     void defaultStateChanged(QPrivateSignal);
80     void historyTypeChanged(QPrivateSignal);
81 
82 protected:
83     void onEntry(QEvent *event) override;
84     void onExit(QEvent *event) override;
85 
86     bool event(QEvent *e) override;
87 
88 private:
89     Q_DISABLE_COPY(QHistoryState)
90     Q_DECLARE_PRIVATE(QHistoryState)
91 };
92 
93 QT_END_NAMESPACE
94 
95 #endif
96