|
1 /**************************************************************************** |
|
2 ** |
|
3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). |
|
4 ** All rights reserved. |
|
5 ** Contact: Nokia Corporation (qt-info@nokia.com) |
|
6 ** |
|
7 ** This file is part of the QtCore module of the Qt Toolkit. |
|
8 ** |
|
9 ** $QT_BEGIN_LICENSE:LGPL$ |
|
10 ** No Commercial Usage |
|
11 ** This file contains pre-release code and may not be distributed. |
|
12 ** You may use this file in accordance with the terms and conditions |
|
13 ** contained in the Technology Preview License Agreement accompanying |
|
14 ** this package. |
|
15 ** |
|
16 ** GNU Lesser General Public License Usage |
|
17 ** Alternatively, this file may be used under the terms of the GNU Lesser |
|
18 ** General Public License version 2.1 as published by the Free Software |
|
19 ** Foundation and appearing in the file LICENSE.LGPL included in the |
|
20 ** packaging of this file. Please review the following information to |
|
21 ** ensure the GNU Lesser General Public License version 2.1 requirements |
|
22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. |
|
23 ** |
|
24 ** In addition, as a special exception, Nokia gives you certain additional |
|
25 ** rights. These rights are described in the Nokia Qt LGPL Exception |
|
26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. |
|
27 ** |
|
28 ** If you have questions regarding the use of this file, please contact |
|
29 ** Nokia at qt-info@nokia.com. |
|
30 ** |
|
31 ** |
|
32 ** |
|
33 ** |
|
34 ** |
|
35 ** |
|
36 ** |
|
37 ** |
|
38 ** $QT_END_LICENSE$ |
|
39 ** |
|
40 ****************************************************************************/ |
|
41 |
|
42 #include "qfinalstate.h" |
|
43 |
|
44 #ifndef QT_NO_STATEMACHINE |
|
45 |
|
46 #include "qabstractstate_p.h" |
|
47 |
|
48 QT_BEGIN_NAMESPACE |
|
49 |
|
50 /*! |
|
51 \class QFinalState |
|
52 |
|
53 \brief The QFinalState class provides a final state. |
|
54 |
|
55 \since 4.6 |
|
56 \ingroup statemachine |
|
57 |
|
58 A final state is used to communicate that (part of) a QStateMachine has |
|
59 finished its work. When a final top-level state is entered, the state |
|
60 machine's \l{QStateMachine::finished()}{finished}() signal is emitted. In |
|
61 general, when a final substate (a child of a QState) is entered, the parent |
|
62 state's \l{QState::finished()}{finished}() signal is emitted. QFinalState |
|
63 is part of \l{The State Machine Framework}. |
|
64 |
|
65 To use a final state, you create a QFinalState object and add a transition |
|
66 to it from another state. Example: |
|
67 |
|
68 \code |
|
69 QPushButton button; |
|
70 |
|
71 QStateMachine machine; |
|
72 QState *s1 = new QState(); |
|
73 QFinalState *s2 = new QFinalState(); |
|
74 s1->addTransition(&button, SIGNAL(clicked()), s2); |
|
75 machine.addState(s1); |
|
76 machine.addState(s2); |
|
77 |
|
78 QObject::connect(&machine, SIGNAL(finished()), QApplication::instance(), SLOT(quit())); |
|
79 machine.setInitialState(s1); |
|
80 machine.start(); |
|
81 \endcode |
|
82 |
|
83 \sa QStateMachine::finished(), QState::finished() |
|
84 */ |
|
85 |
|
86 class QFinalStatePrivate : public QAbstractStatePrivate |
|
87 { |
|
88 Q_DECLARE_PUBLIC(QFinalState) |
|
89 |
|
90 public: |
|
91 QFinalStatePrivate(); |
|
92 }; |
|
93 |
|
94 QFinalStatePrivate::QFinalStatePrivate() |
|
95 { |
|
96 } |
|
97 |
|
98 /*! |
|
99 Constructs a new QFinalState object with the given \a parent state. |
|
100 */ |
|
101 QFinalState::QFinalState(QState *parent) |
|
102 : QAbstractState(*new QFinalStatePrivate, parent) |
|
103 { |
|
104 } |
|
105 |
|
106 /*! |
|
107 Destroys this final state. |
|
108 */ |
|
109 QFinalState::~QFinalState() |
|
110 { |
|
111 } |
|
112 |
|
113 /*! |
|
114 \reimp |
|
115 */ |
|
116 void QFinalState::onEntry(QEvent *event) |
|
117 { |
|
118 Q_UNUSED(event); |
|
119 } |
|
120 |
|
121 /*! |
|
122 \reimp |
|
123 */ |
|
124 void QFinalState::onExit(QEvent *event) |
|
125 { |
|
126 Q_UNUSED(event); |
|
127 } |
|
128 |
|
129 /*! |
|
130 \reimp |
|
131 */ |
|
132 bool QFinalState::event(QEvent *e) |
|
133 { |
|
134 return QAbstractState::event(e); |
|
135 } |
|
136 |
|
137 QT_END_NAMESPACE |
|
138 |
|
139 #endif //QT_NO_STATEMACHINE |