AsyncTaskNotification.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Delegates/Delegate.h"
#include "Internationalization/Text.h"
#include "Logging/LogCategory.h"
#include "Misc/Attribute.h"
#include "Templates/SharedPointer.h"
 
class IAsyncTaskNotificationImpl;
struct FLogCategoryBase;
struct FSlateBrush;
 
struct FAsyncTaskNotificationConfig
{
    FText TitleText;
 
    FText ProgressText;
 
    float FadeInDuration = 0.5f;
 
    float FadeOutDuration = 2.0f;
 
    float ExpireDuration = 1.0f;
 
    bool bIsHeadless = false;
 
    TAttribute<bool> bCanCancel = false;
 
    TAttribute<bool> bKeepOpenOnSuccess = false;
 
    TAttribute<bool> bKeepOpenOnFailure = false;
 
    const FSlateBrush* Icon = nullptr;
 
    const FLogCategoryBase* LogCategory = nullptr;
};
 
enum class EAsyncTaskNotificationState : uint8
{
    None = 0,
    Pending,
    Success,
    Failure,
    Prompt,
};
 
enum class EAsyncTaskNotificationPromptAction : uint8
{
    None = 0,
    Continue,
    Cancel,
    Unattended
};
 
struct FAsyncNotificationStateData
{
    FAsyncNotificationStateData()
        : State(EAsyncTaskNotificationState::Pending)
    {}
 
    FAsyncNotificationStateData(const FText& InTitleText, const FText& InProgressText, EAsyncTaskNotificationState InState)
        : State(InState)
        , TitleText(InTitleText)
        , ProgressText(InProgressText)
    {}
 
    EAsyncTaskNotificationState State;
 
    FText TitleText;
 
    FText ProgressText;
 
    FText PromptText;
 
    FText HyperlinkText;
 
    FSimpleDelegate Hyperlink;
};
 
class FAsyncTaskNotification
{
public:
    CORE_API FAsyncTaskNotification(const FAsyncTaskNotificationConfig& InConfig);
 
    CORE_API ~FAsyncTaskNotification();
 
    FAsyncTaskNotification(const FAsyncTaskNotification&) = delete;
    FAsyncTaskNotification& operator=(const FAsyncTaskNotification&) = delete;
 
    CORE_API FAsyncTaskNotification(FAsyncTaskNotification&& InOther);
    CORE_API FAsyncTaskNotification& operator=(FAsyncTaskNotification&& InOther);
 
    CORE_API void SetTitleText(const FText& InTitleText, const bool bClearProgressText = true);
 
    CORE_API void SetProgressText(const FText& InProgressText);
 
    CORE_API void SetPromptText(const FText& InPromptText);
 
    CORE_API void SetHyperlink(const FSimpleDelegate& InHyperlink, const FText& InHyperlinkText = FText());
 
    CORE_API void SetComplete(const bool bSuccess = true);
 
    CORE_API void SetComplete(const FText& InTitleText, const FText& InProgressText, const bool bSuccess = true);
 
    CORE_API void SetNotificationState(const FAsyncNotificationStateData& InState);
 
    CORE_API void SetCanCancel(const TAttribute<bool>& InCanCancel);
 
    CORE_API void SetKeepOpenOnSuccess(const TAttribute<bool>& InKeepOpenOnSuccess);
 
    CORE_API void SetKeepOpenOnFailure(const TAttribute<bool>& InKeepOpenOnFailure);
 
    CORE_API EAsyncTaskNotificationPromptAction GetPromptAction() const;
 
private:
    TSharedPtr<IAsyncTaskNotificationImpl> NotificationImpl;
};