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

トーストカードの端アンカー位置です(`*Start` / `*End` はレイアウト方向に従います)。

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

1 回のトースト表示ライフタイムが終了した理由。

  • Programmatic
  • TimedOut
  • ActionInvoked
  • Evicted
  • CloseButton

メソッド

QAction* action() const

トースト内のオプションのアクションボタン。トリガーすると `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()` が既存のトーストをその場で更新するために使用するオプションのキー。

void setUpdateKey(const QString& key)

`showOrUpdateToast()` が既存のトーストをその場で更新するために使用するオプションのキー。

static int maximumVisible()

ホストウィンドウおよび配置位置ごとに同時に表示可能な管理対象トーストの最大数です。この値を変更しても、すでに開いているトーストには影響せず、今後の `showToast()` 呼び出しのみに適用されます。

bool present(QWidget* anchor)

アンカーのトップレベルウィンドウ内にこの Toast を表示します。

void dismiss()

Toast を閉じて非表示にします。

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

自動削除されるマネージド Toast を表示して他のマネージド Toast と重ねて配置し、`maximumVisible()` を超えた場合は最も古いものを閉じます。

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` を共有する表示中の Toast を更新します。インプレース更新ではタイマーがリセットされ、`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

トースト内のオプションのアクションボタン。トリガーすると `ActionInvoked` でトーストを閉じます。

読み取り action()書き込み setAction()通知シグナル actionChanged()
bool closable

トーストを `CloseButton` で閉じるための閉じるボタンを表示するかどうかです(ポインター透過のためデフォルトは無効)。

読み取り isClosable()書き込み setClosable()通知シグナル closableChanged()
bool pauseOnHoverEnabled

ホバー時に自動クローズタイマーを一時停止するかどうか(ポインター透過のためデフォルトではオフ)。

読み取り isPauseOnHoverEnabled()書き込み setPauseOnHoverEnabled()通知シグナル pauseOnHoverEnabledChanged()
QString updateKey

`showOrUpdateToast()` が既存のトーストをその場で更新するために使用するオプションのキー。

読み取り updateKey()書き込み setUpdateKey()通知シグナル updateKeyChanged()
bool isOpen
読み取り isOpen()通知シグナル isOpenChanged()
qreal toastProgress
読み取り toastProgress()書き込み setToastProgress()

シグナル

void actionChanged(QAction* action)

トースト内のオプションのアクションボタン。トリガーすると `ActionInvoked` でトーストを閉じます。

void closableChanged(bool closable)

トーストを `CloseButton` で閉じるための閉じるボタンを表示するかどうかです(ポインター透過のためデフォルトは無効)。

void pauseOnHoverEnabledChanged(bool enabled)

ホバー時に自動クローズタイマーを一時停止するかどうか(ポインター透過のためデフォルトではオフ)。

void updateKeyChanged(const QString& key)

`showOrUpdateToast()` が既存のトーストをその場で更新するために使用するオプションのキー。

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