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 QtScxml 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 "eventconnection_p.h"
41
42QT_BEGIN_NAMESPACE
43
44/*!
45 \qmltype EventConnection
46 \instantiates QScxmlEventConnection
47 \inqmlmodule QtScxml
48 \since QtScxml 5.8
49
50 \brief Connects to events sent out by state machines.
51
52 To receive a notification when a state machine sends out an event, a
53 connection can be created to the corresponding signal.
54*/
55
56/*!
57 \qmlproperty stringlist EventConnection::events
58
59 The list of SCXML event specifiers that describe the events to listen for.
60
61 Even though spaces are allowed in event specifications in SCXML documents,
62 they are not allowed in this list. However, the list can contain multiple
63 specifiers, to the same effect.
64*/
65
66/*!
67 \qmlproperty ScxmlStateMachine EventConnection::stateMachine
68
69 The state machine that sends out the event.
70*/
71
72/*!
73 \qmlsignal EventConnection::occurred(event)
74
75 This signal is emitted when the event \a event occurrs.
76
77 The corresponding signal handler is \c onOccurred.
78
79 \sa QScxmlEvent
80*/
81
82
83QScxmlEventConnection::QScxmlEventConnection(QObject *parent) :
84 QObject(parent), m_stateMachine(nullptr)
85{
86}
87
88QStringList QScxmlEventConnection::events() const
89{
90 return m_events;
91}
92
93void QScxmlEventConnection::setEvents(const QStringList &events)
94{
95 if (events != m_events) {
96 m_events = events;
97 doConnect();
98 emit eventsChanged();
99 }
100}
101
102QScxmlStateMachine *QScxmlEventConnection::stateMachine() const
103{
104 return m_stateMachine;
105}
106
107void QScxmlEventConnection::setStateMachine(QScxmlStateMachine *stateMachine)
108{
109 if (stateMachine != m_stateMachine) {
110 m_stateMachine = stateMachine;
111 doConnect();
112 emit stateMachineChanged();
113 }
114}
115
116void QScxmlEventConnection::doConnect()
117{
118 for (const QMetaObject::Connection &connection : qAsConst(t&: m_connections))
119 disconnect(connection);
120 m_connections.clear();
121 if (m_stateMachine) {
122 for (const QString &event : qAsConst(t&: m_events)) {
123 m_connections.append(t: m_stateMachine->connectToEvent(scxmlEventSpec: event, receiver: this,
124 method: &QScxmlEventConnection::occurred));
125 }
126
127 }
128
129}
130
131void QScxmlEventConnection::classBegin()
132{
133}
134
135void QScxmlEventConnection::componentComplete()
136{
137 if (!m_stateMachine) {
138 if ((m_stateMachine = qobject_cast<QScxmlStateMachine *>(object: parent())))
139 doConnect();
140 }
141}
142
143QT_END_NAMESPACE
144

source code of qtscxml/src/imports/scxmlstatemachine/eventconnection.cpp