QQmlApplicationEngine Class

メンバ関数のドキュメント

QQmlApplicationEngine::QQmlApplicationEngine(QObject *parent = nullptr)

指定されたparent を使用して、新しいQQmlApplicationEngineを作成します。後でQMLファイルをロードするには、load()を呼び出す必要があります。

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

新しい QQmlApplicationEngine を作成し、指定された `filePath` の QML ファイルをロードします。このパスは、ローカルファイルまたは qrc パスである必要があります。相対パスが指定された場合、アプリケーションの作業ディレクトリを基準とした相対パスとして解釈されます。

これは利便性のために提供されている機能であり、空のコンストラクタを使用し、その後 load を呼び出すのと同じ動作をします。

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

新しい QQmlApplicationEngine を作成し、指定された `url` にある QML ファイルを読み込みます。これは利便性のために提供されている機能であり、空のコンストラクタを使用して、その後 `load` を呼び出すのと同じ動作をします。

[explicit, since 6.5] QQmlApplicationEngine::QQmlApplicationEngine(QAnyStringView uri, QAnyStringView typeName, QObject *parent = nullptr)

新しい QQmlApplicationEngine を作成し、uri およびtypeName で指定された QML タイプを読み込みます。これは利便性を考慮して提供されている機能であり、空のコンストラクタを使用し、その後loadFromModule を呼び出すのと同じ動作をします。

この関数は Qt 6.5 で導入されました。

[override virtual noexcept] QQmlApplicationEngine::~QQmlApplicationEngine()

QQmlApplicationEngine およびそこに読み込まれたすべてのQMLオブジェクトを破棄します。

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

filePath にあるルート QML ファイルを読み込みます。filePath は、ローカルファイルへのパス、またはリソースファイルシステム内のファイルへのパスでなければなりません。filePath が相対パスである場合、アプリケーションの作業ディレクトリを基準とする相対パスとして扱われます。ファイルによって定義されたオブジェクトツリーは直ちにインスタンス化されます。

エラーが発生した場合、qWarning によってエラーメッセージが出力されます。

// Connect using qOverload:
connect(sender, &SenderClass::signal,
        qmlApplicationEngine, qOverload(&QQmlApplicationEngine::load));

// Or using a lambda as wrapper:
connect(sender, &SenderClass::signal,
        qmlApplicationEngine, [receiver = qmlApplicationEngine](const QString &filePath) { receiver->load(filePath); });

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

url にあるルート QML ファイルを読み込みます。ローカルファイルの URL の場合、ファイルで定義されたオブジェクトツリーは即座に作成されます。リモート URL の場合は非同期で読み込まれ、オブジェクトツリーの準備が整ったことを確認するには、objectCreated シグナルを監視してください。

エラーが発生した場合は、objectCreated シグナルがnullポインタをパラメータとして発火され、qWarning を通じてエラーメッセージが出力されます。

// Connect using qOverload:
connect(sender, &SenderClass::signal,
        qmlApplicationEngine, qOverload(&QQmlApplicationEngine::load));

// Or using a lambda as wrapper:
connect(sender, &SenderClass::signal,
        qmlApplicationEngine, [receiver = qmlApplicationEngine](const QUrl &url) { receiver->load(url); });

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

data に指定された QML を読み込みます。data で定義されたオブジェクトツリーは、直ちにインスタンス化されます。

url が指定されている場合、それがコンポーネントのベース URL として使用されます。これは、データおよびエラーメッセージ内の相対パスに影響します。

エラーが発生した場合、qWarning を使用してエラーメッセージが出力されます。

[slot, since 6.5] void QQmlApplicationEngine::loadFromModule(QAnyStringView uri, QAnyStringView typeName)

uri で指定されたモジュールから、QML タイプ `typeName ` を読み込みます。このタイプがリモート URL にある QML ファイルに由来する場合、タイプは非同期で読み込まれます。オブジェクトツリーの準備が完了したタイミングを判断するには、objectCreated シグナルを監視してください。

エラーが発生した場合、objectCreated シグナルがnullポインタをパラメータとして発火され、qWarning を通じてエラーメッセージが出力されます。

QQmlApplicationEngine engine;
engine.loadFromModule("QtQuick", "Rectangle");

この関数はQt 6.5で導入されました。

「QQmlComponent::loadFromModule」も参照してください 。

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

このシグナルは、オブジェクトの読み込みが完了したときに発火します。読み込みが成功した場合、object には読み込まれたオブジェクトへのポインタが含まれますが、失敗した場合はポインタは NULL になります。

また、object が由来するコンポーネントへのurl も提供されます。

[signal, since 6.4] void QQmlApplicationEngine::objectCreationFailed(const QUrl &url)

このシグナルは、エラーが発生したために読み込みが完了した際に発せられます。

読み込みに失敗したコンポーネントへのurl が引数として渡されます。

QGuiApplication app(argc, argv);
QQmlApplicationEngine engine;

// exit on error
QObject::connect(&engine, &QQmlApplicationEngine::objectCreationFailed,
    &app, []() { QCoreApplication::exit(-1); }, Qt::QueuedConnection);
engine.load(QUrl());
return app.exec();

また、QQmlApplicationEngine::objectCreated も参照してください。このシグナルは、このシグナルに加えて（作成に失敗した場合でも）発行されます。

この関数は Qt 6.4 で導入されました。

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

QQmlApplicationEngine によってインスタンス化されたすべてのルートオブジェクトのリストを返します。このリストには、load() または利便性のためのコンストラクタを介して読み込まれたオブジェクトのみが含まれます。

[slot, since 6.0] void QQmlApplicationEngine::setExtraFileSelectors(const QStringList &extraFileSelectors)

URLをローカルファイルに解決するために使用される内部のQQmlFileSelector に渡すextraFileSelectors を設定します。extraFileSelectors は、最初のQMLファイルが読み込まれる際に適用されます。それ以降に設定しても効果はありません。

この関数は Qt 6.0 で導入されました。

「 QQmlFileSelector 」および「QFileSelector::setExtraSelectors 」も参照してください 。

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

QMLコンポーネントが読み込まれた後に初期化されるinitialProperties を設定します。

QQmlApplicationEngine engine;

EventDatabase eventDatabase;
EventMonitor eventMonitor;

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

「 QQmlComponent::setInitialProperties 」、「QQmlApplicationEngine::load 」、および「QQmlApplicationEngine::loadData 」も参照してください 。