Qt Qml Design Support

The Qt Qml Design Support provides support for design tooling with a set of types for registering and referencing objects in QML. Objects are identified with a key string at registration and reference types can use these keys to get references to the registered objects. The idea is to allow clean separation between UI code and business logic, particularly in cases where UI code is automatically generated with some tool and developers are not expected to manually modify it. The Qt Qml Design Support module provides both a QML API and a C++ API for referencing registered objects. The object registration is only available as QML API.

Using the Module

QML API

The QML types of the module are available through the QtQml.DesignSupport import. To use the types, add the following import statement to your .qml file:

import QtQml.DesignSupport

The QML API of Qt Qml Design Support module provides the types required for registering QML objects and referencing registered QML objects.

C++ API

Using a Qt module's C++ API requires linking against the module library, either directly or through other dependencies. Several build tools have dedicated support for this, including CMake and qmake.

The C++ API of Qt Qml Design Support module provides the classes required for referencing registered QML objects.

Building with CMake

Use the find_package() command to locate the needed module component in the Qt6 package:

find_package(Qt6 REQUIRED COMPONENTS QmlDesignSupport)
target_link_libraries(mytarget PRIVATE Qt6::QmlDesignSupport)

For more details, see the Build with CMake overview.

Building with qmake

To configure the module for building with qmake, add the module as a value of the QT variable in the project's .pro file:

QT += qmldesignsupport

API Reference

• C++ Classes
• QML Types

Licenses and Attributions

Qt Qml Design Support is available under commercial licenses from The Qt Company. In addition, it is available under the GNU Lesser General Public License, version 3, or the GNU General Public License, version 2. See Qt Licensing for further details.