Fluent-Qt

状态与信息

Toast 轻提示

短暂显示的通知,不会打断当前操作。

示例

轻提示的真实 Gallery 示例

用法

操作反馈

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* row = new QWidget(panel);
auto* buttons = new QHBoxLayout(row);
buttons->setContentsMargins(0, 0, 0, 0);
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), row);
    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);
    });
}
buttons->addStretch();
layout->addWidget(row);

fluent::status_info::Toast

继承自 QWidget · FluentElement · QMLPlus

支持严重级别和边缘定位的同窗口短暂通知。

构造函数

属性

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 内呈现的可选调用方所有动作。

读取 action()设置 setAction()通知 actionChanged()
bool closable

是否显示关闭按钮,点击后以 `CloseButton` 原因关闭 Toast。

读取 isClosable()设置 setClosable()通知 closableChanged()
bool pauseOnHoverEnabled

鼠标悬停 Toast 时是否暂停正在运行的持续时间计时器。

读取 isPauseOnHoverEnabled()设置 setPauseOnHoverEnabled()通知 pauseOnHoverEnabledChanged()
QString updateKey

`showOrUpdateToast()` 在单个托管堆栈内使用的可选更新键。

读取 updateKey()设置 setUpdateKey()通知 updateKeyChanged()
bool isOpen
读取 isOpen()通知 isOpenChanged()
qreal toastProgress
读取 toastProgress()设置 setToastProgress()

方法

QAction* action() const

在 Toast 内呈现的可选调用方所有动作。

void setAction(QAction* action)

在 Toast 内呈现的可选调用方所有动作。

bool isClosable() const

是否显示关闭按钮,点击后以 `CloseButton` 原因关闭 Toast。

void setClosable(bool closable)

是否显示关闭按钮,点击后以 `CloseButton` 原因关闭 Toast。

bool isPauseOnHoverEnabled() const

鼠标悬停 Toast 时是否暂停正在运行的持续时间计时器。

void setPauseOnHoverEnabled(bool enabled)

鼠标悬停 Toast 时是否暂停正在运行的持续时间计时器。

QString updateKey() const

`showOrUpdateToast()` 在单个托管堆栈内使用的可选更新键。

void setUpdateKey(const QString& key)

`showOrUpdateToast()` 在单个托管堆栈内使用的可选更新键。

static int maximumVisible()

同一宿主、同一锚点下同时可见的托管 Toast 上限。

bool present(QWidget* anchor)

在锚点所属顶层窗口中呈现当前 Toast。

void dismiss()

关闭 Toast 并结束本次展示生命周期。

信号

void actionChanged(QAction* action)

在 Toast 内呈现的可选调用方所有动作。

void closableChanged(bool closable)

是否显示关闭按钮,点击后以 `CloseButton` 原因关闭 Toast。

void pauseOnHoverEnabledChanged(bool enabled)

鼠标悬停 Toast 时是否暂停正在运行的持续时间计时器。

void updateKeyChanged(const QString& key)

`showOrUpdateToast()` 在单个托管堆栈内使用的可选更新键。

枚举

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

Toast 卡片的边缘锚点。

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

结束一次 Toast 展示生命周期的原因。

  • Programmatic
  • TimedOut
  • ActionInvoked
  • Evicted
  • CloseButton

析构函数

子类扩展接口

方法

继承自 fluent::FluentElement

方法

static void setTheme(Theme theme)

更新全局主题,并通知所有活跃的 FluentElement 实例。

static void setThemeDeferred(Theme theme)

以可见元素优先的批次调度主题刷新,避免阻塞当前交互。

static Theme currentTheme()

返回当前生效的全局主题。

static bool themeUsesDarkAppearance(Theme theme)

返回指定主题是否使用暗色底的 chrome 与材质 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()

全局主题变化后调用。

枚举

enum Theme

解析设计 token 时使用的全局视觉主题。

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

类型与别名

struct Colors

返回给组件使用的设计 token 快照。

继承自 fluent::QMLPlus

方法

AnchorLayout::Anchors* anchors()

返回 QWidget 宿主的可变锚点配置。

void setState(const QString& name)

应用具名 state;名称为空时恢复默认状态。

void addState(const QMLState& state)

注册或替换一个具名 state 定义。

void evaluateStates()

重新计算条件;按注册顺序选择首个成立的条件。

QMLPlusRuntime* runtime()

返回按需创建、由宿主持有的状态观察对象。

void setAnchors(const AnchorLayout::Anchors& anchors)

替换宿主的全部锚点,并使父布局失效。

void resetAnchors()

清除宿主全部锚点,并使父布局失效。

void addTransition(const StateTransition& transition)

按优先顺序注册状态过渡。

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

设置宿主受管理属性写入时使用的默认动画。

void clearBehavior(const char* propertyName)

移除后续受管理写入使用的默认动画。

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

通过 Behavior 写入宿主属性,且不移除该属性的绑定。

Qt 基类完整成员:QWidget