FNotificationInfo

Setup class to initialize a notification.

Windows
MacOS
Linux

References

Module

Slate

Header

/Engine/Source/Runtime/Slate/Public/Widgets/Notifications/SNotificationList.h

Include

#include "Widgets/Notifications/SNotificationList.h"

Syntax

struct FNotificationInfo

Remarks

Setup class to initialize a notification.

Variables

Name Description

Public variable

bool

 

bAllowThrottleWhenFrameRateIsLow

True if we should throttle the editor while the notification is transitioning and performance is poor, to make sure the user can see the animation

Public variable

bool

 

bFireAndForget

When true the notification will automatically time out after the expire duration.

Public variable

bool

 

bUseLargeFont

When true the larger bolder font will be used to display the message

Public variable

bool

 

bUseSuccessFailIcons

Controls whether or not to display the success and fail icons

Public variable

bool

 

bUseThrobber

Controls whether or not to add the animated throbber

Public variable

TArray< FNotifi...

 

ButtonDetails

Setup information for the buttons on the notification

Public variable

TAttribute< ECh...

 

CheckBoxState

When set this will display a check box on the notification; handles getting the current check box state

Public variable

FOnCheckStateCh...

 

CheckBoxStateChanged

When set this will display a check box on the notification; handles setting the new check box state

Public variable

TAttribute< FTe...

 

CheckBoxText

Text to display for the check box message

Public variable

TSharedPtr< INo...

 

ContentWidget

If set, overrides the entire content of the notification with this widget

Public variable

float

 

ExpireDuration

The duration before a fadeout for this element

Public variable

float

 

FadeInDuration

The fade in duration for this element

Public variable

float

 

FadeOutDuration

The fade out duration for this element

Public variable

FSimpleDelegate

 

Hyperlink

When set this will display as a hyperlink on the right side of the notification.

Public variable

TAttribute< FTe...

 

HyperlinkText

Text to display for the hyperlink message

Public variable

const FSlateBru...

 

Image

The icon image to display next to the text

Public variable

FText

 

Text

The text displayed in this text block

Public variable

FOptionalSize

 

WidthOverride

When set this forces the width of the box, used to stop resizing on text change

Constructors

Name Description

Public function

FNotificationInfo

(
    const FText& InText
)

FNotifcationInfo initialization constructor

Public function

FNotificationInfo

(
    TSharedPtr< INotificationWidget > I...
)

FNotifcationInfo initialization constructor

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