UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
IProgressNotificationHandler Class Referenceabstract

#include <NotificationManager.h>

Public Member Functions

virtual ~IProgressNotificationHandler ()
 
virtual void StartProgressNotification (FProgressNotificationHandle Handle, FText DisplayText, int32 TotalWorkToDo)=0
 
virtual void UpdateProgressNotification (FProgressNotificationHandle Handle, int32 TotalWorkDone, int32 UpdatedTotalWorkToDo, FText UpdatedDisplayText)=0
 
virtual void CancelProgressNotification (FProgressNotificationHandle Handle)=0
 

Detailed Description

Base class for any handlers that display progress bars for progres notifications

Constructor & Destructor Documentation

◆ ~IProgressNotificationHandler()

virtual IProgressNotificationHandler::~IProgressNotificationHandler ( )
inlinevirtual

Member Function Documentation

◆ CancelProgressNotification()

virtual void IProgressNotificationHandler::CancelProgressNotification ( FProgressNotificationHandle  Handle)
pure virtual

Called when a notification should be cancelled

◆ StartProgressNotification()

virtual void IProgressNotificationHandler::StartProgressNotification ( FProgressNotificationHandle  Handle,
FText  DisplayText,
int32  TotalWorkToDo 
)
pure virtual

Called when a progress notification begins

Parameters
HandleHandle to the notification
DisplayTextDisplay text used to describe the type of work to the user
TotalWorkToDoArbitrary number of work units to perform.

◆ UpdateProgressNotification()

virtual void IProgressNotificationHandler::UpdateProgressNotification ( FProgressNotificationHandle  Handle,
int32  TotalWorkDone,
int32  UpdatedTotalWorkToDo,
FText  UpdatedDisplayText 
)
pure virtual

Called when a notification should be updated.

Parameters
InHandleHandle to the notification that was previously created with StartProgressNotification
TotalWorkDoneThe total number of work units done for the notification.
UpdatedTotalWorkToDoUpdatedTotalWorkToDo. This value will be 0 if the total work did not change
UpdatedDisplayTextUpdated display text of the notification. This value will be empty if the text did not change
The documentation for this class was generated from the following file: