summaryrefslogtreecommitdiffstats
path: root/examples/scxml/mediaplayer-widgets-static/doc/src/mediaplayer-widgets-static.qdoc
blob: 9d1ae39ab0c5319f266167a928356a015d8a662b (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
/****************************************************************************
**
** 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 mediaplayer-widgets-static
    \title Qt SCXML Media Player Example (Static)
    \ingroup examples-qtscxml

    \brief A widget-based application that sends data to and receives it from a
    compiled ECMAScript data model.

    \image mediaplayer.png

    \e {Media Player Example (Static)} demonstrates how to access data from an
     ECMAScript data model that is compiled into a C++ class.

    The UI is created using Qt Widgets.

    \include examples-run.qdocinc

    \include mediaplayer-ecmascript-data-model.qdocinc

    \include mediaplayer-compiling.qdocinc

    \section1 Instantiating the State Machine

    We instantiate the generated \c MediaPlayerStateMachine class in
    \e {mediaplayer-widgets-static.cpp}:

    \quotefromfile mediaplayer-widgets-static/mediaplayer-widgets-static.cpp
    \skipto mediaplayer.h
    \printuntil MainWindow mainWindow

    To be notified when a state machine sends out an event, we connect to the
    corresponding signals. The media player state machine will send out events
    when users tap a control and when playback starts or stops:

    \printuntil MainWindow::stopped
*/