FNotificationInfo Struct Reference

#include <SNotificationList.h>

Public Member Functions
	FNotificationInfo (const FText &InText)
	FNotificationInfo (TSharedPtr< INotificationWidget > InContentWidget)
SLATE_API void	ShowCopyToClipboadHyperlink ()

Public Attributes
TSharedPtr< INotificationWidget >	ContentWidget
TAttribute< FText >	Text
TAttribute< FText >	SubText
TArray< FNotificationButtonInfo >	ButtonDetails
const FSlateBrush *	Image
float	FadeInDuration
float	FadeOutDuration
float	ExpireDuration
bool	bUseThrobber
bool	bUseSuccessFailIcons
bool	bUseLargeFont
bool	bUseCopyToClipboard
FOptionalSize	WidthOverride
bool	bFireAndForget
TAttribute< ECheckBoxState >	CheckBoxState
FOnCheckStateChanged	CheckBoxStateChanged
TAttribute< FText >	CheckBoxText
FSimpleDelegate	Hyperlink
TAttribute< FText >	HyperlinkText
TSharedPtr< SWindow >	ForWindow
bool	bAllowThrottleWhenFrameRateIsLow

Detailed Description

Setup class to initialize a notification.

Constructor & Destructor Documentation

FNotificationInfo() [1/2]

FNotificationInfo::FNotificationInfo ( const FText &  InText )

inline

FNotifcationInfo initialization constructor

Parameters

InText

Text string to display for this notification

FNotificationInfo() [2/2]

FNotificationInfo::FNotificationInfo ( TSharedPtr< INotificationWidget >  InContentWidget )

inline

FNotifcationInfo initialization constructor

Parameters

InContentWidget

The content of the notification

Member Function Documentation

ShowCopyToClipboadHyperlink()

void FNotificationInfo::ShowCopyToClipboadHyperlink

(

)

Shows a "Copy to Clipboard" hyperlink that when clicked copies the text and sub-text to the operating system clipboard

Note

Text and SubText must be set prior to calling this method for them to be included

Member Data Documentation

bAllowThrottleWhenFrameRateIsLow

bool FNotificationInfo::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

bFireAndForget

bool FNotificationInfo::bFireAndForget

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

bUseCopyToClipboard

bool FNotificationInfo::bUseCopyToClipboard

Controls whether or not to display the copy to clipboard button

bUseLargeFont

bool FNotificationInfo::bUseLargeFont

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

bUseSuccessFailIcons

bool FNotificationInfo::bUseSuccessFailIcons

Controls whether or not to display the success and fail icons

bUseThrobber

bool FNotificationInfo::bUseThrobber

Controls whether or not to add the animated throbber

ButtonDetails

TArray<FNotificationButtonInfo> FNotificationInfo::ButtonDetails

Setup information for the buttons on the notification

CheckBoxState

TAttribute<ECheckBoxState> FNotificationInfo::CheckBoxState

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

CheckBoxStateChanged

FOnCheckStateChanged FNotificationInfo::CheckBoxStateChanged

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

CheckBoxText

TAttribute<FText> FNotificationInfo::CheckBoxText

Text to display for the check box message

ContentWidget

TSharedPtr<INotificationWidget> FNotificationInfo::ContentWidget

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

ExpireDuration

float FNotificationInfo::ExpireDuration

The duration before a fadeout for this element

FadeInDuration

float FNotificationInfo::FadeInDuration

The fade in duration for this element

FadeOutDuration

float FNotificationInfo::FadeOutDuration

The fade out duration for this element

ForWindow

TSharedPtr<SWindow> FNotificationInfo::ForWindow

A specific window to put the notification in. If this is null, the root window of the application will be used

Hyperlink

FSimpleDelegate FNotificationInfo::Hyperlink

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

HyperlinkText

TAttribute<FText> FNotificationInfo::HyperlinkText

Text to display for the hyperlink message

Image

const FSlateBrush* FNotificationInfo::Image

The icon image to display next to the text

SubText

TAttribute<FText> FNotificationInfo::SubText

Optional subtext displayed in this notification. Subtext is smaller than the default text field and is better for long descriptions.

Text

TAttribute<FText> FNotificationInfo::Text

The text displayed in this notification. Suitable for short notifications and titles.

WidthOverride

FOptionalSize FNotificationInfo::WidthOverride

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

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/Slate/Public/Widgets/Notifications/SNotificationList.h
• Engine/Source/Runtime/Slate/Private/Widgets/Notifications/SNotificationList.cpp