summaryrefslogtreecommitdiffstats
path: root/examples/scxml/invoke-static/doc/src/invoke-static.qdoc
blob: d58f49cf1052775a689c7ef541d957d3e296a284 (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
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \example invoke-static
    \title Qt SCXML Invoke Example (Static)
    \ingroup examples-qtscxml

    \brief Invokes a compiled nested state machine.

    \image invoke-static.png

    \e{Invoke Example (Static)} demonstrates how to use the \c <invoke> element
    with generated nested state-machines, where the SCXML file is compiled to
    a C++ class. The \c <invoke> element is used to create an instance of an
    external service.

    \include examples-run.qdocinc

    \section1 Invoking the State Machine

    In \e statemachine.scxml, we specify a state machine with the name
    \e Directions of type \e http://www.w3.org/TR/scxml/ to invoke:

    \quotefromfile invoke-common/statemachine.scxml
    \skipto enable-qt-mode
    \printuntil

    \section1 Compiling the State Machine

    We link against the Qt SCXML module by adding the following line to the
    \e invoke-static.pro file:

    \quotefromfile invoke-static/invoke-static.pro
    \skipto QT
    \printline scxml

    We then specify the state machine to compile:

    \skipto STATECHARTS
    \printline statemachine

    The Qt SCXML Compiler, \c qscxmlc, is run automatically to generate
    \e statemachine.h and \e statemachine.cpp, and to add them to the \c HEADERS
    and \c SOURCES variables for compilation.

    \section1 Instantiating the State Machine

    We instantiate the generated \c Directions class in the \e invoke-static.cpp
    file, as follows:

    \quotefromfile invoke-static/invoke-static.cpp
    \skipto statemachine.h
    \printuntil }
*/