Struct QmlEngine

#[repr(C)]
pub struct QmlEngine { /* private fields */ }

Wrap a Qt Application and a QmlEngine

Note that since there can only be one Application in the process, creating two QmlEngine at the same time is not allowed. Doing that will panic.

Implementations

impl QmlEngine

pub fn new() -> QmlEngine

Create a new QmlEngine

pub fn load_file(&mut self, path: QString)

Loads a file as a qml file (See QQmlApplicationEngine::load(const QString & filePath))

pub fn load_url(&mut self, url: QUrl)

Loads the root QML file located at url (See QQmlApplicationEngine::load(const QUrl &url))

pub fn load_data(&mut self, data: QByteArray)

Loads qml data (See QQmlApplicationEngine::loadData)

pub fn load_data_as(&mut self, data: QByteArray, url: QUrl)

Loads qml data with url as base url component (See QQmlApplicationEngine::loadData)

pub fn exec(&self)

Launches the application

pub fn quit(&self)

Closes the application

pub fn set_property(&mut self, name: QString, value: QVariant)

Sets a property for this QML context (calls QQmlEngine::rootContext()->setContextProperty)

pub fn set_object<T: QObject + Sized>(&mut self, obj: QObjectPinned<'_, T>)

Sets an object for this QML context (calls QQmlEngine::rootContext()->setContextObject)

pub fn set_object_property<T: QObject + Sized>( &mut self, name: QString, obj: QObjectPinned<'_, T>, )

Sets a property for this QML context (calls QQmlEngine::rootContext()->setContextProperty)

pub fn invoke_method(&mut self, name: QByteArray, args: &[QVariant]) -> QVariant

pub fn invoke_method_noreturn(&mut self, name: QByteArray, args: &[QVariant])

This method is the same as [invoke_method] but does not capture or return function’s return value

pub fn trim_component_cache(&self)

pub fn clear_component_cache(&self)

pub fn new_qobject<T: QObject>(&mut self, obj: T) -> QJSValue

Give a QObject to the engine by wrapping it in a QJSValue

This will create the C++ object. Panic if the C++ object was already created.

pub fn add_import_path(&mut self, path: QString)

Adds an import path for this QML engine (calls QQmlEngine::addImportPath)

pub fn cpp_ptr(&self) -> *mut c_void

Returns a pointer to the C++ object. The pointer is of the type QQmlEngine * in C++.

Trait Implementations

impl Drop for QmlEngine

fn drop(&mut self)

Executes the destructor for this type.