Python-QML integration¶

This tutorial provides a quick walk-through of a python application that loads, and interacts with a QML file. QML is a declarative language that lets you design UIs faster than a traditional language, such as C++. The QtQml and QtQuick modules provides the necessary infrastructure for QML-based UIs.

In this tutorial, you will learn how to integrate Python with a QML application. This mechanism will help us to understand how to use Python as a backend for certain signals from the UI elements in the QML interface. Additionally, you will learn how to provide a modern look to your QML application using one of the features from Qt Quick Controls 2.

The tutorial is based on an application that allow you to set many text properties, like increasing the font size, changing the color, changing the style, and so on. Before you begin, install the PySide6 Python packages.

The following step-by-step process will guide you through the key elements of the QML based application and PySide6 integration:

First, let’s start with the following QML-based UI:

The design is based on a GridLayout, containing two ColumnLayout. Inside the UI you will find many RadioButton, Button, and a Slider.

With the QML file in place, you can load it from Python:

if __name__ == '__main__':
    app = QGuiApplication(sys.argv)
    QQuickStyle.setStyle("Material")
    engine = QQmlApplicationEngine()
    # Add the current directory to the import paths and load the main module.
    engine.addImportPath(sys.path[0])
    engine.loadFromModule("QmlIntegration", "Main")

    if not engine.rootObjects():
        sys.exit(-1)

    exit_code = app.exec()
    del engine
    sys.exit(exit_code)

Notice that we only need a QQmlApplicationEngine to load the QML file.

Define the Bridge class, containing all the logic for the element that will be register in QML:

# To be used on the @QmlElement decorator
# (QML_IMPORT_MINOR_VERSION is optional)
QML_IMPORT_NAME = "io.qt.textproperties"
QML_IMPORT_MAJOR_VERSION = 1


@QmlElement
class Bridge(QObject):

    @Slot(str, result=str)
    def getColor(self, s):
        if s.lower() == "red":
            return "#ef9a9a"
        if s.lower() == "green":
            return "#a5d6a7"
        if s.lower() == "blue":
            return "#90caf9"
        return "white"

    @Slot(float, result=int)
    def getSize(self, s):
        size = int(s * 34)
        return max(1, size)

    @Slot(str, result=bool)
    def getItalic(self, s):
        return s.lower() == "italic"

    @Slot(str, result=bool)
    def getBold(self, s):
        return s.lower() == "bold"

    @Slot(str, result=bool)
    def getUnderline(self, s):
        return s.lower() == "underline"

Notice that the registration happens thanks to the QmlElement decorator, that underneath uses the reference to the Bridge class and the variables QML_IMPORT_NAME and QML_IMPORT_MAJOR_VERSION.

Now, go back to the QML file and connect the signals to the slots defined in the Bridge class:
```
Bridge {
   id: bridge
}
```
Inside the ApplicationWindow we declare a component with the same name as the Python class, and provide an id:. This id will help you to get a reference to the element that was registered from Python.
```
 1            RadioButton {
 2                id: italic
 3                Layout.alignment: Qt.AlignLeft
 4                text: "Italic"
 5                onToggled: {
 6                    leftlabel.font.italic = bridge.getItalic(italic.text)
 7                    leftlabel.font.bold = bridge.getBold(italic.text)
 8                    leftlabel.font.underline = bridge.getUnderline(italic.text)
 9
10                }
11            }
```
The properties Italic, Bold, and Underline are mutually exclusive, this means only one can be active at any time. To achieve this each time we select one of these options, we check the three properties via the QML element property as you can see in the above snippet. Only one of the three will return True, while the other two will return False, that is how we make sure only one is being applied to the text.
Put the file into into a directory named QmlIntegration along with a file named qmldir to describe a basic QML module:
```
module QmlIntegration
Main 254.0 Main.qml
```
Each slot verifies if the selected option contains the text associated to the property:
```
1    @Slot(str, result=bool)
2    def getBold(self, s):
3        return s.lower() == "bold"
```
Returning True or False allows you to activate and deactivate the properties of the QML UI elements.

It is also possible to return other values that are not Boolean, like the slot in charge of returning the font size:
```
1    @Slot(float, result=int)
2    def getSize(self, s):
3        size = int(s * 34)
4        return max(1, size)
```

Now, for changing the look of our application, you have two options:

Use the command line: execute the python file adding the option, --style:
```
python main.py --style material
```

Use a qtquickcontrols2.conf file:

[Controls]
Style=Material

[Universal]
Theme=System
Accent=Red

[Material]
Theme=Dark
Accent=Red

Then add it to your .qrc file:

<!DOCTYPE RCC><RCC version="1.0">
<qresource prefix="/">
    <file>qtquickcontrols2.conf</file>
</qresource>
</RCC>

Generate the rc file running, pyside6-rcc style.qrc -o rc_style.py And finally import it from your main.py script.

import sys

from PySide6.QtCore import QObject, Slot
from PySide6.QtGui import QGuiApplication
from PySide6.QtQml import QQmlApplicationEngine, QmlElement
from PySide6.QtQuickControls2 import QQuickStyle

import rc_style  # noqa F401

You can read more about this configuration file here.

The final look of your application will be:

../../_images/textproperties_material.png

You can download Main.qml, qmldir and main.py to try this example.