MCRO
C++23 utilities for Unreal Engine.
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages Concepts
Mcro::Error::IErrorDisplayExtension Class Reference

A modular feature which allows other modules to inject their own UI into the common error display widget. More...

#include <SErrorDisplay.h>

Inheritance diagram for Mcro::Error::IErrorDisplayExtension:
Mcro::AutoModularFeature::TAutoModularFeature< IErrorDisplayExtension > Mcro::AutoModularFeature::IAutoModularFeature

Public Member Functions

virtual bool SupportsError (IErrorRef const &error)
 
virtual TSharedPtr< SWidget > PostSeverity (IErrorRef const &error)
 
virtual TSharedPtr< SWidget > PostMessage (IErrorRef const &error)
 
virtual TSharedPtr< SWidget > PostDetails (IErrorRef const &error)
 
virtual TSharedPtr< SWidget > PostCodeContext (IErrorRef const &error)
 
virtual TSharedPtr< SWidget > PostErrorPropagation (IErrorRef const &error)
 
virtual TSharedPtr< SWidget > PostInnerErrors (IErrorRef const &error)
 
- Public Member Functions inherited from Mcro::AutoModularFeature::TAutoModularFeature< IErrorDisplayExtension >
void Register (this Implementation &&self)
 Call this function in implementation constructors.
 
virtual ~TAutoModularFeature ()
 

Additional Inherited Members

- Public Types inherited from Mcro::AutoModularFeature::TAutoModularFeature< IErrorDisplayExtension >
using Feature
 
using AutoModularFeature
 
- Static Public Member Functions inherited from Mcro::AutoModularFeature::TAutoModularFeature< IErrorDisplayExtension >
static auto OnRegistered () -> TBelatedEventDelegate< void(Feature *)> &
 This event is triggered when an implementation of this feature is created.
 
static FORCEINLINE FName FeatureName ()
 Get the name of the feature.
 
static FORCEINLINE int32 ImplementationCount ()
 
static FORCEINLINE FeatureGet ()
 Get the first existing implementation of this feature. If there are no implementations a check will fail.
 
static FORCEINLINE FeatureTryGet (const int32 index)
 Get the first existing implementation of this feature. Return nullptr If there are no implementations.
 
static FORCEINLINE TArray< Feature * > GetAll ()
 
static FORCEINLINE TFuture< Feature * > GetBelated ()
 Get the first implementation once it is registered, or return the first implementation immediately if there's already one registered.
 

Detailed Description

A modular feature which allows other modules to inject their own UI into the common error display widget.

Of course these functions are only triggered when an error is using SErrorDisplay as its widget type, but errors may declare any other widget type to be used to represent themselves.

Definition at line 31 of file SErrorDisplay.h.

Member Function Documentation

◆ PostCodeContext()

virtual TSharedPtr< SWidget > Mcro::Error::IErrorDisplayExtension::PostCodeContext ( IErrorRef const & error)
inlinevirtual

Definition at line 38 of file SErrorDisplay.h.

◆ PostDetails()

virtual TSharedPtr< SWidget > Mcro::Error::IErrorDisplayExtension::PostDetails ( IErrorRef const & error)
inlinevirtual

Definition at line 37 of file SErrorDisplay.h.

◆ PostErrorPropagation()

virtual TSharedPtr< SWidget > Mcro::Error::IErrorDisplayExtension::PostErrorPropagation ( IErrorRef const & error)
inlinevirtual

Definition at line 39 of file SErrorDisplay.h.

◆ PostInnerErrors()

virtual TSharedPtr< SWidget > Mcro::Error::IErrorDisplayExtension::PostInnerErrors ( IErrorRef const & error)
inlinevirtual

Definition at line 40 of file SErrorDisplay.h.

◆ PostMessage()

virtual TSharedPtr< SWidget > Mcro::Error::IErrorDisplayExtension::PostMessage ( IErrorRef const & error)
inlinevirtual

Definition at line 36 of file SErrorDisplay.h.

◆ PostSeverity()

virtual TSharedPtr< SWidget > Mcro::Error::IErrorDisplayExtension::PostSeverity ( IErrorRef const & error)
inlinevirtual

Definition at line 35 of file SErrorDisplay.h.

◆ SupportsError()

virtual bool Mcro::Error::IErrorDisplayExtension::SupportsError ( IErrorRef const & error)
inlinevirtual

Definition at line 34 of file SErrorDisplay.h.


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