1. Epic GamesDeveloper
  3. IUiProvider

IUiProvider

API > API/Runtime > API/Runtime/TypedElementFramework

   
Name IUiProvider
Type class
Header File /Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageUiInterface.h
Include Path #include "Elements/Interfaces/TypedElementDataStorageUiInterface.h"

Syntax

class IUiProvider : public IModularFeature

Structs

Name Remarks
FPurposeInfo Struct describing the default init params for a widget purpose.

Enums

Public

Name Remarks
EMatchApproach  
EPurposeType  

Typedefs

Name Type Remarks Include Path
FPurposeID FMapKey   Elements/Interfaces/TypedElementDataStorageUiInterface.h
PropertySorterConstructorCallback TFunction< TSharedPtr< const FColumnSorterInterface >(TWeakObjectPtr< const UScriptStruct > ColumnType, const FProperty &Property)>   Elements/Interfaces/TypedElementDataStorageUiInterface.h
WidgetConstructorCallback TFunctionRef< bool(TUniquePtr< FTypedElementWidgetConstructor >, TConstArrayView< TWeakObjectPtr< const UScriptStruct > >)>   Elements/Interfaces/TypedElementDataStorageUiInterface.h
WidgetCreatedCallback TFunctionRef< void(const TSharedRef< SWidget > &NewWidget, UE::Editor::DataStorage::RowHandle Row)>   Elements/Interfaces/TypedElementDataStorageUiInterface.h
WidgetPurposeCallback TFunctionRef< void(FName, EPurposeType, const FText &)>   Elements/Interfaces/TypedElementDataStorageUiInterface.h

Constants

Name Type Remarks Include Path
PurposeMappingDomain const FName   Elements/Interfaces/TypedElementDataStorageUiInterface.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

TSharedPtr< SWidget > ConstructInternalWidget ( RowHandle Row,
FTypedElementWidgetConstructor& Constructor,
const FMetaDataView& Arguments
)

 Creates a single widget using the provided constructor. Elements/Interfaces/TypedElementDataStorageUiInterface.h  

TSharedPtr< SWidget > ConstructWidget ( RowHandle Row,
FTypedElementWidgetConstructor& Constructor,
const FMetaDataView& Arguments
)

 Creates a single widget using the provided constructor. Elements/Interfaces/TypedElementDataStorageUiInterface.h  

void ConstructWidgets ( FName Purpose,
const FMetaDataView& Arguments,
const WidgetCreatedCallback& ConstructionCallback
)

   Elements/Interfaces/TypedElementDataStorageUiInterface.h  

void ConstructWidgets ( RowHandle PurposeRow,
const FMetaDataView& Arguments,
const WidgetCreatedCallback& ConstructionCallback
)

 Creates all the widgets registered under the provided purpose. Elements/Interfaces/TypedElementDataStorageUiInterface.h  

TSharedPtr< ITedsWidget > CreateContainerTedsWidget ( RowHandle UiRowHandle
) const

 Create the container widget that every TEDS UI widget is stored in Elements/Interfaces/TypedElementDataStorageUiInterface.h  

void CreateWidgetConstructors ( FName Purpose,
const FMetaDataView& Arguments,
const WidgetConstructorCallback& Callback
)

   Elements/Interfaces/TypedElementDataStorageUiInterface.h  

void CreateWidgetConstructors ( RowHandle PurposeRow,
const FMetaDataView& Arguments,
const WidgetConstructorCallback& Callback
)

 Creates widget constructors for the requested purpose. Elements/Interfaces/TypedElementDataStorageUiInterface.h  

void CreateWidgetConstructors ( RowHandle PurposeRow,
EMatchApproach MatchApproach,
TArray< TWeakObjectPtr< const UScriptStruct > >& Columns,
const FMetaDataView& Arguments,
const WidgetConstructorCallback& Callback
)

 Finds matching widget constructors for provided columns, preferring longer matches over shorter matches. Elements/Interfaces/TypedElementDataStorageUiInterface.h  

void CreateWidgetConstructors ( FName Purpose,
EMatchApproach MatchApproach,
TArray< TWeakObjectPtr< const UScriptStruct > >& Columns,
const FMetaDataView& Arguments,
const WidgetConstructorCallback& Callback
)

   Elements/Interfaces/TypedElementDataStorageUiInterface.h  

RowHandle FindPurpose ( const FPurposeID& PurposeID
) const

 Find the row handle for a purpose by looking it up using the purpose ID Elements/Interfaces/TypedElementDataStorageUiInterface.h  
Generation Elements/Interfaces/TypedElementDataStorageUiInterface.h  

FPurposeID GetDefaultWidgetPurposeID()

 Get the name of the default TEDS UI widget purpose used to register default widgets for different types of data (e.g FText -> STextBlock) Elements/Interfaces/TypedElementDataStorageUiInterface.h  

FPurposeID GetGeneralWidgetPurposeID()

 Get the name of the general TEDS UI purpose used to register general purpose widgets for columns Elements/Interfaces/TypedElementDataStorageUiInterface.h  

TableHandle GetWidgetTable()

 Get the table where TEDS UI widgets are stored Elements/Interfaces/TypedElementDataStorageUiInterface.h  

void ListExtensions ( TFunctionRef< void(FName)> Callback
) const

 Provides a list of all extensions that are enabled. Elements/Interfaces/TypedElementDataStorageUiInterface.h  

void ListWidgetPurposes ( const WidgetPurposeCallback& Callback
) const

 Calls the provided callback for all known registered widget purposes. Elements/Interfaces/TypedElementDataStorageUiInterface.h  

bool RegisterDecoratorWidgetFactory ( RowHandle PurposeRow,
const UScriptStruct* Constructor
)

 Registers a decorator widget factory against a specific column Decorator widgets are added onto TEDS UI widgets for the specified purpose when the widget row has the column/tag they are registered against. Elements/Interfaces/TypedElementDataStorageUiInterface.h  

bool RegisterDecoratorWidgetFactory ( RowHandle PurposeRow,
const UScriptStruct* Constructor,
const UScriptStruct* Column
)

 Registers a decorator widget factory against a specific column. Elements/Interfaces/TypedElementDataStorageUiInterface.h  

void RegisterSorterGeneratorForProperty ( PropertySorterConstructorCallback PropertySorterConstructor
)

 Register a function to handle converting a property into a sorter. Elements/Interfaces/TypedElementDataStorageUiInterface.h  

void RegisterSorterGeneratorForProperty ( const FFieldClass* PropertyType,
PropertySorterConstructorCallback PropertySorterConstructor
)

 Register a function to handle converting a property into a sorter. Elements/Interfaces/TypedElementDataStorageUiInterface.h  
  Elements/Interfaces/TypedElementDataStorageUiInterface.h  
  Elements/Interfaces/TypedElementDataStorageUiInterface.h  

bool RegisterWidgetFactory ( FName Purpose,
const UScriptStruct* Constructor,
Queries::FConditions Columns
)

   Elements/Interfaces/TypedElementDataStorageUiInterface.h  

bool RegisterWidgetFactory ( RowHandle PurposeRow,
TUniquePtr< FTypedElementWidgetConstructor >&& Constructor,
Queries::FConditions Columns
)

   Elements/Interfaces/TypedElementDataStorageUiInterface.h  

bool RegisterWidgetFactory ( RowHandle PurposeRow,
const UScriptStruct* Constructor,
Queries::FConditions Columns
)

 Registers a widget factory that will be called when the purpose it's registered under is requested. Elements/Interfaces/TypedElementDataStorageUiInterface.h  
  Elements/Interfaces/TypedElementDataStorageUiInterface.h  

bool RegisterWidgetFactory ( FName Purpose,
const UScriptStruct* Constructor
)

   Elements/Interfaces/TypedElementDataStorageUiInterface.h  

bool RegisterWidgetFactory ( RowHandle PurposeRow,
TUniquePtr< FTypedElementWidgetConstructor >&& Constructor
)

 DeprecatedPlease replace use of the functions below with the recommended replacements. Elements/Interfaces/TypedElementDataStorageUiInterface.h  

bool RegisterWidgetFactory ( RowHandle PurposeRow,
Queries::FConditions Columns
)

 Registers a widget factory that will be called when the purpose it's registered under is requested. Elements/Interfaces/TypedElementDataStorageUiInterface.h  

bool RegisterWidgetFactory ( RowHandle PurposeRow,
const UScriptStruct* Constructor
)

 Purposes Elements/Interfaces/TypedElementDataStorageUiInterface.h  

bool RegisterWidgetFactory ( FName Purpose
)

 Implementations Elements/Interfaces/TypedElementDataStorageUiInterface.h  

bool RegisterWidgetFactory ( RowHandle PurposeRow
)

 Registers a widget factory that will be called when the purpose it's registered under is requested. Elements/Interfaces/TypedElementDataStorageUiInterface.h  

RowHandle RegisterWidgetPurpose ( const FPurposeInfo& InPurposeInfo
)

 Purposes Elements/Interfaces/TypedElementDataStorageUiInterface.h  

RowHandle RegisterWidgetPurpose ( const FPurposeID& PurposeID,
const FPurposeInfo& InPurposeInfo
)

 Overload for RegisterWidgetPurpose that allows you to use a custom ID to map to the TEDS Mapping table for lookup Elements/Interfaces/TypedElementDataStorageUiInterface.h  

void RegisterWidgetPurpose ( FName Purpose,
EPurposeType Type,
FText Description
)

   Elements/Interfaces/TypedElementDataStorageUiInterface.h  

bool SupportsExtension ( FName Extension
) const

 Functions Elements/Interfaces/TypedElementDataStorageUiInterface.h  
Unregister a function to handle converting a property into a sorter. Elements/Interfaces/TypedElementDataStorageUiInterface.h  

void UnregisterSorterGeneratorForProperty ( const FFieldClass* PropertyType
)

 Unregister a function to handle converting a property into a sorter. Elements/Interfaces/TypedElementDataStorageUiInterface.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page