Fluent-Qt

QML 埋め込み (QmlBridge)

QmlView QML ビュー

周囲の Widgets とアプリケーションモデルや Fluent テーマトークンを共有する QML サーフェスです。

サンプル

QmlView QML ビュー: QML ページの読み込み

使い方

QML ページの読み込み

QmlSession を有効化し、QmlSession::createView() で QmlView を作成して QML URL を読み込みます。OpenGL ビューとウィンドウを共有する場合は、最初の Quick ビューを作成する前に Quick グラフィックスバックエンドを選択してください。

#include <FluentQt/QmlBridge.h>
using namespace fluent::qmlbridge;

// main.cpp; build with CMakeLists.txt and keep the QML page in its own file.
#include <FluentQt/FluentQt.h>
#include <FluentQt/QmlBridge.h>
#include <QApplication>
#include <QHBoxLayout>
#include <QVBoxLayout>

using fluent::basicinput::Button;
using fluent::qmlbridge::QmlSession;
using fluent::qmlbridge::QmlView;
using fluent::status_info::ProgressBar;
using fluent::textfields::Label;
using fluent::textfields::LineEdit;
using fluent::windowing::Window;

QWidget* makePanel(const QUrl& source, QWidget* parent)
{
    auto* panel = new QWidget(parent);
    auto* column = new QVBoxLayout(panel);
    column->setContentsMargins(16, 16, 16, 16);
    column->setSpacing(12);
    column->setAlignment(Qt::AlignTop);
    auto* session = new QmlSession(panel, panel);
    QString error;
    QmlView* view = session->activate(&error) ? session->createView(panel) : nullptr;
    if (!view) {
        column->addWidget(new Label(error.isEmpty() ? "QML is unavailable" : error, panel));
        return panel;
    }
    view->setFixedHeight(100);
    column->addWidget(view);
    view->load(source);
    return panel;
}

int main(int argc, char* argv[])
{
    fluent::prepareHighDpiApplication();
    QmlSession::prepareApplication();
    QApplication application(argc, argv);
    fluent::initializeResources();
    application.setFont(Typography::fontStyle(Typography::FontRole::Body).toQFont());

    Window window;
    window.setWindowTitle("QmlView");
    window.resize(640, 480);
    window.setContentWidget(makePanel(QUrl("qrc:/Basic.qml"), &window));
    window.show();
    return application.exec();
}

fluent::qmlbridge::QmlView

継承元 QWidget · FluentElement · QMLPlus

アプリケーションの QML ページを埋め込んで表示するための QWidget コンテナーです。使用前にアクティブな QmlSession にアタッチし、信頼できる QML のみを読み込んでください(セッションの無効化時にシーンは自動的にアンロードされます)。

コンストラクタ

デストラクタ

列挙型

enum Status
  • Unloaded
  • Loading
  • Ready
  • Error

メソッド

QObject* rootObject() const

読み込まれた QML ルートオブジェクトを返します。準備完了前または unload() 後は nullptr を返します。

QObject* themeObject() const

ビューが所有する fluentTheme コンテキストオブジェクトを返します。

bool setContextObject(const QString& name, QObject* object)

読み込み前に GUI スレッド上の QObject を指定した名前で登録します(削除するには nullptr を渡します。"fluentTheme" は予約済みです)。オブジェクトのライフタイムは呼び出し側が保持します。バインディングは unload() をまたいで維持され、バインドされたオブジェクトが破棄されるとシーンはアンロードされます。

bool load(const QUrl& source, QString* error = nullptr)

絶対パスの QML URL を読み込み、準備完了または非同期読み込み開始時に true を返します。非同期エラーは statusChanged() と errorOccurred() で監視してください。同じ URL を再読み込みするには、先に unload() を呼び出します。

void unload()

外部のコンテキストバインディングを維持したまま QML シーンをアンロードし、ステータスをリセットします。破棄処理はコールバックの完了まで遅延されるため、QML コールバック内から安全に呼び出せます。

bool setTextureRenderingEnabled(bool enabled)

QML シーンを再読み込みせずにオフスクリーン OpenGL テクスチャ描画を切り替えます。有効にした場合、呼び出し側は renderTexture() を呼び出してテクスチャを描画する必要があります。load() の前にも設定できます。

bool isTextureRenderingEnabled() const

オフスクリーンテクスチャレンダリングを有効にするかどうか。

bool renderTexture(QOpenGLContext* context, qreal devicePixelRatio, quint64 maximumBytes = 67108864)

呼び出し側の現在の OpenGL コンテキストを使用して QML シーンをテクスチャへレンダリングします(GUI スレッド専用)。devicePixelRatio は (0, 4] の範囲である必要があり、maximumBytes はカラー/深度バッファの上限を制限します。

unsigned int textureId() const

乗算済み RGBA OpenGL テクスチャ(左下原点)を返します。利用できない場合は 0 を返します。releaseTexture()、unload()、リサイズ、またはコンテキスト変更時に無効になります。

QSize textureSize() const

デバイスピクセル単位のテクスチャサイズです。

quint64 textureRevision() const

フレームが描画されるたびにインクリメントされるフレームリビジョンカウンター。

QVariantMap textureStatistics() const

テクスチャメモリ使用量、フレーム数、および最後のエラーを含む診断マップ。

void releaseTexture()

QML シーンとテクスチャモード設定を保持したまま GPU レンダーターゲットを解放します。

プロパティ

QUrl source
読み取り source()通知シグナル sourceChanged()
Status status
読み取り status()通知シグナル statusChanged()
bool active
読み取り isActive()通知シグナル activeChanged()
QStringList errors
読み取り errors()通知シグナル errorsChanged()
QString lastError
読み取り lastError()通知シグナル errorsChanged()
QObject* theme

ビューが所有する fluentTheme コンテキストオブジェクトを返します。

読み取り themeObject()
bool textureRenderingEnabled

オフスクリーンテクスチャレンダリングを有効にするかどうか。

読み取り isTextureRenderingEnabled()書き込み setTextureRenderingEnabled()通知シグナル textureRenderingEnabledChanged()

シグナル

void textureRenderingEnabledChanged(bool enabled)

オフスクリーンテクスチャレンダリングを有効にするかどうか。

protected メンバー

メソッド

fluent::FluentElement から継承

列挙型

enum Theme

デザイントークン解決時に使用されるグローバルな視覚テーマ。

  • Light = 0
  • Dark = 1
  • HighContrast = 2

メソッド

static void setTheme(Theme theme)

グローバルテーマを更新し、アクティブな FluentElement インスタンスに通知します。

static void setThemeDeferred(Theme theme)

現在の操作をブロックせずに、可視要素を優先したバッチ処理でテーマの更新をスケジュールします。

static Theme currentTheme()

現在有効なグローバルテーマを返します。

static bool themeUsesDarkAppearance(Theme theme)

テーマがダークベースのクロームおよびマテリアルトークンを使用するかどうかを返します。

static void refreshTheme()

デザイントークンの変更後に再描画するため、現在のテーマを再ブロードキャストします。

static int themeGeneration()

テーマ変更ごとに加算される単調増加カウンターです。鮮度チェックに使用されます。

Theme effectiveTheme() const

継承された QWidget の上書きを尊重し、この要素が使用するテーマを解決します。

bool effectiveThemeUsesDarkAppearance() const

この要素の有効なテーマがダークベースのクロームを使用するかどうかを返します。

bool setThemeOverrides(const QJsonObject& overrides)

この要素のスパースな色、角丸半径、フォントトークンの上書きを置き換えます。

QJsonObject themeOverrides() const

この要素に設定されたオーバーライドを返します。

void clearThemeOverrides()

すべてのトークンフィールドをグローバルテーマの既定値に復元します。

const Colors& themeColorsRef() const

描画のホットパス向けにアクティブなカラーセットへ非コピーでアクセスします。

Material::AcrylicToken themeAcrylic() const

マテリアル、エレベーション、およびアダプティブレイアウトのトークン。

QColor themeBackdrop(bool active) const

指定されたアクティブ状態に対するウィンドウ chrome の背景色。

virtual void onThemeUpdated()

グローバルテーマの変更後に呼び出されます。

型とエイリアス

struct Colors

コンポーネントに返されるデザイントークンのスナップショット。

fluent::QMLPlus から継承

メソッド

AnchorLayout::Anchors* anchors()

QWidget ホストの変更可能なアンカーを返します。

void setState(const QString& name)

登録済みの状態を名前で適用するか、@p name が空の場合はデフォルト状態を復元します。未知の名前は無視され、その状態を離れると既存のバインディングが再開されます。

void addState(const QMLState& state)

名前付き状態定義を登録または置換します。アクティブな状態を置換した場合は即座に適用されます。

void evaluateStates()

登録順に状態条件を再評価し、最初に一致した状態(一致しない場合はデフォルト状態)をアクティブにします。依存プロパティの変更通知時にも自動実行され、extend を使用する派生状態は、循環や欠損がない限り祖先の変更を継承します。

QMLPlusRuntime* runtime()

このホストが所有し、遅延生成される状態オブザーバーを返します。

void setAnchors(const AnchorLayout::Anchors& anchors)

すべてのホストアンカーを置き換え、親レイアウトを無効化します。

void resetAnchors()

ホストのすべてのアンカーをクリアし、親レイアウトを無効化します。

void bind(const char* targetProp, QObject* source, const char* sourceProp, PropertyBinder::Direction dir = PropertyBinder::OneWay)

PropertyBinder::bind() を介して、@p source の @p sourceProp をこの QWidget ホストの @p targetProp にバインドします。

void addTransition(const StateTransition& transition)

優先順位順に状態遷移を登録します。

void setBehavior(const char* propertyName, const PropertyAnimation& animation)

writeProperty() またはバインディング経由で @p propertyName が書き込まれた際に使用されるデフォルトアニメーションを設定します。明示的な StateTransition ルールが優先され、C++ のセッターを直接呼び出した場合はアニメーションしません。

void clearBehavior(const char* propertyName)

今後のマネージド書き込みに使用するデフォルトアニメーションを削除します。

bool writeProperty(const char* propertyName, const QVariant& value)

バインディングを削除せずに Behavior 経由でホストプロパティに書き込みます。

Qt 基底クラスドキュメント:QWidget