1/****************************************************************************
2**
3** Copyright (C) 2016 Ford Motor Company
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtQml 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#include "finalstate.h"
41
42#include <QQmlContext>
43#include <QQmlEngine>
44#include <QQmlInfo>
45
46FinalState::FinalState(QState *parent)
47 : QFinalState(parent)
48{
49}
50
51QQmlListProperty<QObject> FinalState::children()
52{
53 return QQmlListProperty<QObject>(this, &m_children,
54 m_children.append, m_children.count, m_children.at,
55 m_children.clear, m_children.replace, m_children.removeLast);
56}
57
58/*!
59 \qmltype FinalState
60 \inqmlmodule QtQml.StateMachine
61 \inherits QAbstractState
62 \ingroup statemachine-qmltypes
63 \since 5.4
64
65 \brief Provides a final state.
66
67
68 A final state is used to communicate that (part of) a StateMachine has
69 finished its work. When a final top-level state is entered, the state
70 machine's \l{State::finished}{finished}() signal is emitted. In
71 general, when a final substate (a child of a State) is entered, the parent
72 state's \l{State::finished}{finished}() signal is emitted. FinalState
73 is part of \l{The Declarative State Machine Framework}.
74
75 To use a final state, you create a FinalState object and add a transition
76 to it from another state.
77
78 \section1 Example Usage
79
80 \snippet qml/statemachine/finalstate.qml document
81
82 \clearfloat
83
84 \sa StateMachine, State
85*/
86

source code of qtdeclarative/src/imports/statemachine/finalstate.cpp