class

CArcNotificationManager

Module
Arc
Header
#include "Arc/Framework/CArcPopupSystems.h"
Namespace
Arcf

Properties

TypeNameDescription
static constexpr size_tMaxVisibleDefault 5.
static constexpr size_tkHistoryLimitDefault 100.
static constexpr floatkAutoDismissSecondsDefault 5.0f.
static constexpr floatkStackGapDefault 8.0f.
static constexpr floatkMoreHeightDefault 24.0f.

Public functions

ReturnsNameDescription
CArcNotificationManager&Get
voidPush
voidPush
voidTick
voidDismiss
voidDismissAll
boolInvokeActionWhat a click at a card's action buttons does: runs the callback and, unless it is a running progress card's Cancel, dismisses the card first.
boolIsRunningProgressA card whose task is still running: a Progress callback answering [0, 1).
const char*ActionComponentThe export's component for a toast's first or second action: "button-secondary" then "button-ghost", except a restart toast's first, "button-restart" (Warning fill, OnAccent text).
const std::vector<CArcActiveNotification>&GetActive
size_tGetActiveCount
const std::vector<FArcNotificationRecord>&GetHistoryEvery toast pushed this session, oldest first (the bell's history flyout), capped at kHistoryLimit.
int32_tGetUnreadCount
boolHasUnreadErrorThe bell's badge turns Error while an error toast is unread.
voidMarkAllRead
voidClearHistory
floatDefaultLifetimeThe timer a toast of this type starts with when the caller sets no duration: 5 s for info and success, none (negative) for the rest.
voidResetOrdered shutdown hook — see CArcWidgetReflectorManager::Reset.
FToastHotState&GetHotState
voidSetHostAreaThe area the stack uses in the host's main window.
const FToastArea&GetHostArea
FToastAreaAreaAboveChromeThe toast area of a window whose bottom carries statusBar (empty when it has none) and, above that in the same corner, cornerPanel (empty while hidden), under topChrome (the title bar and toolbar; empty when none).
voidArrangeStackLays the cards out bottom-up from the area's corner, oldest lowest, so a new card never moves the ones already up.
size_tGetHiddenCountCards folded into the "+N more" line by the last ArrangeStack, and that line's distance from the window bottom to its top.
floatGetMoreOffset

Function details

Get

C++
static CArcNotificationManager& Get()

Push

C++
void Push(const CArcNotificationInfo& info)

Push

C++
void Push(const CText& title, ENotificationType type, const CText& body = CText::GetEmpty(), float lifetime = 0.0f)

Tick

C++
void Tick(float deltaTime)

Dismiss

C++
void Dismiss(size_t index)

DismissAll

C++
void DismissAll()

InvokeAction

C++
bool InvokeAction(size_t index, bool secondary)

What a click at a card's action buttons does: runs the callback and, unless it is a running progress card's Cancel, dismisses the card first. secondary picks the second button. False when the card has no such button.

IsRunningProgress

C++
static bool IsRunningProgress(const CArcNotificationInfo& info)

A card whose task is still running: a Progress callback answering [0, 1). Such a card cannot be dismissed by clicking it; its secondary button is the Cancel.

ActionComponent

C++
static const char* ActionComponent(ENotificationType type, bool first)

The export's component for a toast's first or second action: "button-secondary" then "button-ghost", except a restart toast's first, "button-restart" (Warning fill, OnAccent text).

GetActive

C++
const std::vector<CArcActiveNotification>& GetActive() const

GetActiveCount

C++
size_t GetActiveCount() const

GetHistory

C++
const std::vector<FArcNotificationRecord>& GetHistory() const

Every toast pushed this session, oldest first (the bell's history flyout), capped at kHistoryLimit.

GetUnreadCount

C++
int32_t GetUnreadCount() const

HasUnreadError

C++
bool HasUnreadError() const

The bell's badge turns Error while an error toast is unread.

MarkAllRead

C++
void MarkAllRead()

ClearHistory

C++
void ClearHistory()

DefaultLifetime

C++
static float DefaultLifetime(ENotificationType type)

The timer a toast of this type starts with when the caller sets no duration: 5 s for info and success, none (negative) for the rest.

Reset

C++
void Reset()

Ordered shutdown hook — see CArcWidgetReflectorManager::Reset.

GetHotState

C++
FToastHotState& GetHotState()

SetHostArea

C++
void SetHostArea(const FToastArea& area)

The area the stack uses in the host's main window. A host with chrome along the bottom (the editor's status bar and its Background tasks list) sets it from that chrome's arranged rects through AreaAboveChrome, every frame, so the stack follows the chrome rather than a guess at it. Every other window — toasts follow focus — uses the default 16 px corner.

GetHostArea

C++
const FToastArea& GetHostArea() const

AreaAboveChrome

C++
static FToastArea AreaAboveChrome(float windowHeight, const ArcRect& statusBar, const ArcRect& cornerPanel, const ArcRect& topChrome, float margin)

The toast area of a window whose bottom carries statusBar (empty when it has none) and, above that in the same corner, cornerPanel (empty while hidden), under topChrome (the title bar and toolbar; empty when none). Rects are window-local; margin is the gap kept from each of them and from the right edge.

ArrangeStack

C++
void ArrangeStack(const std::vector<float>& cardHeights, float windowHeight, const FToastArea& area, float deltaTime, bool snap)

Lays the cards out bottom-up from the area's corner, oldest lowest, so a new card never moves the ones already up. cardHeights is one height per active card. What does not fit between the corner and area.Top (or past MaxVisible) folds, oldest first, into a "+N more" line at the bottom: the newest card is always shown. Each card's StackOffset eases toward its slot over deltaTime; snap places every card at once (a different window took the stack).

GetHiddenCount

C++
size_t GetHiddenCount() const

Cards folded into the "+N more" line by the last ArrangeStack, and that line's distance from the window bottom to its top.

GetMoreOffset

C++
float GetMoreOffset() const
Generated from Arc/Framework/CArcPopupSystems.h via arc.json · Nov 5, 2026Version 1.0.0