summaryrefslogtreecommitdiffstats
path: root/examples/scxml/trafficlight-qml-simple/doc/src/trafficlight-qml-simple.qdoc
blob: 8a59aeb5ade70633c9ef6afa67da5b89814a94fc (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
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only

/*!
    \example trafficlight-qml-simple
    \title SCXML Traffic Light (Simple, QML)
    \ingroup examples-qtscxml

    \brief A Qt Quick application that uses a compiled state machine to
    implement a simplified traffic light.

    \image trafficlight.png

    \e{Traffic Light} demonstrates how to connect to the
    active properties of a state in a state machine that is compiled to a class.

    The UI is created using Qt Quick.

    \include examples-run.qdocinc

    \include trafficlight-compiling.qdocinc

    \section1 Instantiating the State Machine

    We instantiate the state machine as follows:

    \quotefromfile trafficlight-qml-simple/MainView.qml

    \skipto TrafficLightStateMachine {
    \printuntil }

    \include trafficlight-state-machine.qdocinc

    We connect to the states as follows:

    \quotefromfile trafficlight-qml-simple/MainView.qml
    \skipto Light {
    \printuntil /^ {4}\}/
*/