QQmlApplicationEngine Class

 #include <QGuiApplication>
 #include <QQmlApplicationEngine>

 int main(int argc, char *argv[])
 {
     QGuiApplication app(argc, argv);
     QQmlApplicationEngine engine("main.qml");
     return app.exec();
 }

Member Function Documentation

QQmlApplicationEngine::QQmlApplicationEngine(const QString &filePath, QObject *parent = nullptr)

Create a new QQmlApplicationEngine and loads the QML file at the given filePath, which must be a local file path. If a relative path is given then it will be interpreted as relative to the working directory of the application.

This is provided as a convenience, and is the same as using the empty constructor and calling load afterwards.

QQmlApplicationEngine::QQmlApplicationEngine(const QUrl &url, QObject *parent = nullptr)

Create a new QQmlApplicationEngine and loads the QML file at the given url. This is provided as a convenience, and is the same as using the empty constructor and calling load afterwards.

QQmlApplicationEngine::QQmlApplicationEngine(QObject *parent = nullptr)

Create a new QQmlApplicationEngine with the given parent. You will have to call load() later in order to load a QML file.

[slot] void QQmlApplicationEngine::load(const QString &filePath)

Loads the root QML file located at filePath. filePath must be a path to a local file. If filePath is a relative path, it is taken as relative to the application's working directory. The object tree defined by the file is instantiated immediately.

If an error occurs, error messages are printed with qWarning.

[slot] void QQmlApplicationEngine::load(const QUrl &url)

Loads the root QML file located at url. The object tree defined by the file is created immediately for local file urls. Remote urls are loaded asynchronously, listen to the objectCreated signal to determine when the object tree is ready.

If an error occurs, the objectCreated signal is emitted with a null pointer as parameter and error messages are printed with qWarning.

[slot] void QQmlApplicationEngine::loadData(const QByteArray &data, const QUrl &url = QUrl())

Loads the QML given in data. The object tree defined by data is instantiated immediately.

If a url is specified it is used as the base url of the component. This affects relative paths within the data and error messages.

If an error occurs, error messages are printed with qWarning.

[signal] void QQmlApplicationEngine::objectCreated(QObject *object, const QUrl &url)

This signal is emitted when an object finishes loading. If loading was successful, object contains a pointer to the loaded object, otherwise the pointer is NULL.

The url to the component the object came from is also provided.

[slot] void QQmlApplicationEngine::setInitialProperties(const QVariantMap &initialProperties)

Sets the initialProperties with which the QML component gets initialized after it gets loaded.

 QQmlApplicationEngine engine;

 EventDatabase eventDatabase;
 EventMonitor eventMonitor;

 engine.setInitialProperties({
     { "eventDatabase", QVariant::fromValue(&eventDatabase) },
     { "eventMonitor", QVariant::fromValue(&eventMonitor) }
 });

This function was introduced in Qt 5.14.

See also QQmlComponent::setInitialProperties, QQmlApplicationEngine::load, and QQmlApplicationEngine::loadData.

[override virtual] QQmlApplicationEngine::~QQmlApplicationEngine()

Destroys the QQmlApplicationEngine and all QML objects it loaded.

QList<QObject *> QQmlApplicationEngine::rootObjects() const

Returns a list of all the root objects instantiated by the QQmlApplicationEngine. This will only contain objects loaded via load() or a convenience constructor.