PySide6.QtQml¶

Detailed Description¶

The Qt QML module defines and implements the QML language

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 and a C++ API .

Note that while the Qt QML module provides the language and infrastructure for QML applications, the 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.

Using the Module¶

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

import PySide6.QtQml

The module also provides QML types .

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 The QML Reference .

In addition to the QML Basic Types , the module comes with the following QML object types:

Component

QtObject

Binding

Connections

Timer

The Qt 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¶

JavaScript expressions allow QML code to contain application logic. Qt QML provides the framework for running JavaScript expressions in QML and from C++.

These sections are from The QML Reference .

Integrating QML and JavaScript

Using JavaScript Expressions with QML

Dynamic QML Object Creation from JavaScript

Defining JavaScript Resources In QML

Importing JavaScript Resources In QML

JavaScript Host Environment

List of Decorators¶

Q	`@QmlAnonymous`	`@QmlAttached`	`@QmlElement`
	`@QmlExtended`	`@QmlForeign`	`@QmlNamedElement`
	`@QmlSingleton`	`@QmlUncreatable`

List of Functions¶

Q	`qjsEngine()`	`qmlClearTypeRegistrations()`	`qmlContext()`
	`qmlEngine()`	`qmlProtectModule()`	`qmlRegisterModule()`
	`qmlRegisterSingletonType()`	`qmlRegisterType()`	`qmlRegisterUncreatableMetaObject()`
	`qmlTypeId()`	`qmlAttachedPropertiesObject()`	`qmlRegisterSingletonInstance()`
	`qmlRegisterUncreatableType()`

List of Enumerations¶

M	`QML_HAS_ATTACHED_PROPERTIES`
Q	`QQmlModuleImportSpecialVersions`

J	`QJSEngine`	`QJSManagedValue`	`QJSPrimitiveValue`
	`QJSValue`	`QJSValueIterator`
L	`ListProperty`
P	`PropertyPair`	`QPyQmlParserStatus`	`QPyQmlPropertyValueSource`
Q	`QQmlAbstractUrlInterceptor`	`QQmlApplicationEngine`	`QQmlComponent`
	`QQmlContext`	`QQmlDebuggingEnabler`	`QQmlEngine`
	`QQmlError`	`QQmlExpression`	`QQmlExtensionInterface`
	`QQmlExtensionPlugin`	`QQmlFile`	`QQmlFileSelector`
	`QQmlImageProviderBase`	`QQmlIncubationController`	`QQmlIncubator`
	`QQmlListReference`	`QQmlNetworkAccessManagerFactory`	`QQmlParserStatus`
	`QQmlProperty`	`QQmlPropertyMap`	`QQmlPropertyValueSource`
	`QQmlScriptString`	`QQmlTypesExtensionInterface`