CoreAsyncTaskNotificationImpl.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Delegates/Delegate.h"
#include "HAL/CriticalSection.h"
#include "Internationalization/Text.h"
#include "Misc/AsyncTaskNotification.h"
#include "Misc/Attribute.h"
#include "Templates/Function.h"
#include "Templates/SharedPointer.h"
#include "Templates/Tuple.h"
#include "UObject/NameTypes.h"
 
struct FLogCategoryBase;
 
class IAsyncTaskNotificationImpl
{
public:
    virtual ~IAsyncTaskNotificationImpl() = default;
 
    virtual void Initialize(const FAsyncTaskNotificationConfig& InConfig) = 0;
 
    virtual void SetTitleText(const FText& InTitleText, const bool bClearProgressText) = 0;
 
    virtual void SetProgressText(const FText& InProgressText) = 0;
 
    virtual void SetPromptText(const FText& InPromptText) = 0;
 
    virtual void SetHyperlink(const FSimpleDelegate& InHyperlink, const FText& InHyperlinkText) = 0;
 
    virtual void SetComplete(const bool bSuccess) = 0;
 
    virtual void SetComplete(const FText& InTitleText, const FText& InProgressText, const bool bSuccess) = 0;
 
    virtual void SetNotificationState(const FAsyncNotificationStateData& InState) = 0;
 
    virtual void SetCanCancel(const TAttribute<bool>& InCanCancel) = 0;
 
    virtual void SetKeepOpenOnSuccess(const TAttribute<bool>& InKeepOpenOnSuccess) = 0;
 
    virtual void SetKeepOpenOnFailure(const TAttribute<bool>& InKeepOpenOnFailure) = 0;
 
    virtual EAsyncTaskNotificationPromptAction GetPromptAction() const = 0;
};
 
class FCoreAsyncTaskNotificationImpl : public IAsyncTaskNotificationImpl
{
public:
    CORE_API FCoreAsyncTaskNotificationImpl();
    CORE_API virtual ~FCoreAsyncTaskNotificationImpl();
 
    //~ IAsyncTaskNotificationImpl
    CORE_API virtual void Initialize(const FAsyncTaskNotificationConfig& InConfig) override;
    CORE_API virtual void SetTitleText(const FText& InTitleText, const bool bClearProgressText) override;
    CORE_API virtual void SetProgressText(const FText& InProgressText) override;
    CORE_API virtual void SetPromptText(const FText& InPromptText) override;
    CORE_API virtual void SetHyperlink(const FSimpleDelegate& InHyperlink, const FText& InHyperlinkText) override;
    CORE_API virtual void SetComplete(const bool bSuccess) override;
    CORE_API virtual void SetComplete(const FText& InTitleText, const FText& InProgressText, const bool bSuccess) override;
    CORE_API virtual void SetNotificationState(const FAsyncNotificationStateData& InState) override;
    CORE_API virtual void SetCanCancel(const TAttribute<bool>& InCanCancel) override;
    CORE_API virtual void SetKeepOpenOnSuccess(const TAttribute<bool>& InKeepOpenOnSuccess) override;
    CORE_API virtual void SetKeepOpenOnFailure(const TAttribute<bool>& InKeepOpenOnFailure) override;
    CORE_API virtual EAsyncTaskNotificationPromptAction GetPromptAction() const override;
 
protected:
    CORE_API virtual void UpdateNotification();
 
    EAsyncTaskNotificationState State = EAsyncTaskNotificationState::Pending;
 
    FText TitleText;
 
    FText ProgressText;
 
    FText PromptText;
 
    FSimpleDelegate Hyperlink;
 
    FText HyperlinkText;
private:
    void LogNotification();
 
    const FLogCategoryBase* LogCategory = nullptr;
 
    mutable FCriticalSection SynchronizationObject;
};
 
class FAsyncTaskNotificationFactory
{
    friend class FAsyncTaskNotification;
 
public:
    typedef TSharedPtr<IAsyncTaskNotificationImpl> FImplPointerType;
    typedef TFunction<FImplPointerType()> FFactoryFunc;
 
    static CORE_API FAsyncTaskNotificationFactory& Get();
 
    CORE_API void RegisterFactory(const FName InName, const FFactoryFunc& InFunc);
 
    CORE_API void UnregisterFactory(const FName InName);
 
private:
    CORE_API FImplPointerType InvokeFactory() const;
 
    TArray<TTuple<FName, FFactoryFunc>> Factories;
};