FFeedbackContext

A context for displaying modal warning messages.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Misc/FeedbackContext.h

Include

#include "Misc/FeedbackContext.h"

Syntax

class FFeedbackContext : public FOutputDevice

Remarks

A context for displaying modal warning messages.

Variables

Name Description

Protected variable

friend

 

FSlowTask

Protected variable

TArray< TUnique...

 

LegacyAPIScopes

Protected variable

FSlowTaskStack

 

ScopeStack

Stack of pointers to feedback scopes that are currently open

Protected variable

TSharedPtr< FSl...

 

ScopeStackSharedPtr

Points to the ScopeStack above when initialized - this is because Slate wants a TSharedPtr, but we don't want to allocate

Public variable

bool

 

TreatWarningsAsErrors

Constructors

Name Description

Public function

FFeedbackContext()

Destructors

Name Description

Public function Virtual

~FFeedbackContext()

Functions

Name Description

Protected function

void

 

AddError

(
    const FString& InError
)

Adds a new error message to errors history.

Protected function

void

 

AddWarning

(
    const FString& InWarning
)

Adds a new warning message to warnings history.

Public function

void

 

BeginSlowTask

(
    const FText& Task,
    bool ShowProgressDialog,
    bool bShowCancelButton
)

Public function

void

 

ClearWarningsAndErrors()

Clears all history

Public function Virtual

void

 

CloseBuildProgressWindow()

Public function

void

 

EndSlowTask()

Protected function Virtual

void

 

FinalizeSlowTask()

Called to destroy a slow task

Public function Virtual Const

FContextSupp...

 

GetContext()

Public function Const

void

 

GetErrors

(
    TArray< FString >& OutErrors
)

Gets errors history

Public function

void

 

GetErrorsAndWarningsAndEmpty

(
    TArray< FString >& OutWarningsAndE...
)

Gets all errors and warnings and clears the history

Public function Const

int32

 

GetNumErrors()

Public function Const

int32

 

GetNumWarnings()

Public function Const

const FSlowT...

 

GetScopeStack()

Public const access to the current state of the scope stack

Protected function Const

const TShare...

 

GetScopeStackSharedPtr()

Public function Const

void

 

GetWarnings

(
    TArray< FString >& OutWarnings
)

Gets warnings history

Protected function Virtual Const

bool

 

IsPlayingInEditor()

Called to check whether we are playing in editor when starting a slow task

Protected function Virtual

void

 

ProgressReported

(
    const float TotalProgressInterp,
    FText DisplayMessage
)

Called when some progress has occurred

Public function Virtual

bool

 

ReceivedUserCancel()

Whether or not the user has canceled out of the progress dialog (i.e. the ongoing slow task or the last one that ran).

Protected function

void

 

RequestUpdateUI

(
    bool bForceUpdate
)

Ask that the UI be updated as a result of the scope stack changing

Public function Virtual

void

 

SetContext

(
    FContextSupplier* InSupplier
)

Public function Virtual

TWeakPtr< cl...

 

ShowBuildProgressWindow()

Shows/Closes Special Build Progress dialogs

Protected function Virtual

void

 

StartSlowTask

(
    const FText& Task,
    bool bShowCancelButton
)

Called to create a slow task

Public function

void

 

StatusForceUpdate

(
    int32 Numerator,
    int32 Denominator,
    const FText& StatusText
)

Public function

void

 

StatusUpdate

(
    int32 Numerator,
    int32 Denominator,
    const FText& StatusText
)

Public function

void

 

UpdateProgress

(
    int32 Numerator,
    int32 Denominator
)

Protected function

void

 

UpdateUI()

Update the UI as a result of the scope stack changing

Public function Virtual

bool

 

YesNof

(
    const FText& Question
)

Ask the user a binary question, returning their answer