1. Epic GamesDeveloper
  3. FFeedbackContext

FFeedbackContext

A context for displaying modal warning messages.

API > API/Runtime > API/Runtime/Core > API/Runtime/Core/Misc

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

  Type Name Description
Protected variable friend FSlowTask  
Protected variable TArray< TUniquePtr< FSlowTask > > LegacyAPIScopes  
Protected variable FSlowTaskStack ScopeStack Stack of pointers to feedback scopes that are currently open
Protected variable TSharedPtr< FSlowTaskStack > 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

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Protected function void

AddError ( FString&& InError
)

  
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.
Protected function void

AddWarning ( FString&& InWarning
)

  
Public function void

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

  
Public function void Clears all history
Public function Virtual void  
Public function void  
Protected function Virtual void Called to destroy a slow task
Protected function Const void

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

  
Protected function Const void

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

  
Public function Virtual Const FContextSupplier *  
Public function Const void

GetErrors ( TArray< FString >& OutErrors
)

 Gets errors history
Public function void

GetErrorsAndWarningsAndEmpty ( TArray< FString >& OutWarningsAndErrors
)

 Gets all errors and warnings and clears the history
Public function Const int32  
Public function Const int32  
Public function Const const FSlowTaskStack & Public const access to the current state of the scope stack
Protected function Const const TSharedPtr< FSlowTaskStack > &  
Public function Const void

GetWarnings ( TArray< FString >& OutWarnings
)

 Gets warnings history
Protected function Virtual Const bool Called to check whether we are playing in editor when starting a slow task
Public function FOnFinalizeSlowTask &  
Public function FOnStartSlowTask &  
Protected function Virtual void

ProgressReported ( const float TotalProgressInterp,
FText DisplayMessage
)

 Called when some progress has occurred
Public function Virtual bool 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* InContext
)

  
Public function Virtual TWeakPtr< class SBuildProgressWidget > 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 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

Overridden from FOutputDevice

  Type Name Description
Public function Virtual void

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

  
Public function Virtual void

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

  
Public function Virtual void

SerializeRecord ( const UE::FLogRecord& Record
)

  

Classes

  Type Name Description
Public class FOnFinalizeSlowTask    
Public class FOnStartSlowTask    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page