Revision control
Copy as Markdown
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\page qtscxml-index.html
\title Qt SCXML
\brief Provides functionality to create state machines from SCXML files.
The Qt SCXML module provides functionality to create state machines from
\l {SCXML Specification}{SCXML} files. This includes both dynamically
creating state machines (loading the SCXML file and instantiating states
and transitions) and generating a C++ file that has a class implementing
the state machine. It also contains functionality to support data models
and executable content.
\section1 Getting Started
To use Qt SCXML, install the \e {Qt State Machines} additional library.
To import the QML types into your application, use the following import statement
in your .qml file:
\qml
import QtScxml
\endqml
To link against the module:
Using cmake:
\include qtscxml-module-use.qdocinc cmakebuild
Using qmake:
\include qtscxml-module-use.qdocinc qmakebuild
\section1 Articles and Guides
\list
\li \l {Qt SCXML Overview}
\li \l {Instantiating State Machines}
\li \l {SCXML Compliance}
\li \l {Using the Qt SCXML Compiler (qscxmlc)}
\endlist
\section1 Examples
\list
\li \l {Qt SCXML Examples}
\endlist
\section1 Reference
\list
\li \l {Qt SCXML C++ Classes} {C++ Classes and Namespaces}
\li \l {Qt SCXML QML Types} {QML Types}
\endlist
\section1 Module Evolution
\l{Changes to Qt SCXML} lists important changes in the module API
and functionality that were done for the Qt 6 series of Qt.
\section1 Licenses and Trademarks
The Qt SCXML module is available under commercial licenses from
\l{The Qt Company}. In addition, it is available under free software licenses:
The \l{GNU Lesser General Public License, version 3}, or
the \l{GNU General Public License, version 2}.
See \l{Qt Licensing} for further details.
*/