diff options
| author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2024-12-11 15:50:45 +0100 |
|---|---|---|
| committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2024-12-13 15:29:11 +0100 |
| commit | bbece3cb15bf92463cc18a2f14672175fbd7bedd (patch) | |
| tree | 1f8a9e2f7ececda5e1d5b792f18f2bb00c58d66b /sources/pyside6/doc/extras/QtQml.rst | |
| parent | e8192898ea3d5a9987a24b3ec4c7ca5c9ea8fdfe (diff) | |
Documentation: Update QtQml/QtQuick modules
Task-number: PYSIDE-1106
Pick-to: 6.8
Change-Id: If09bf185c5fa23c2866bab23c7bd9570828000c1
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Diffstat (limited to 'sources/pyside6/doc/extras/QtQml.rst')
| -rw-r--r-- | sources/pyside6/doc/extras/QtQml.rst | 75 |
1 files changed, 17 insertions, 58 deletions
diff --git a/sources/pyside6/doc/extras/QtQml.rst b/sources/pyside6/doc/extras/QtQml.rst index 7a12bfb68..9d20ee71a 100644 --- a/sources/pyside6/doc/extras/QtQml.rst +++ b/sources/pyside6/doc/extras/QtQml.rst @@ -1,20 +1,11 @@ -The Qt QML module defines and implements the QML language +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 QML language. It defines and implements the language and -engine infrastructure, and provides an API to enable application developers to -extend the QML language with custom types and integrate QML code with -JavaScript and C++. The Qt QML module provides both a `QML API -<https://doc.qt.io/qt-6/qtqml-qmlmodule.html>`_ and a `C++ API -<https://doc.qt.io/qt-6/qtqml-module.html>`_ . - -Note that while the Qt QML module provides the language and infrastructure for -QML applications, the :ref:`Qt Quick<Qt-Quick>` module provides many visual -components, model-view support, an animation framework, and much more for -building user interfaces. - -For those new to QML and Qt Quick, please see QML Applications for an -introduction to writing QML applications. +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 ^^^^^^^^^^^^^^^^ @@ -26,48 +17,16 @@ directive: import PySide6.QtQml -QML and QML Types -^^^^^^^^^^^^^^^^^ - -The Qt QML module contains the QML framework and important QML types used in -applications. The constructs of QML are described in the -:ref:`The QML Reference<The-QML-Reference>` . - -In addition to the :ref:`QML Basic Types<QML-Basic-Types>` , the module comes -with the following QML object types: - - * `Component <https://doc.qt.io/qt-6/qml-qtqml-component.html>`_ - * `QtObject <https://doc.qt.io/qt-6/qml-qtqml-qtobject.html>`_ - * `Binding <https://doc.qt.io/qt-6/qml-qtqml-binding.html>`_ - * `Connections <https://doc.qt.io/qt-6/qml-qtqml-connections.html>`_ - * `Timer <https://doc.qt.io/qt-6/qml-qtqml-timer.html>`_ - -The `Qt <https://doc.qt.io/qt-6/qml-qtqml-qt.html>`_ global object provides -useful enums and functions for various QML types. - -Lists and Models -^^^^^^^^^^^^^^^^ - -New in Qt 5.1, the model types are moved to a submodule, ``QtQml.Models``\. The -Qt QML Models page has more information. - - * DelegateModel - * DelegateModelGroup - * ListElement - * ListModel - * ObjectModel - -JavaScript Environment for QML Applications -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Registering QML Types and QML Modules +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -JavaScript expressions allow QML code to contain application logic. Qt QML -provides the framework for running JavaScript expressions in QML and from C++. +See :ref:`tutorial_qmlintegration`. -These sections are from :ref:`The QML Reference<The-QML-Reference>` . +Tweaking the engine +^^^^^^^^^^^^^^^^^^^ - * `Integrating QML and JavaScript <https://doc.qt.io/qt-6/qtqml-javascript-topic.html>`_ - * `Using JavaScript Expressions with QML <https://doc.qt.io/qt-6/qtqml-javascript-expressions.html>`_ - * `Dynamic QML Object Creation from JavaScript <https://doc.qt.io/qt-6/qtqml-javascript-dynamicobjectcreation.html>`_ - * `Defining JavaScript Resources In QML <https://doc.qt.io/qt-6/qtqml-javascript-resources.html>`_ - * `Importing JavaScript Resources In QML <https://doc.qt.io/qt-6/qtqml-javascript-imports.html>`_ - * `JavaScript Host Environment <https://doc.qt.io/qt-6/qtqml-javascript-hostenvironment.html>`_ +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. |