PySide6.QtQml¶

Detailed Description¶

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 Qt-Qml custom QML types and modules and integrate QML code with JavaScript and Python. The Qt Qml module provides both a QML API and 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 Python-QML integration.

Tweaking the engine¶

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

Articles and Guides¶

These articles contain information about Qt Qml.

List of QML types¶

QtQml QML Types

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`