Deploying QML Applications

QML documents are loaded and run by the QML runtime. This includes the Declarative UI engine along with the built-in QML types and plugin modules. The QML runtime also provides access to third-party QML types and modules.

Applications that use QML must invoke the QML runtime to run QML documents. You can do this by creating a QQuickView or a QQmlEngine, as described below. In addition, the Declarative UI package includes the qml tool, which loads .qml files. This tool is useful for developing and testing QML code without having to write a C++ application to load the QML runtime.

Deploying Applications with Qt Creator

Qt Creator deploys and packages QML applications to various platforms. For mobile devices, Qt Creator can directly bundle applications to the respective platform package formats, such as APK.

When you run your applications on the target platform, your application needs to access the location of the QML libraries. If you use qmake, the QT_INSTALL_QML environment variable points to the location of the libraries. The Qt Installers install the QML libraries in: <version>/<compiler>/qml directory.

QML Caching

The QML runtime loads QML documents by parsing them and generating byte code. Most of the time, the document hasn't changed since the last time it was loaded. To speed up this loading process, the QML runtime maintains a cache file for each QML document. This cache file contains the compiled byte code and a binary representation of the QML document structure. In addition, when multiple applications use the same QML document, the memory needed for the code is shared between application processes. The cache files are loaded via the mmap() system call on POSIX-compliant operating systems or CreateFileMapping() on Windows, resulting in significant memory savings.

Each time you load a changed QML document, the cache is automatically re-created. Cache files are located in a sub-directory of QStandardPaths::CacheLocation with the name "qmlcache". The file extension is .qmlc for QML documents and .jsc for imported JavaScript modules.

Ahead-of-Time Compilation

The automatic caching of compiled QML documents into cache files results in significantly faster application load time. However, the initial creation of cache files can still take time, especially when the application starts for the very first time. To avoid that initial step and provide faster startup times from the very beginning, Qt's build system allows you to perform the compilation step for QML files ahead of time, when compiling the C++ parts of your application.

To deploy your application with QML files compiled ahead of time, you must organize the files and the build system in a specific way:

• All QML documents (including JavaScript files) must be included as resources via Qt's Resource system.
• Your application must load the QML documents via the qrc:/// URL scheme.
• You can enable Ahead-of-Time compilation using the CONFIG+=qtquickcompiler directive.
• If you're using the CMake build system, then you can achieve this by inserting a find_package(Qt5QuickCompiler) call into your CMakeLists.txt and replacing the use of qt5_add_resources with qtquick_compiler_add_resources.

One benefit of compiling ahead of time is that, in the event of syntax errors in your QML documents, you are notified at application compile-time instead of at run-time, when the file is loaded.

Prototyping with QML Scene

The Declarative UI package includes a QML runtime tool, qml, which loads and displays QML documents. This is useful during the application development phase for prototyping QML-based applications without writing your own C++ applications to invoke the QML runtime.

Initializing the QML Runtime in Applications

To run an application that uses QML, your application must invoke the QML runtime. This is done by writing a Qt C++ application that loads the QQmlEngine by either:

• Loading the QML file through a QQuickView instance.
• Creating a QQmlEngine instance and loading QML files with QQmlComponent.

Initializing with QQuickView

QQuickView is a QWindow-based class that can load QML files. For example, if there is a QML file, application.qml, it will look like this:

import QtQuick 2.3

Rectangle { width: 100; height: 100; color: "red" }

It can be loaded in a Qt application's main.cpp file like this:

#include <QGuiApplication>
#include <QQuickView>

int main(int argc, char *argv[])
{
    QGuiApplication app(argc, argv);

    QQuickView view;
    view.setSource(QUrl::fromLocalFile("application.qml"));
    view.show();

    return app.exec();
}

This creates a QWindow-based view that displays the contents of application.qml.

The application's .pro project file must specify the declarative module for the QT variable. For example:

TEMPLATE += app
QT += quick
SOURCES += main.cpp

Creating a QQmlEngine Directly

If application.qml doesn't have any graphical components, or if it's preferred to avoid QQuickView for other reasons, the QQmlEngine can be constructed directly instead. In this case, application.qml is loaded as a QQmlComponent instance rather than placed into a view:

#include <QGuiApplication>
#include <QQmlEngine>
#include <QQmlContext>
#include <QQmlComponent>

int main(int argc, char *argv[])
{
    QGuiApplication app(argc, argv);

    QQmlEngine engine;
    QQmlContext *objectContext = new QQmlContext(engine.rootContext());

    QQmlComponent component(&engine, "application.qml");
    QObject *object = component.create(objectContext);

    // ... delete object and objectContext when necessary

    return app.exec();
}

If you're not using any graphical items from Qt Quick, you can replace QGuiApplication with a QCoreApplication in the code above. This way, you can use QML as a language without any dependencies to the Qt GUI module.

Managing Resource Files with the Qt Resource System

The Qt resource system allows resource files to be stored as binary files in an application executable. This can be useful when building a mixed QML/C++ application as it enables QML files and other resources -- such as images and sound files -- to be referred to through the resource system URI scheme rather than relative or absolute paths to filesystem resources.

To use the resource system in a mixed QML/C++ application:

• Create a .qrc resource collection file that lists resource files in XML format.
• From C++, load the main QML file as a resource using the :/ prefix or as a URL with the .qrc scheme.

Once this is done, all files specified by relative paths in QML are loaded from the resource system instead. Use of the resource system is completely transparent to the QML layer; this means all QML code should refer to resource files using relative paths and should not use the .qrc scheme. This scheme should only be used from C++ code to refer to resource files.

Here's an application packaged using the Qt resource system; its directory structure is as follows:

project
    |- example.qrc
    |- main.qml
    |- images
        |- background.png
    |- main.cpp
    |- project.pro

The main.qml and background.png files are packaged as resource files. This is done in the example.qrc resource collection file:

<!DOCTYPE RCC>
<RCC version="1.0">

<qresource prefix="/">
    <file>main.qml</file>
    <file>images/background.png</file>
</qresource>

</RCC>

Since background.png is a resource file, main.qml can refer to it using the relative path specified in example.qrc:

// main.qml
import QtQuick 2.3

Image { source: "images/background.png" }

To allow QML to locate resource files correctly, the main.cpp loads the main QML file, main.qml, as a resource file using the .qrc scheme:

int main(int argc, char *argv[])
{
    QApplication app(argc, argv);

    QQuickView view;
    view.setSource(QUrl("qrc:/main.qml"));
    view.show();

    return app.exec();
}

Finally, project.pro uses the RESOURCES variable to indicate that example.qrc should be used to build the application resources:

QT += qml

SOURCES += main.cpp
RESOURCES += example.qrc

Related Information

• Deploying Qt Applications
• Running on Multiple Platforms
• Deploying to Devices
• qtqml-cppintegration-exposecppattributes.html{Exposing Attributes of C++ Types to QML}
• The Qt Resource System