aboutsummaryrefslogtreecommitdiffstats
path: root/sources/pyside6/doc/extras/QtQml.rst
blob: 9d20ee71aa2588cb892d696060dd33fcd1692d5c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
The Qt Qml module implements the QML language and offers APIs to register types
for it.

The Qt Qml module provides a framework for developing applications and
libraries with the :ref:`The-QML-Reference` . It defines and implements the
language and engine infrastructure, and provides an API to enable application
developers to register custom QML types and modules and integrate QML code with
JavaScript and Python. The Qt Qml module provides both a QML API a Python API.

Using the Module
^^^^^^^^^^^^^^^^

To include the definitions of modules classes, use the following
directive:

::

    import PySide6.QtQml

Registering QML Types and QML Modules
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

See :ref:`tutorial_qmlintegration`.

Tweaking the engine
^^^^^^^^^^^^^^^^^^^

There are a number of knobs you can turn to customize the behavior of the QML
engine. The page on :ref:`Configuring-the-JavaScript-Engine` lists the
environment variables you may use to this effect. The description of
:ref:`The-QML-Disk-Cache` describes the options related to how your QML
components are compiled and loaded.