Navigation
API > API/Runtime > API/Runtime/Slate
A class which manages a group of notification windows
| Name | FSlateNotificationManager |
| Type | class |
| Header File | /Engine/Source/Runtime/Slate/Public/Framework/Notifications/NotificationManager.h |
| Include Path | #include "Framework/Notifications/NotificationManager.h" |
Syntax
class FSlateNotificationManager
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FSlateNotificationManager() |
Protect constructor as this is a singleton | Framework/Notifications/NotificationManager.h |
Structs
| Name | Remarks |
|---|---|
| FRegionalNotificationList | A list of notifications, bound to a particular region |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| bShowNotificationImmediately | bool | On Linux there is a hack in SDL to already delayed the showing of notification that is not interacting well with this optimization. | Framework/Notifications/NotificationManager.h |
| ProgressHandleCounter | int32 | Counter used to create progress handles | Framework/Notifications/NotificationManager.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bAllowNotifications | bool | Whether notifications should be displayed or not. | Framework/Notifications/NotificationManager.h | |
| CVarAllowNotifications | FAutoConsoleVariableRef | CVar allowing us to control the display of notifications. | Framework/Notifications/NotificationManager.h | |
| PendingNotifications | TLockFreePointerListLIFO< FNotificationInfo > | Thread safe queue of notifications to display | Framework/Notifications/NotificationManager.h | |
| ProgressNotificationHandler | IProgressNotificationHandler * | Handle to a system which updates progress notifications (e.g a status bar) | Framework/Notifications/NotificationManager.h | |
| RegionalLists | TArray< FRegionalNotificationList > | An array of notification lists grouped by work area regions | Framework/Notifications/NotificationManager.h | |
| RootWindowPtr | TWeakPtr< SWindow > | A window under which all of the notification windows will nest. | Framework/Notifications/NotificationManager.h | |
| StagedNotificationCS | FCriticalSection | Critical Section to guard access to StagedNotifications | Framework/Notifications/NotificationManager.h | |
| StagedNotifications | TArray< TSharedPtr< IAsyncTaskNotificationImpl > > | An array of staged notifications | Framework/Notifications/NotificationManager.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedPtr< SNotificationItem > AddNotification
(
const FNotificationInfo& Info |
Adds a floating notification | Framework/Notifications/NotificationManager.h | |
bool AreNotificationsAllowed() |
Checks whether notifications are currently enabled. | Framework/Notifications/NotificationManager.h | |
void CancelProgressNotification
(
FProgressNotificationHandle InHandle |
Cancels an active notification | Framework/Notifications/NotificationManager.h | |
void ForceNotificationsInFront
(
const TSharedRef< SWindow > InWindow |
Called back from the SlateApplication when a window is activated/resized We need to keep notifications topmost in the z-order so we manage it here directly as there isn't a cross-platform OS-level way of making a 'topmost child'. | Framework/Notifications/NotificationManager.h | |
void GetWindows
(
TArray< TSharedRef< SWindow > >& OutWindows |
Gets all the windows that represent notifications | Framework/Notifications/NotificationManager.h | |
void QueueNotification
(
FNotificationInfo* Info |
Thread safe method of queuing a notification for presentation on the next tick | Framework/Notifications/NotificationManager.h | |
void RegisterStagedNotification
(
TSharedPtr< IAsyncTaskNotificationImpl > InNotification |
Register a Staged Async Notification, allowing the NotificationManager to keep a reference to it | Framework/Notifications/NotificationManager.h | |
void SetAllowNotifications
(
const bool bShouldAllow |
Sets whether notifications should be displayed at all. | Framework/Notifications/NotificationManager.h | |
void SetProgressNotificationHandler
(
IProgressNotificationHandler* NewHandler |
Sets the progress notification handler for the current application. | Framework/Notifications/NotificationManager.h | |
void SetRootWindow
(
const TSharedRef< SWindow > InRootWindow |
Provide a window under which all notifications should nest. | Framework/Notifications/NotificationManager.h | |
FProgressNotificationHandle StartProgressNotification
(
FText DisplayText, |
Begin a progress notification. | Framework/Notifications/NotificationManager.h | |
void Tick() |
Update the manager | Framework/Notifications/NotificationManager.h | |
void UnregisterStagedNotification
(
TSharedPtr< IAsyncTaskNotificationImpl > InNotification |
Unregister a previously added Staged Notification | Framework/Notifications/NotificationManager.h | |
void UpdateProgressNotification
(
FProgressNotificationHandle InHandle, |
Updates a progress notification. | Framework/Notifications/NotificationManager.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedRef< SNotificationList > CreateStackForArea
(
const FSlateRect& InRectangle, |
Create a notification list for the specified screen rectangle | Framework/Notifications/NotificationManager.h | |
void ShutdownOnPreExit() |
FCoreDelegates::OnPreExit shutdown callback | Framework/Notifications/NotificationManager.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FSlateNotificationManager & Get() |
Gets the instance of this manager | Framework/Notifications/NotificationManager.h |