FSlateNotificationManager

A class which manages a group of notification windows

Windows
MacOS
Linux

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

Name Description

Protected function

FSlateNotificationManager()

Protect constructor as this is a singleton

Functions

Name Description

Public function

TSharedPtr< ...

 

AddNotification

(
    const FNotificationInfo& Info
)

Adds a floating notification

Public function Const

bool

 

AreNotificationsAllowed()

Checks whether notifications are currently enabled.

Protected function

TSharedRef< ...

 

CreateStackForArea

(
    const FSlateRect& InRectangle
)

Create a notification list for the specified screen rectangle

Public function

void

 

ForceNotificationsInFront

(
    const TSharedRef< SWindow > InWindo...
)

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

FSlateNotifi...

 

Get()

Gets the instance of this manager

Public function Const

void

 

GetWindows

(
    TArray< TSharedRef< SWindow > >& O...
)

Gets all the windows that represent notifications

Public function

void

 

QueueNotification

(
    FNotificationInfo* Info
)

Thread safe method of queuing a notification for presentation on the next tick

Public function

void

 

SetAllowNotifications

(
    const bool bShouldAllow
)

Sets whether notifications should be displayed at all.

Public function

void

 

SetRootWindow

(
    const TSharedRef< SWindow > InRootW...
)

Provide a window under which all notifications should nest.

Protected function

void

 

ShutdownOnPreExit()

FCoreDelegates::OnPreExit shutdown callback

Public function

void

 

Tick()

Update the manager
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss