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)

切換離屏 OpenGL 紋理繪製模式而不重新載入 QML 場景(可在 load() 前設定);啟用後須由呼叫端呼叫 renderTexture() 並繪製紋理。

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()

釋放 GPU 算繪目標,同時完整保留 QML 場景與紋理模式設定。

屬性

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)

是否啟用離屏紋理算繪模式。

受保護成員

方法

繼承自 fluent::FluentElement

列舉

enum Theme

解析設計 token 時使用的全域視覺佈景主題。

  • 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)

傳回主題是否使用深色底的視窗框架與材質 token。

static void refreshTheme()

在設計 token 變更後重新廣播目前佈景主題以觸發重繪。

static int themeGeneration()

每次主題變更時遞增的單調計數器,用於過期檢查。

Theme effectiveTheme() const

解析此元素所使用的佈景主題,並遵循繼承的 QWidget 覆寫。

bool effectiveThemeUsesDarkAppearance() const

傳回此元素的實際主題是否使用深色底 chrome。

bool setThemeOverrides(const QJsonObject& overrides)

取代此元素的稀疏色彩、圓角與字型 token 覆寫。

QJsonObject themeOverrides() const

傳回此元素的覆寫設定。

void clearThemeOverrides()

將全部 token 欄位還原為全域主題預設值。

const Colors& themeColorsRef() const

對目前使用中色組的不複製存取(適用於繪製熱路徑)。

Material::AcrylicToken themeAcrylic() const

材質、高度層級與自適應版面配置 token。

QColor themeBackdrop(bool active) const

指定啟用狀態下的視窗 chrome 背景色。

virtual void onThemeUpdated()

在全域主題變更後呼叫。

型別與別名

struct Colors

傳回給元件使用的設計 token 快照。

繼承自 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++ setter 不會有動畫。

void clearBehavior(const char* propertyName)

移除後續受管理寫入所使用的預設動畫。

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

透過 Behavior 寫入宿主屬性,且不移除該屬性的繫結。

Qt 基底類別文件:QWidget