From 86dcf7cb1adf5a97a9a876ca3dfefe13243bb558 Mon Sep 17 00:00:00 2001 From: Leena Miettinen Date: Mon, 20 Mar 2017 10:40:15 +0100 Subject: Doc: Add docs for the EventConnection QML type Change-Id: I0b4c93797fa076e6360c92badea551b01acef644 Reviewed-by: Ulf Hermann --- src/imports/scxmlstatemachine/eventconnection.cpp | 37 +++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/src/imports/scxmlstatemachine/eventconnection.cpp b/src/imports/scxmlstatemachine/eventconnection.cpp index 9803a9a..c35d43c 100644 --- a/src/imports/scxmlstatemachine/eventconnection.cpp +++ b/src/imports/scxmlstatemachine/eventconnection.cpp @@ -41,6 +41,43 @@ 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 QStringList 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 QScxmlStateMachine EventConnection::stateMachine + + The state machine that sends out the event. +*/ + +/*! + \qmlsignal EventConnection::occurred(QScxmlEvent event) + + This signal is emitted when the event \a event occurrs. + + The corresponding signal handler is \c onOccurred. +*/ + + QScxmlEventConnection::QScxmlEventConnection(QObject *parent) : QObject(parent), m_stateMachine(nullptr) { -- cgit v1.2.3