Navigation
API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Widgets > API/Runtime/Slate/Widgets/Notifications
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
| Type | Name | Description | |
|---|---|---|---|
| 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 | |
| bool | bFireAndForget | When true the notification will automatically time out after the expire duration. | |
| bool | bUseLargeFont | When true the larger bolder font will be used to display the message | |
| bool | bUseSuccessFailIcons | Controls whether or not to display the success and fail icons | |
| bool | bUseThrobber | Controls whether or not to add the animated throbber | |
| TArray< FNotificationButtonInfo > | ButtonDetails | Setup information for the buttons on the notification | |
| TAttribute< ECheckBoxState > | CheckBoxState | When set this will display a check box on the notification; handles getting the current check box state | |
| FOnCheckStateChanged | CheckBoxStateChanged | When set this will display a check box on the notification; handles setting the new check box state | |
| TAttribute< FText > | CheckBoxText | Text to display for the check box message | |
| TSharedPtr< INotificationWidget > | ContentWidget | If set, overrides the entire content of the notification with this widget | |
| float | ExpireDuration | The duration before a fadeout for this element | |
| float | FadeInDuration | The fade in duration for this element | |
| float | FadeOutDuration | The fade out duration for this element | |
| TSharedPtr< SWindow > | ForWindow | A specific window to put the notification in. | |
| FSimpleDelegate | Hyperlink | When set this will display as a hyperlink on the right side of the notification. | |
| TAttribute< FText > | HyperlinkText | Text to display for the hyperlink message | |
| const FSlateBrush * | Image | The icon image to display next to the text | |
| TAttribute< FText > | SubText | Optional subtext displayed in this notification. | |
| TAttribute< FText > | Text | The text displayed in this notification. Suitable for short notifications and titles. | |
| FOptionalSize | WidthOverride | When set this forces the width of the box, used to stop resizing on text change |
Constructors
| Type | Name | Description | |
|---|---|---|---|
FNotificationInfo
(
const FText& InText |
FNotifcationInfo initialization constructor | ||
FNotificationInfo
(
TSharedPtr< INotificationWidget > InContentWidget |
FNotifcationInfo initialization constructor |