Navigation
API > API/Runtime > API/Runtime/Slate
Setup class to initialize a notification.
| Name | FNotificationInfo |
| Type | struct |
| Header File | /Engine/Source/Runtime/Slate/Public/Widgets/Notifications/SNotificationList.h |
| Include Path | #include "Widgets/Notifications/SNotificationList.h" |
Syntax
struct FNotificationInfo
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FNotificationInfo
(
const FText& InText |
FNotifcationInfo initialization constructor | Widgets/Notifications/SNotificationList.h | |
FNotificationInfo
(
TSharedPtr< INotificationWidget > InContentWidget |
FNotifcationInfo initialization constructor | Widgets/Notifications/SNotificationList.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bAllowThrottleWhenFrameRateIsLow | bool | 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 | Widgets/Notifications/SNotificationList.h | |
| bFireAndForget | bool | When true the notification will automatically time out after the expire duration. | Widgets/Notifications/SNotificationList.h | |
| bUseCopyToClipboard | bool | Controls whether or not to display the copy to clipboard button | Widgets/Notifications/SNotificationList.h | |
| bUseLargeFont | bool | When true the larger bolder font will be used to display the message | Widgets/Notifications/SNotificationList.h | |
| bUseSuccessFailIcons | bool | Controls whether or not to display the success and fail icons | Widgets/Notifications/SNotificationList.h | |
| bUseThrobber | bool | Controls whether or not to add the animated throbber | Widgets/Notifications/SNotificationList.h | |
| ButtonDetails | TArray< FNotificationButtonInfo > | Setup information for the buttons on the notification | Widgets/Notifications/SNotificationList.h | |
| CheckBoxState | TAttribute< ECheckBoxState > | When set this will display a check box on the notification; handles getting the current check box state | Widgets/Notifications/SNotificationList.h | |
| CheckBoxStateChanged | FOnCheckStateChanged | When set this will display a check box on the notification; handles setting the new check box state | Widgets/Notifications/SNotificationList.h | |
| CheckBoxText | TAttribute< FText > | Text to display for the check box message | Widgets/Notifications/SNotificationList.h | |
| ContentWidget | TSharedPtr< INotificationWidget > | If set, overrides the entire content of the notification with this widget | Widgets/Notifications/SNotificationList.h | |
| ExpireDuration | float | The duration before a fadeout for this element | Widgets/Notifications/SNotificationList.h | |
| FadeInDuration | float | The fade in duration for this element | Widgets/Notifications/SNotificationList.h | |
| FadeOutDuration | float | The fade out duration for this element | Widgets/Notifications/SNotificationList.h | |
| ForWindow | TSharedPtr< SWindow > | A specific window to put the notification in. | Widgets/Notifications/SNotificationList.h | |
| Hyperlink | FSimpleDelegate | When set this will display as a hyperlink on the right side of the notification. | Widgets/Notifications/SNotificationList.h | |
| HyperlinkText | TAttribute< FText > | Text to display for the hyperlink message | Widgets/Notifications/SNotificationList.h | |
| Image | const FSlateBrush * | The icon image to display next to the text | Widgets/Notifications/SNotificationList.h | |
| SubText | TAttribute< FText > | Optional subtext displayed in this notification. | Widgets/Notifications/SNotificationList.h | |
| Text | TAttribute< FText > | The text displayed in this notification. Suitable for short notifications and titles. | Widgets/Notifications/SNotificationList.h | |
| WidthOverride | FOptionalSize | When set this forces the width of the box, used to stop resizing on text change | Widgets/Notifications/SNotificationList.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void ShowCopyToClipboadHyperlink () |
Shows a "Copy to Clipboard" hyperlink that when clicked copies the text and sub-text to the operating system clipboard | Widgets/Notifications/SNotificationList.h |