Fluent-Qt

狀態與資訊

Toast 輕量提示

不打斷目前工作的輕量浮動通知,可附帶快捷操作按鈕。

範例

Toast 輕量提示: 操作回饋

用法

操作回饋

呼叫 showToast() 彈出通知,並設定訊息層級、顯示時間、彈出位置與選用操作按鈕。

#include <FluentQt/StatusInfo.h>
using namespace fluent::status_info;

auto* panel = new QWidget(this);
auto* layout = new QVBoxLayout(panel);
layout->setContentsMargins(0, 0, 0, 0);
layout->setSpacing(12);
auto* retry = new QAction("Try again", panel);
QObject::connect(retry, &QAction::triggered, panel, [panel]() {
    Toast::showToast(panel, "Ready to retry", Toast::Success, 2200, Toast::TopEnd);
});
auto* review = new QAction("Review file", panel);
QObject::connect(review, &QAction::triggered, panel, [panel]() {
    Toast::showToast(panel, "Choose a file under 20 MB", Toast::Informational, 3500, Toast::TopEnd);
});
auto* card = new fluent::layout::Card(panel);
card->setAppearance(fluent::layout::Card::Canvas);
auto* buttons = new QHBoxLayout(card);
buttons->setContentsMargins(16, 14, 16, 14);
buttons->setSpacing(8);
const QStringList labels = {"Saved", "Copied", "Warning", "Error"};
for (int i = 0; i < labels.size(); ++i) {
    auto* button = new Button(labels.at(i), card);
    button->setObjectName(QStringLiteral("feedback%1").arg(i));
    buttons->addWidget(button);
    QObject::connect(button, &Button::clicked, panel, [panel, retry, review, i]() {
        for (Toast* previous : panel->window()->findChildren<Toast*>("feedbackToast"))
            previous->dismiss();
        auto* toast = new Toast(panel);
        toast->setObjectName("feedbackToast");
        toast->setDuration(5500);
        toast->setPlacement(Toast::TopEnd);
        toast->setClosable(true);
        toast->setPauseOnHoverEnabled(true);
        if (i == 0 || i == 1) {
            toast->setSeverity(i == 0 ? Toast::Success : Toast::Informational);
            toast->setMessage(i == 0 ? "Changes saved" : "Link copied");
        } else if (i == 2) {
            toast->setSeverity(Toast::Warning);
            toast->setTitle("One file needs attention");
            toast->setMessage("archive.zip exceeds the 20 MB limit. The other files can continue.");
            toast->setAction(review);
        } else {
            toast->setSeverity(Toast::Error);
            toast->setTitle("Upload interrupted");
            toast->setMessage("Your connection was lost. Try again to resume product-shot.png.");
            toast->setAction(retry);
        }
        QObject::connect(panel, &QObject::destroyed, toast, &QObject::deleteLater);
        QObject::connect(toast, &Toast::dismissed, toast, &QObject::deleteLater);
        toast->present(panel);
    });
}
layout->addWidget(card, 0, Qt::AlignCenter);

fluent::status_info::Toast

繼承自 QWidget · FluentElement · QMLPlus

錨定於視窗邊緣的應用程式內短暫通知浮層。受管理的通知會於錨點的最上層視窗內依位置堆疊,數量上限為 `maximumVisible()`。

建構函式

解構函式

列舉

enum Severity
  • Informational
  • Success
  • Warning
  • Error
enum Placement

Toast 卡片的邊緣錨點(`*Start` / `*End` 會跟隨版面配置方向)。

  • TopStart
  • Top
  • TopEnd
  • BottomStart
  • Bottom
  • BottomEnd
enum DismissReason

結束單次 Toast 顯示生命週期的原因。

  • Programmatic
  • TimedOut
  • ActionInvoked
  • Evicted
  • CloseButton

方法

QAction* action() const

Toast 內的可選動作按鈕;觸發後會以 `ActionInvoked` 關閉通知。

void setAction(QAction* action)

設定通知中顯示的操作按鈕(仍由呼叫端管理;不會由 Toast 刪除)。

bool isClosable() const

是否顯示關閉按鈕以透過 `CloseButton` 關閉快顯通知(預設關閉以保留指標穿透)。

void setClosable(bool closable)

是否顯示關閉按鈕以透過 `CloseButton` 關閉快顯通知(預設關閉以保留指標穿透)。

bool isPauseOnHoverEnabled() const

滑鼠懸停時是否暫停自動關閉計時器(預設關閉以保留指標穿透)。

void setPauseOnHoverEnabled(bool enabled)

滑鼠懸停時是否暫停自動關閉計時器(預設關閉以保留指標穿透)。

QString updateKey() const

供 `showOrUpdateToast()` 原地更新現有 Toast 的可選索引鍵。

void setUpdateKey(const QString& key)

供 `showOrUpdateToast()` 原地更新現有 Toast 的可選索引鍵。

static int maximumVisible()

每個宿主視窗與配置位置最多同時顯示的受管 Toast 數量。變更此值僅影響後續的 `showToast()` 呼叫,不影響已開啟的 Toast。

bool present(QWidget* anchor)

在錨點所屬的頂層視窗中顯示此 Toast。

void dismiss()

關閉並隱藏 Toast。

static Toast* showOrUpdateToast(QWidget* anchor, const QString& updateKey, const QString& message, Severity severity = Informational, int durationMs = 2200, Placement placement = Top, const QMargins& margins = QMargins(16, 16, 16, 16))

顯示受管理的 Toast,或原地更新共用相同主視窗、位置與非空 `updateKey` 的開啟通知;原地更新會重置計時器並發出 `updated()`,空鍵則等同於 `showToast()`。

屬性

QString title
讀取 title()設定 setTitle()變更訊號 titleChanged()
QString message
讀取 message()設定 setMessage()變更訊號 messageChanged()
Severity severity
讀取 severity()設定 setSeverity()變更訊號 severityChanged()
Placement placement
讀取 placement()設定 setPlacement()變更訊號 placementChanged()
QMargins placementMargins
讀取 placementMargins()設定 setPlacementMargins()變更訊號 placementMarginsChanged()
int duration
讀取 duration()設定 setDuration()變更訊號 durationChanged()
bool animationEnabled
讀取 isAnimationEnabled()設定 setAnimationEnabled()變更訊號 animationEnabledChanged()
QAction* action

Toast 內的可選動作按鈕;觸發後會以 `ActionInvoked` 關閉通知。

讀取 action()設定 setAction()變更訊號 actionChanged()
bool closable

是否顯示關閉按鈕以透過 `CloseButton` 關閉快顯通知(預設關閉以保留指標穿透)。

讀取 isClosable()設定 setClosable()變更訊號 closableChanged()
bool pauseOnHoverEnabled

滑鼠懸停時是否暫停自動關閉計時器(預設關閉以保留指標穿透)。

讀取 isPauseOnHoverEnabled()設定 setPauseOnHoverEnabled()變更訊號 pauseOnHoverEnabledChanged()
QString updateKey

供 `showOrUpdateToast()` 原地更新現有 Toast 的可選索引鍵。

讀取 updateKey()設定 setUpdateKey()變更訊號 updateKeyChanged()
bool isOpen
讀取 isOpen()變更訊號 isOpenChanged()
qreal toastProgress
讀取 toastProgress()設定 setToastProgress()

訊號

void actionChanged(QAction* action)

Toast 內的可選動作按鈕;觸發後會以 `ActionInvoked` 關閉通知。

void closableChanged(bool closable)

是否顯示關閉按鈕以透過 `CloseButton` 關閉快顯通知(預設關閉以保留指標穿透)。

void pauseOnHoverEnabledChanged(bool enabled)

滑鼠懸停時是否暫停自動關閉計時器(預設關閉以保留指標穿透)。

void updateKeyChanged(const QString& key)

供 `showOrUpdateToast()` 原地更新現有 Toast 的可選索引鍵。

受保護成員

方法

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