Crate qt_qml

This crate was generated by ritual. See README for more information.

Re-exports

pub use ::cpp_core;

pub use ::qt_core;

pub use ::qt_gui;

Modules

ops

Functions that provide access to C++ operators

q_j_s_engine

C++ type: QJSEngine

q_j_s_value

C++ type: QJSValue

q_list_of_q_j_s_value

C++ type: QList<QJSValue>

q_list_of_q_qml_error

C++ type: QList<QQmlError>

q_qml_abstract_url_interceptor

C++ type: QQmlAbstractUrlInterceptor

q_qml_component

C++ type: QQmlComponent

q_qml_context

C++ type: QQmlContext

q_qml_debugging_enabler

C++ type: QQmlDebuggingEnabler

q_qml_engine

C++ type: QQmlEngine

q_qml_file

C++ type: QQmlFile

q_qml_image_provider_base

C++ type: QQmlImageProviderBase

q_qml_incubator

C++ type: QQmlIncubator

q_qml_property

C++ type: QQmlProperty

q_v4

C++ namespace: QV4

qt_qml

C++ namespace: QtQml

Structs

QJSEngine

QJSValue

QJSValue supports the types defined in the ECMA-262 standard: The primitive types, which are Undefined, Null, Boolean, Number, and String; and the Object and Array types. Additionally, built-in support is provided for Qt/C++ types such as QVariant and QObject.

QJSValueIterator

The QJSValueIterator constructor takes a QJSValue as argument. After construction, the iterator is located at the very beginning of the sequence of properties. Here's how to iterate over all the properties of a QJSValue:

QListOfQJSValue

The QList class is a template class that provides lists.

QListOfQQmlError

The QList class is a template class that provides lists.

QPointerOfQObject

The QPointer class is a template class that provides guarded pointers to QObject.

QQmlAbstractUrlInterceptor

QQmlAbstractUrlInterceptor is an interface which can be used to alter URLs before they are used by the QML engine. This is primarily useful for altering file urls into other file urls, such as selecting different graphical assets for the current platform.

QQmlApplicationEngine

This class combines a QQmlEngine and QQmlComponent to provide a convenient way to load a single QML file. It also exposes some central application functionality to QML, which a C++/QML hybrid application would normally control from C++.

QQmlComponent

Components are reusable, encapsulated QML types with well-defined interfaces.

QQmlContext

Contexts allow data to be exposed to the QML components instantiated by the QML engine.

QQmlDebuggingEnabler

C++ class: QQmlDebuggingEnabler.

QQmlEngine

Each QML component is instantiated in a QQmlContext. QQmlContext's are essential for passing data to QML components. In QML, contexts are arranged hierarchically and this hierarchy is managed by the QQmlEngine.

QQmlError

QQmlError includes a textual description of the error, as well as location information (the file, line, and column). The toString() method creates a single-line, human-readable string containing all of this information, for example:

QQmlExpression

For example, given a file main.qml like this:

QQmlExtensionInterface

C++ class: QQmlExtensionInterface.

QQmlExtensionPlugin

QQmlExtensionPlugin is a plugin interface that makes it possible to create QML extensions that can be loaded dynamically into QML applications. These extensions allow custom QML types to be made available to the QML engine.

QQmlFile

C++ class: QQmlFile.

QQmlFileSelector

QQmlFileSelector will automatically apply a QFileSelector to qml file and asset paths.

QQmlImageProviderBase

Image providers must be registered with the QML engine. The only information the QML engine knows about image providers is the type of image data they provide. To use an image provider to acquire image data, you must cast the QQmlImageProviderBase pointer to a QQuickImageProvider pointer.

QQmlIncubationController

In order to behave asynchronously and not introduce stutters or freezes in an application, the process of creating objects a QQmlIncubators must be driven only during the application's idle time. QQmlIncubationController allows the application to control exactly when, how often and for how long this processing occurs.

QQmlIncubator

Creating QML objects - like delegates in a view, or a new page in an application - can take a noticeable amount of time, especially on resource constrained mobile devices. When an application uses QQmlComponent::create() directly, the QML object instance is created synchronously which, depending on the complexity of the object, can cause noticeable pauses or stutters in the application.

QQmlInfo

C++ class: QQmlInfo.

QQmlListReference

QQmlListReference allows C++ programs to read from, and assign values to a QML list property in a simple and type-safe way. A QQmlListReference can be created by passing an object and property name or through a QQmlProperty instance. These two are equivalent:

QQmlNetworkAccessManagerFactory

A QML engine uses QNetworkAccessManager for all network access. By implementing a factory, it is possible to provide the QML engine with custom QNetworkAccessManager instances with specialized caching, proxy and cookies support.

QQmlParserStatus

QQmlParserStatus provides a mechanism for classes instantiated by a QQmlEngine to receive notification at key points in their creation.

QQmlProperty

As QML uses Qt's meta-type system all of the existing QMetaObject classes can be used to introspect and interact with objects created by QML. However, some of the new features provided by QML - such as type safety and attached properties - are most easily used through the QQmlProperty class that simplifies some of their natural complexity.

QQmlPropertyMap

QQmlPropertyMap provides a convenient way to expose domain data to the UI layer. The following example shows how you might declare data in C++ and then access it in QML.

QQmlPropertyValueSource

See Property Value Sources for information on writing custom property value sources.

QQmlScriptString

QQmlScriptString is used to create QObject properties that accept a script "assignment" from QML.

QQmlTypesExtensionInterface

C++ class: QQmlTypesExtensionInterface.

QVectorOfPropertyPair

The QVector class is a template class that provides a dynamic array.

SignalOfQListOfQQmlError

Emits a Qt signal with arguments *const crate::QListOfQQmlError.

SignalOfQObjectQUrl

Emits a Qt signal with arguments *mut ::qt_core::QObject,*const ::qt_core::QUrl.

SignalOfQStringQVariant

Emits a Qt signal with arguments *const ::qt_core::QString,*const ::qt_core::QVariant.

SignalOfStatus

Emits a Qt signal with arguments crate::q_qml_component::Status.

SlotOfQListOfQQmlError

Binds a Qt signal with arguments *const crate::QListOfQQmlError to a Rust closure.

SlotOfQObjectQUrl

Binds a Qt signal with arguments *mut ::qt_core::QObject,*const ::qt_core::QUrl to a Rust closure.

SlotOfQStringQVariant

Binds a Qt signal with arguments *const ::qt_core::QString,*const ::qt_core::QVariant to a Rust closure.

SlotOfStatus

Binds a Qt signal with arguments crate::q_qml_component::Status to a Rust closure.

Functions

q_hash_option_fn^⚠cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0"

Calls C++ function: unsigned int qHash(QObject * (*FN_PTR)(QObject *) func).

q_hash_option_fn_uint^⚠cpp_lib_version="5.13.0" or cpp_lib_version="5.14.0"

Calls C++ function: unsigned int qHash(QObject * (*FN_PTR)(QObject *) func, unsigned int seed = …).

q_hash_q_qml_property^⚠

Calls C++ function: unsigned int qHash(const QQmlProperty& key).

q_pointer_from_variant_q_object^⚠

Calls C++ function: QPointer<QObject> qPointerFromVariant<QObject>(const QVariant& variant).

qjs_engine^⚠

Calls C++ function: QJSEngine* qjsEngine(const QObject* arg1).

qjsvalue_cast_helper^⚠

Calls C++ function: bool qjsvalue_cast_helper(const QJSValue& value, int type, void* ptr).

qml_clear_type_registrations^⚠

Clears all stored type registrations, such as those produced with qmlRegisterType().

qml_protect_module^⚠

This function protects a module from having types registered into it. This can be used to prevent other plugins from injecting types into your module. It can also be a performance improvement, as it allows the engine to skip checking for the possibility of new types or plugins when this import is reached.

qml_register_module^⚠

This function registers a module in a particular uri with a version specified in versionMajor and versionMinor.

qml_register_singleton_type^⚠

This function may be used to register a singleton type with the name qmlName, in the library imported from uri having the version number composed from versionMajor and versionMinor. The type is defined by the QML file located at url. The url must be an absolute URL, i.e. url.isRelative() == false.

qml_register_type^⚠

This function registers a type in the QML system with the name qmlName, in the library imported from uri having the version number composed from versionMajor and versionMinor. The type is defined by the QML file located at url. The url must be an absolute URL, i.e. url.isRelative() == false.

qml_register_type_not_available^⚠

This function registers a type in the QML system with the name qmlName, in the type namespace imported from uri having the version number composed from versionMajor and versionMinor, but any attempt to instantiate the type will produce the given error message.

qml_register_uncreatable_meta_object^⚠

This function registers the staticMetaObject and its extension in the QML system with the name qmlName in the library imported from uri having version number composed from versionMajor and versionMinor.

qml_type_id^⚠cpp_lib_version="5.13.0" or cpp_lib_version="5.12.2" or cpp_lib_version="5.14.0"

Returns the QML type id of a type that was registered with the name qmlName in a particular uri and a version specified in versionMajor and versionMinor.