1. Epic GamesDeveloper
  3. FSlateNotificationManager

FSlateNotificationManager

A class which manages a group of notification windows

API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Framework > API/Runtime/Slate/Framework/Notifications

References

   
Module Slate
Header /Engine/Source/Runtime/Slate/Public/Framework/Notifications/NotificationManager.h
Include #include "Framework/Notifications/NotificationManager.h"

Syntax

class FSlateNotificationManager

Remarks

A class which manages a group of notification windows

Constructors

  Type Name Description
Protected function   Protect constructor as this is a singleton

Functions

  Type Name Description
Public function TSharedPtr< SNotificationItem > Adds a floating notification
Public function Const bool Checks whether notifications are currently enabled.
Public function void Cancels an active notification
Protected function TSharedRef< SNotificationList >

CreateStackForArea ( const FSlateRect& InRectangle,
TSharedPtr< SWindow > Window
)

 Create a notification list for the specified screen rectangle
Public function void 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'.
Public function Static FSlateNotificationManager &

Get ()

 Gets the instance of this manager
Public function Const void

GetWindows ( TArray< TSharedRef< SWindow > >& OutWindows
)

 Gets all the windows that represent notifications
Public function void Thread safe method of queuing a notification for presentation on the next tick
Public function void Register a Staged Async Notification, allowing the NotificationManager to keep a reference to it
Public function void

SetAllowNotifications ( const bool bShouldAllow
)

 Sets whether notifications should be displayed at all.
Public function void Sets the progress notification handler for the current application.
Public function void

SetRootWindow ( const TSharedRef< SWindow > InRootWindow
)

 Provide a window under which all notifications should nest.
Protected function void FCoreDelegates::OnPreExit shutdown callback
Public function FProgressNotificationHandle

StartProgressNotification ( FText DisplayText,
int32 TotalWorkToDo
)

 Begin a progress notification.
Public function void

Tick ()

 Update the manager
Public function void Unregister a previously added Staged Notification
Public function void

UpdateProgressNotification ( FProgressNotificationHandle InHandle,
int32 TotalWorkDone,
int32 UpdatedTotalWorkToDo,
FText UpdatedDisplayText
)

 Updates a progress notification.

Constants

Name Description
ProgressHandleCounter Counter used to create progress handles

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page