qt-everywhere-src-5.15.1/qtscxml/examples/scxml/trafficlight-widgets-static/doc/src/trafficlight-widgets-static.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-static
    \title Qt SCXML Traffic Light Example (Static)
    \ingroup examples-qtscxml

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

    \image trafficlight.png

    \e{Traffic Light Example (Static)} 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 Widgets.

    \include examples-run.qdocinc

    \include trafficlight-compiling.qdocinc

    \section1 Instantiating the State Machine

    We instantiate the generated \c TrafficLightStateMachine class in the
    \e trafficlight-widgets-static.cpp file, as follows:

    \quotefromfile trafficlight-widgets-static/trafficlight-widgets-static.cpp
    \skipto #include
    \printuntil }

    \include trafficlight-state-machine.qdocinc

    We connect to the states as follows:

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