Qt Quick Tools and Utilities
Qt offers several tools and utilities to enable a rich developer experience, especially for Qt Quick developers. The following sections provide a brief introduction to those tools and utilities, and provide links to further information about them.
The Qt Quick Designer enables designing Qt Quick-based UIs using simple drag-n-drop gestures that most designers are familiar with. It offers UI elements from the Qt Quick and Qt Quick Controls modules, as well as integration for custom UI elements.
The following is a list of example applications that use UIs created by the Qt Quick Designer:
Being a declarative language, a piece of QML code provides minimal details about the entities defined. In such a scenario, the QML debugger is a very useful utility that enables:
- and inspecting QML properties.
QmlLive is a 3rd party tool that offers a QML runtime capable of rendering changes to the code in realtime. It avoids the need to rebuild the application after every code change and install it on the target device. You can also extend it to build a custom runtime that suits your needs.
GammaRay is a useful utility that provides diagnostic information about your application. It is similar to the QML Profiler described in the earlier section, but offers a lot more. For example, the number of items or QObjects created, function calls made, time taken by each function call, property value introspection at runtime, and so on. Such information is very handy, especially while debugging QML applications.
Squish is a well-known testing tool that automates UI testing by recording your actions or running scripts. Once the tests are setup, UI tests are a lot easier to run.
The Qt Creator IDE is the key tool that enhances the overall developer experience of working with Qt Quick. Its auto-completion and debugging features make working with Qt Quick easier. Besides this, most of the tools and utilities mentioned in the earlier sections are integrated into it, with the possibility of integrating 3rd party tools such as QmlLive and GammaRay.
qmllint is a tool shipped with Qt, that verifies the syntatic validity of QML files. It also warns about some QML anti-patterns. If you want to disable a specific warning type, you can find the appropriate flag for doing so by passing
--help on the command line.
qmllint warns about
- Unqualified accesses of properties.
- Usage of signal handlers without a matching signal.
- Usage of with statements in QML.
In order for qmllint to work properly, it requires type information. That information is provided by qmltypes files. qmltypes files in the current directory, as well as those for Qt's built-in types, are discovered automatically. For qmltypes files from libraries that reside outside of the current directory, you can provide their path via the -I flag.
qmlformat is a tool that automatically formats QML files in accordance with the QML Coding Conventions.
The tool groups all properties, functions, and signals together, instead of retaining the order you specified.
Imports will also be sorted in alphabetical order. This can be disabled by specifying the
By default, qmlformat writes the formatted version of the file to stdout. If you wish to have your file updated in-place specify the
See also QML Coding Conventions.
© 2021 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.