qt-everywhere-src-5.15.1/qtscxml/examples/scxml/trafficlight-widgets-dynamic/doc/src/trafficlight-widgets-dynamic.qdoc

/****************************************************************************
**
** 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 trafficlight-widgets-dynamic
    \title Qt SCXML Traffic Light Example (Dynamic)
    \ingroup examples-qtscxml

    \brief A widget-based application that uses a dynamically loaded state
     machine to implement a traffic light.

    \image trafficlight.png

    \e{Traffic Light Example (Dynamic)} demonstrates how to connect to the
    active properties of a state in a dynamically loaded state machine.

    The UI is created using Qt Widgets.

    \include examples-run.qdocinc

    \section1 Dynamically Loading the State Machine

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

    \quotefromfile trafficlight-widgets-dynamic/trafficlight-widgets-dynamic.pro
    \skipto QT
    \printline scxml

    We dynamically create the state machine in
    \e trafficlight-widgets-dynamic.cpp:

    \quotefromfile trafficlight-widgets-dynamic/trafficlight-widgets-dynamic.cpp
    \skipto trafficlight.h
    \printuntil /^ {4}\}/

    And then instantiate it:

    \printuntil /^\}/

    \include trafficlight-state-machine.qdocinc

    We connect to the states as follows:

    \quotefromfile trafficlight-common/trafficlight.cpp
    \skipto connectToState
    \printuntil greenLight
*/