FCoreAsyncTaskNotificationImpl Class Reference

#include <CoreAsyncTaskNotificationImpl.h>

Inheritance diagram for FCoreAsyncTaskNotificationImpl:

Public Member Functions
CORE_API	FCoreAsyncTaskNotificationImpl ()
virtual CORE_API	~FCoreAsyncTaskNotificationImpl ()
virtual CORE_API void	Initialize (const FAsyncTaskNotificationConfig &InConfig) override
virtual CORE_API void	SetTitleText (const FText &InTitleText, const bool bClearProgressText) override
virtual CORE_API void	SetProgressText (const FText &InProgressText) override
virtual CORE_API void	SetPromptText (const FText &InPromptText) override
virtual CORE_API void	SetHyperlink (const FSimpleDelegate &InHyperlink, const FText &InHyperlinkText) override
virtual CORE_API void	SetComplete (const bool bSuccess) override
virtual CORE_API void	SetComplete (const FText &InTitleText, const FText &InProgressText, const bool bSuccess) override
virtual CORE_API void	SetNotificationState (const FAsyncNotificationStateData &InState) override
virtual CORE_API void	SetCanCancel (const TAttribute< bool > &InCanCancel) override
virtual CORE_API void	SetKeepOpenOnSuccess (const TAttribute< bool > &InKeepOpenOnSuccess) override
virtual CORE_API void	SetKeepOpenOnFailure (const TAttribute< bool > &InKeepOpenOnFailure) override
virtual CORE_API EAsyncTaskNotificationPromptAction	GetPromptAction () const override
Public Member Functions inherited from IAsyncTaskNotificationImpl
virtual	~IAsyncTaskNotificationImpl ()=default

Protected Member Functions
virtual CORE_API void	UpdateNotification ()

Protected Attributes
EAsyncTaskNotificationState	State = EAsyncTaskNotificationState::Pending
FText	TitleText
FText	ProgressText
FText	PromptText
FSimpleDelegate	Hyperlink
FText	HyperlinkText

Detailed Description

Basic asynchronous task notification that just logs status changes.

Constructor & Destructor Documentation

FCoreAsyncTaskNotificationImpl()

FCoreAsyncTaskNotificationImpl::FCoreAsyncTaskNotificationImpl

(

)

~FCoreAsyncTaskNotificationImpl()

FCoreAsyncTaskNotificationImpl::~FCoreAsyncTaskNotificationImpl ( )

virtual

Member Function Documentation

GetPromptAction()

EAsyncTaskNotificationPromptAction FCoreAsyncTaskNotificationImpl::GetPromptAction ( ) const

overridevirtual

Return the notification prompt action. The action resets to None when the notification state changes.

Implements IAsyncTaskNotificationImpl.

Reimplemented in FSlateAsyncTaskNotificationImpl.

Initialize()

void FCoreAsyncTaskNotificationImpl::Initialize ( const FAsyncTaskNotificationConfig &  InConfig )

overridevirtual

Initialize this notification based on the given config.

Implements IAsyncTaskNotificationImpl.

Reimplemented in FSlateAsyncTaskNotificationImpl.

SetCanCancel()

void FCoreAsyncTaskNotificationImpl::SetCanCancel ( const TAttribute< bool > &  InCanCancel )

overridevirtual

Set whether this task be canceled.

Implements IAsyncTaskNotificationImpl.

Reimplemented in FSlateAsyncTaskNotificationImpl.

SetComplete() [1/2]

void FCoreAsyncTaskNotificationImpl::SetComplete ( const bool  bSuccess )

overridevirtual

Set the task as complete.

Implements IAsyncTaskNotificationImpl.

SetComplete() [2/2]

void FCoreAsyncTaskNotificationImpl::SetComplete ( const FText &  InTitleText, const FText &  InProgressText, const bool  bSuccess  )

overridevirtual

Update the text and set the task as complete.

Implements IAsyncTaskNotificationImpl.

SetHyperlink()

void FCoreAsyncTaskNotificationImpl::SetHyperlink ( const FSimpleDelegate &  InHyperlink, const FText &  InHyperlinkText  )

overridevirtual

Set the hyperlink text of this notification.

Implements IAsyncTaskNotificationImpl.

SetKeepOpenOnFailure()

void FCoreAsyncTaskNotificationImpl::SetKeepOpenOnFailure ( const TAttribute< bool > &  InKeepOpenOnFailure )

overridevirtual

Set whether to keep this notification open on failure.

Implements IAsyncTaskNotificationImpl.

Reimplemented in FSlateAsyncTaskNotificationImpl.

SetKeepOpenOnSuccess()

void FCoreAsyncTaskNotificationImpl::SetKeepOpenOnSuccess ( const TAttribute< bool > &  InKeepOpenOnSuccess )

overridevirtual

Set whether to keep this notification open on success.

Implements IAsyncTaskNotificationImpl.

Reimplemented in FSlateAsyncTaskNotificationImpl.

SetNotificationState()

void FCoreAsyncTaskNotificationImpl::SetNotificationState ( const FAsyncNotificationStateData &  InState )

overridevirtual

Set the task notification state. provides finer control than SetComplete

Implements IAsyncTaskNotificationImpl.

SetProgressText()

void FCoreAsyncTaskNotificationImpl::SetProgressText ( const FText &  InProgressText )

overridevirtual

Set the progress text of this notification.

Implements IAsyncTaskNotificationImpl.

SetPromptText()

void FCoreAsyncTaskNotificationImpl::SetPromptText ( const FText &  InPromptText )

overridevirtual

Set the prompt text of this notification.

Implements IAsyncTaskNotificationImpl.

SetTitleText()

void FCoreAsyncTaskNotificationImpl::SetTitleText ( const FText &  InTitleText, const bool  bClearProgressText  )

overridevirtual

Set the title text of this notification.

Implements IAsyncTaskNotificationImpl.

UpdateNotification()

void FCoreAsyncTaskNotificationImpl::UpdateNotification ( )

protectedvirtual

Update the notification (the critical section is held while this function is called)

Member Data Documentation

Hyperlink

FSimpleDelegate FCoreAsyncTaskNotificationImpl::Hyperlink

protected

When set this will display as a hyperlink on the right side of the notification.

HyperlinkText

FText FCoreAsyncTaskNotificationImpl::HyperlinkText

protected

Text to display for the hyperlink message

ProgressText

FText FCoreAsyncTaskNotificationImpl::ProgressText

protected

The progress text displayed in the notification (if any)

PromptText

FText FCoreAsyncTaskNotificationImpl::PromptText

protected

The text used by the prompt button (if any)

State

EAsyncTaskNotificationState FCoreAsyncTaskNotificationImpl::State = EAsyncTaskNotificationState::Pending

protected

The current state of this notification

TitleText

FText FCoreAsyncTaskNotificationImpl::TitleText

protected

The title text displayed in the notification (if any)

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Core/Public/Misc/CoreAsyncTaskNotificationImpl.h
• Engine/Source/Runtime/Core/Private/Misc/CoreAsyncTaskNotificationImpl.cpp