Despite all of the benefits that QML and Qt Quick offer, they can be challenging in certain situations. The following sections elaborate on some of the best practices that will help you get better results when developing applications.
A fluid and modern UI is key for any application's success in today's world, and that's where QML makes so much sense for a designer or developer. Qt offers the most basic UI controls that are necessary to create a fluid and modern-looking UI. It is recommended to browse this list of UI controls before creating your own custom UI control.
Besides these basic UI controls offered by Qt Quick itself, a rich set of UI controls are also available with Qt Quick Controls. They cater to the most common use cases without any change, and offer a lot more possibilities with their customization options. In particular, Qt Quick Controls provides styling options that align with the latest UI design trends. If these UI controls do not satisfy your application's needs, only then it is recommended to create a custom control.
You can use the controls when you design UIs in Qt Design Studio. In addition, it provides timeline-based animations, visual effects, layouts, and a live-preview for prototyping applications.
Most applications depend on resources such as images and icons to provide a rich user experience. It can often be a challenge to make these resources available to the application regardless of the target OS. Most popular OS-es employ stricter security policies that restrict access to the file system, making it harder to load these resources. As an alternative, Qt offers its own resource system that is built into the application binary, enabling access to the application's resources regardless of the target OS.
For example, consider the following project directory structure:
MyModule ├── images │ ├── image1.png │ └── image2.png ├── CMakeLists.txt └── main.qml
You may represent this structure as a CMake QML Module in the following way:
qt_add_qml_module(my_module URI MyModule VERSION 1.0 QML_FILES main.qml RESOURCES images/image1.png images/image2.png # ... )
All QML files listed under QML_FILES will automatically get compiled ahead of time.
You should keep the QML files in the same directory as the CMakeLists.txt with the qt_add_qml_module. Otherwise their implicit imports will be different from the QML Modules they belong to. This is a frequent source of mistakes.
One of the key goals that most application developers want to achieve is to create a maintainable application. One of the ways to achieve this goal is to separate the user interface from the business logic. The following are a few reasons why an application's UI should be written in QML:
Being a strongly typed language, C++ is best suited for an application's business logic. Typically, such code performs tasks such as complex calculations or data processing, which are faster in C++ than QML.
Qt offers various approaches to integrate QML and C++ code in an application. A typical use case is displaying a list of data in a user interface. If the data set is static, simple, and/or small, a model written in QML can be sufficient.
The following snippet demonstrates examples of models written in QML:
model: [ "Item 1", "Item 2", "Item 3" ] model: 10
Use C++ for dynamic data sets that are large or frequently modified.
Refactoring QML is a lot easier than refactoring C++, so in order to make maintenance pain-free, we should strive to keep C++ types unaware of QML as much as possible. This can be achieved by "pushing" references to C++ types into QML.
This can be done by using required properties and setting them via QQmlApplicationEngine::setInitialProperties. It is also possible to create one or multiple singletons which will return all the data the C++ side wants to provide to QML.
With this approach, the C++ remains unchanged in the event that the QML needs to be refactored in the future.
For a quick guide to choosing the correct approach to expose C++ types to QML, see Choosing the Correct Integration Method Between C++ and QML.
Qt Design Studio uses UI files that have the filename extension .ui.qml to separate the visual parts of the UI from the UI logic you implement in .qml files. You should edit UI files only in the 2D view in Qt Design Studio. If you use some other tool to add code that Qt Design Studio does not support, it displays error messages. Fix the errors to enable visual editing of the UI files again. Typically, you should move the unsupported code to a .qml file.
See Avoid Storing State in Delegates.
Qt offers Qt Quick Layouts to arrange Qt Quick items visually in a layout. Unlike its alternative, the item positioners, the Qt Quick Layouts can also resize its children on window resize. Although Qt Quick Layouts are often the desired choice for most use cases, the following dos and don'ts must be considered while using them:
Layout.preferredWidth and Layout.preferredHeight:
RowLayout { id: layout anchors.fill: parent spacing: 6 Rectangle { color: 'orange' Layout.fillWidth: true Layout.minimumWidth: 50 Layout.preferredWidth: 100 Layout.maximumWidth: 300 Layout.minimumHeight: 150 Text { anchors.centerIn: parent text: parent.width + 'x' + parent.height } } Rectangle { color: 'plum' Layout.fillWidth: true Layout.minimumWidth: 100 Layout.preferredWidth: 200 Layout.preferredHeight: 100 Text { anchors.centerIn: parent text: parent.width + 'x' + parent.height } } }
Note: Layouts and anchors are both types of objects that take more memory and instantiation time. Avoid using them (especially in list and table delegates, and styles for controls) when simple bindings to x, y, width, and height properties are enough.
When declaring properties in QML, it's easy and convenient to use the "var" type:
property var name property var size property var optionsMenu
However, this approach has several disadvantages:
Instead, always use the actual type where possible:
property string name
property int size
property MyMenu optionsMenu
Prefer using the explicit interaction signals over the value changed signals to avoid subtle bugs.
Using valueChanged can lead to event cascades where the value is constantly changed because it is somehow rounded or normalized.
Using explicit interaction signals alone avoids this whole class of issues.
For example, Slider has these similar signals: moved and valueChanged.
Slider { value: someValueFromBackend onValueChanged: pushToBackend(value) // or onMoved: pushToBackend(value) }
Both cases look similar, and you may want to use valueChanged.
Developers often overlook the fact that the Slider can automatically change its value, for example, because of clamping to minimum/maximum values or rounding. In this case,
the valueChanged signal is emitted. If you use the valueChanged signal, you may notice it is emitted at unexpected moments.
To avoid possible issues, use an interaction signal: the signal that is emitted when user interacts with the control. In this example, if you use the moved signal, the slot will only be triggered if the user changes the control.
For information on performance in QML and Qt Quick, see QML Performance Considerations And Suggestions.
In QML, it's possible to use imperative JavaScript code to perform tasks such as responding to input events, send data over a network, and so on. Imperative code has an important place in QML, but it's also important to be aware of when not to use it.
For example, consider the following imperative assignment:
Rectangle {
Component.onCompleted: color = "red"
}
This has the following disadvantages:
The code can be rewritten to be a declarative binding instead:
Rectangle {
color: "red"
}
Don't store a state in a delegate. The issue here is that the delegate is created and destroyed multiple times, so the saved state will be lost.
// Wrong approach: ListView { // ... delegate: Button { // ... property bool someStateProperty onClicked: someStateProperty = true } }
Instead, store the state outside of the delegate. For example, in a model. When the delegate is destroyed, the saved state is not lost.
// Right approach: ListView { // ... delegate: Button { // ... onClicked: model.someStateProperty = true } }
It is recommended to make user-facing strings translatable from the beginning. See Writing Source Code for Translation.
ToolButton { id: selectionToolButton // ... icon.source: "qrc:/images/selection.png" Tooltip.Text: qsTr("Select pixels within an area and move them") onClicked: canvas.tool = ImageCanvas.SelectionTool }
Native styles (Windows and macOS styles) don't support customization. Ensure you don't customize a native style.
// Wrong approach: import QtQuick.Controls.Windows // Don't customize a native style Button { background: Rectangle { /*...*/ } }
It is instead recommended to always base a customized control on top of a single style that is available on all platforms, e.g Basic Style, Fusion Style, Imagine Style, Material Style, Universal Style. By doing so, you are guaranteed that it will always look the same, regardless of which style the application is run with. To learn how to use a different style, see Using Styles in Qt Quick Controls. Alternatively, you can create your own style.
// Right approach: import QtQuick.Controls.Basic // You can customize a commonly available style Button { background: Rectangle { /*...*/ } }
For information on useful tools and utilies that make working with QML and Qt Quick easier, see Qt Quick Tools and Utilities.
For information on Qt Quick's scene graph, see Qt Quick Scene Graph.
As display resolutions improve, a scalable application UI becomes more and more important. One of the approaches to achieve this is to maintain several copies of the UI for different screen resolutions, and load the appropriate one depending on the available resolution. Although this works pretty well, it adds to the maintenance overhead.
Qt offers a better solution to this problem and recommends the application developers to follow these tips:
qt-logo.png for @2x, @3x, and @4x resolutions, enabling the application to cater to high resolution displays. Qt automatically
chooses the appropriate image that is suitable for the given display, provided the high DPI scaling feature is explicitly enabled.With this in place, your application's UI should scale depending on the display resolution on offer.
