Fluent-Qt

對話方塊與浮層

CoachMark 引導標記

指向目標控制項,並可在步驟間平滑切換位置的引導卡片。

範例

CoachMark 引導標記: 移至新目標

用法

移至新目標

開啟後再次呼叫 setTarget() 可切換至新目標;動態效果開啟時會平滑移動到新位置。

#include <FluentQt/DialogsFlyouts.h>
using namespace fluent::dialogs_flyouts;

auto* coach = new CoachMark(window());
connect(this, &QObject::destroyed, coach, &QObject::deleteLater);
coach->setCardSize(QSize(320, 150));
coach->setPlacement(CoachMark::Bottom);
coach->setTarget(targetButton);  // glides if already open
closeButton->setAccessibleName("Close");
connect(closeButton, &Button::clicked, coach, &CoachMark::close);
coach->open();

fluent::dialogs_flyouts::CoachMark

繼承自 QWidget · fluent::FluentElement · fluent::QMLPlus

指向目標控制項的同視窗教學提示浮層。

建構函式

解構函式

列舉

enum SurfaceMode

舊版顯示模式;兩種值皆將提示託管於所屬視窗內。

  • TopLevelSurface SameWindowSurface 的已棄用別名。
  • SameWindowSurface 所屬頂層視窗內的子控制項。
enum Placement
  • Auto 解析為 Bottom。
  • Top 卡片位於目標上方,箭尾朝下。
  • Bottom 卡片位於目標下方,箭尾朝上。
  • Left 卡片位於目標左側,箭尾朝右。
  • Right 卡片位於目標右側,箭尾朝左。

方法

SurfaceMode surfaceMode() const

一律為 SameWindowSurface;保留以相容既有 API。

屬性

double fadeOpacity
讀取 fadeOpacity()設定 setFadeOpacity()
QSize cardSize
讀取 cardSize()設定 setCardSize()
QWidget* target
讀取 target()設定 setTarget()
Placement placement
讀取 placement()設定 setPlacement()
bool open
讀取 isOpen()設定 setOpen()變更訊號 openChanged()

訊號

void opened()

進場淡入完成後發出。

void closed()

退場淡出完成且提示隱藏後發出。

受保護成員

方法

繼承自 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