summaryrefslogtreecommitdiffstats
path: root/src/scxmlqml/eventconnection.cpp
blob: b054bcff339c9fc9d43024c48dd28048535d5c45 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only

#include "eventconnection_p.h"

QT_BEGIN_NAMESPACE

/*!
    \qmltype EventConnection
//!    \instantiates QScxmlEventConnection
    \inqmlmodule QtScxml
    \since QtScxml 5.8

    \brief Connects to events sent out by state machines.

    To receive a notification when a state machine sends out an event, a
    connection can be created to the corresponding signal.
*/

/*!
    \qmlproperty stringlist EventConnection::events

    The list of SCXML event specifiers that describe the events to listen for.

    Even though spaces are allowed in event specifications in SCXML documents,
    they are not allowed in this list. However, the list can contain multiple
    specifiers, to the same effect.
*/

/*!
    \qmlproperty ScxmlStateMachine EventConnection::stateMachine

    The state machine that sends out the event.
*/

/*!
    \qmlsignal EventConnection::occurred(event)

    This signal is emitted when the event \a event occurs.

    \sa QScxmlEvent
*/


QScxmlEventConnection::QScxmlEventConnection(QObject *parent) :
    QObject(parent)
{
}

QStringList QScxmlEventConnection::events() const
{
    return m_events;
}

void QScxmlEventConnection::setEvents(const QStringList &events)
{
    m_events.removeBindingUnlessInWrapper();
    if (events == m_events.valueBypassingBindings()) {
        return;
    }
    m_events.setValueBypassingBindings(events);
    doConnect();
    m_events.notify();
}

QBindable<QStringList> QScxmlEventConnection::bindableEvents()
{
    return &m_events;
}

QScxmlStateMachine *QScxmlEventConnection::stateMachine() const
{
    return m_stateMachine;
}

void QScxmlEventConnection::setStateMachine(QScxmlStateMachine *stateMachine)
{
    m_stateMachine.removeBindingUnlessInWrapper();
    if (stateMachine == m_stateMachine.valueBypassingBindings())
        return;
    m_stateMachine.setValueBypassingBindings(stateMachine);
    doConnect();
    m_stateMachine.notify();
}

QBindable<QScxmlStateMachine*> QScxmlEventConnection::bindableStateMachine()
{
    return &m_stateMachine;
}

void QScxmlEventConnection::doConnect()
{
    for (const QMetaObject::Connection &connection : std::as_const(m_connections))
        disconnect(connection);
    m_connections.clear();
    const auto stateMachine = m_stateMachine.valueBypassingBindings();
    if (stateMachine) {
        const auto events = m_events.valueBypassingBindings();
        for (const QString &event : events) {
            m_connections.append(stateMachine->connectToEvent(event, this,
                                                              &QScxmlEventConnection::occurred));
        }
    }
}

void QScxmlEventConnection::classBegin()
{
}

void QScxmlEventConnection::componentComplete()
{
    auto parentStateMachine = qobject_cast<QScxmlStateMachine *>(parent());
    if (!m_stateMachine.value() && parentStateMachine)
        setStateMachine(parentStateMachine);
}

QT_END_NAMESPACE