1. Epic GamesDeveloper
  3. FFeedbackContext

FFeedbackContext

A context for displaying modal warning messages.

API > API/Runtime > API/Runtime/Core

A context for displaying modal warning messages.

   
Name FFeedbackContext
Type class
Header File /Engine/Source/Runtime/Core/Public/Misc/FeedbackContext.h
Include Path #include "Misc/FeedbackContext.h"

Syntax

class FFeedbackContext : public FOutputDevice

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers
  Misc/FeedbackContext.h  
  Misc/FeedbackContext.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FFeedbackContext()

   Misc/FeedbackContext.h  

Classes

Name Remarks
FOnFinalizeSlowTask  
FOnFinalizeSlowTaskWithGuid  
FOnStartSlowTask  
FOnStartSlowTaskWithGuid  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
TreatErrorsAsWarnings bool Demote any logged errors so that they act as warnings; takes priority over TreatWarningsAsErrors Misc/FeedbackContext.h  
TreatWarningsAsErrors bool Promote any logged warnings so that they act as errors Misc/FeedbackContext.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
Errors TArray< FString > Errors history Misc/FeedbackContext.h  
FinalizeSlowTaskEvent FOnFinalizeSlowTask   Misc/FeedbackContext.h  
FinalizeSlowTaskWithGuidEvent FOnFinalizeSlowTaskWithGuid   Misc/FeedbackContext.h  
StartSlowTaskEvent FOnStartSlowTask   Misc/FeedbackContext.h  
StartSlowTaskWithGuidEvent FOnStartSlowTaskWithGuid   Misc/FeedbackContext.h  
TaskGuid FGuid   Misc/FeedbackContext.h  
TaskName FText The name of any task we are running Misc/FeedbackContext.h  
TaskStartTime double   Misc/FeedbackContext.h  
Warnings TArray< FString > Warnings history Misc/FeedbackContext.h  
WarningsAndErrorsCritical FCriticalSection Guard for the errors and warnings history Misc/FeedbackContext.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

   Misc/FeedbackContext.h  

void ClearWarningsAndErrors()

 Clears all history Misc/FeedbackContext.h  

virtual void CloseBuildProgressWindow()

   Misc/FeedbackContext.h  

void EndSlowTask()

   Misc/FeedbackContext.h  

virtual FContextSupplier * GetContext()

   Misc/FeedbackContext.h  

void GetErrors ( TArray< FString >& OutErrors
) const

 Gets errors history Misc/FeedbackContext.h  

void GetErrorsAndWarningsAndEmpty ( TArray< FString >& OutWarningsAndErrors
)

 Gets all errors and warnings and clears the history Misc/FeedbackContext.h  

int32 GetNumErrors()

   Misc/FeedbackContext.h  

int32 GetNumWarnings()

   Misc/FeedbackContext.h  

const FSlowTaskStack & GetScopeStack()

 Public const access to the current state of the scope stack Misc/FeedbackContext.h  

void GetWarnings ( TArray< FString >& OutWarnings
) const

 Gets warnings history Misc/FeedbackContext.h  

FOnFinalizeSlowTask & OnFinalizeSlowTask()

   Misc/FeedbackContext.h  

FOnFinalizeSlowTaskWithGuid & OnFinalizeSlowTaskWithGuid()

   Misc/FeedbackContext.h  

FOnStartSlowTask & OnStartSlowTask()

   Misc/FeedbackContext.h  

FOnStartSlowTaskWithGuid & OnStartSlowTaskWithGuid()

   Misc/FeedbackContext.h  

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). Misc/FeedbackContext.h  

virtual void SetContext ( FContextSupplier* InContext
)

   Misc/FeedbackContext.h  

virtual TWeakPtr< class SBuildProgressWidget > ShowBuildProgressWindow()

 Shows/Closes Special Build Progress dialogs Misc/FeedbackContext.h  

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

   Misc/FeedbackContext.h  

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

   Misc/FeedbackContext.h  

void UpdateProgress ( int32 Numerator,
int32 Denominator
)

   Misc/FeedbackContext.h  

virtual bool YesNof ( const FText& Question
)

 Ask the user a binary question, returning their answer Misc/FeedbackContext.h  

Overridden from FOutputDevice

Name Remarks Include Path Unreal Specifiers

virtual void Serialize ( const TCHAR* V,
ELogVerbosity::Type Verbosity,
const FName& Category
)

   Misc/FeedbackContext.h  

virtual void Serialize ( const TCHAR* V,
ELogVerbosity::Type Verbosity,
const FName& Category,
double Time
)

   Misc/FeedbackContext.h  

virtual void SerializeRecord ( const UE::FLogRecord& Record
)

   Misc/FeedbackContext.h  

Protected

Name Remarks Include Path Unreal Specifiers

void AddError ( FString&& InError
)

   Misc/FeedbackContext.h  

void AddError ( const FString& InError
)

 Adds a new error message to errors history. Misc/FeedbackContext.h  

void AddWarning ( const FString& InWarning
)

 Adds a new warning message to warnings history. Misc/FeedbackContext.h  

void AddWarning ( FString&& InWarning
)

   Misc/FeedbackContext.h  

virtual void FinalizeSlowTask()

 Called to destroy a slow task Misc/FeedbackContext.h  

void FormatLine ( FStringBuilderBase& Out,
const TCHAR* V,
ELogVerbosity::Type Verbosity,
const FName& Category,
double Time,
ELogVerbosity::Type* OutVerbosity
) const

   Misc/FeedbackContext.h  

void FormatRecordLine ( FStringBuilderBase& Out,
const UE::FLogRecord& Record,
ELogVerbosity::Type* OutVerbosity
) const

   Misc/FeedbackContext.h  

const TSharedPtr< FSlowTaskStack > & GetScopeStackSharedPtr()

   Misc/FeedbackContext.h  

virtual bool IsPlayingInEditor()

 Called to check whether we are playing in editor when starting a slow task Misc/FeedbackContext.h  

virtual void ProgressReported ( const float TotalProgressInterp,
FText DisplayMessage
)

 Called when some progress has occurred Misc/FeedbackContext.h  

void RequestUpdateUI ( bool bForceUpdate
)

 Ask that the UI be updated as a result of the scope stack changing Misc/FeedbackContext.h  

ELogVerbosity::Type ResolveVerbosity ( ELogVerbosity::Type Verbosity
) const

   Misc/FeedbackContext.h  

virtual void StartSlowTask ( const FText& Task,
bool bShowCancelButton
)

 Called to create a slow task Misc/FeedbackContext.h  

void UpdateUI()

 Update the UI as a result of the scope stack changing Misc/FeedbackContext.h  

Operators

Name Remarks Include Path Unreal Specifiers

FFeedbackContext & operator= ( const FFeedbackContext&
)

   Misc/FeedbackContext.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page