Navigation
API > API/Runtime > API/Runtime/TypedElementFramework
Base class used to construct TEDS UI widgets with. See below for the options to register a constructor with the Data Storage. In most cases you want to inherit from FSimpleWidgetConstructor instead which has a simpler pipeline to create widgets
| Name | FTypedElementWidgetConstructor |
| Type | struct |
| Header File | /Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageUiInterface.h |
| Include Path | #include "Elements/Interfaces/TypedElementDataStorageUiInterface.h" |
Syntax
USTRUCT ()
struct FTypedElementWidgetConstructor : public FTedsWidgetConstructorBase
Inheritance Hierarchy
- FTedsWidgetConstructorBase → FTypedElementWidgetConstructor
Derived Classes
- FSimpleWidgetConstructor
- FPackagePathWidgetConstructor
- FRowHandleWidgetConstructor
- FTypeInfoWidgetConstructor
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Elements/Interfaces/TypedElementDataStorageUiInterface.h | |||
FTypedElementWidgetConstructor
(
const UScriptStruct* InTypeInfo |
Elements/Interfaces/TypedElementDataStorageUiInterface.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FTypedElementWidgetConstructor() |
Elements/Interfaces/TypedElementDataStorageUiInterface.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TSharedPtr< SWidget > Construct
(
UE::Editor::DataStorage::RowHandle Row, |
Constructs the widget according to the provided information. | Elements/Interfaces/TypedElementDataStorageUiInterface.h | |
virtual TArray< TSharedPtr< const UE::Editor::DataStorage::FColumnSorterInterface > > ConstructColumnSorters
(
UE::Editor::DataStorage::ICoreProvider* DataStorage, |
Constructs a list of classes that are used to sort the rows with the column(s) associated with this widget constructor. | Elements/Interfaces/TypedElementDataStorageUiInterface.h | |
virtual TSharedPtr< SWidget > ConstructFinalWidget
(
UE::Editor::DataStorage::RowHandle Row, |
Calls Construct() to create the internal widget, and then stores it in a container before returning. | Elements/Interfaces/TypedElementDataStorageUiInterface.h | |
virtual FString CreateWidgetDisplayName
(
UE::Editor::DataStorage::ICoreProvider* DataStorage, |
Deprecated public functions Returns a friendly name for the data the created widget represents. | Elements/Interfaces/TypedElementDataStorageUiInterface.h | |
virtual FText CreateWidgetDisplayNameText
(
UE::Editor::DataStorage::ICoreProvider* DataStorage, |
Returns an FText of the friendly name for the data the created widget represents. | Elements/Interfaces/TypedElementDataStorageUiInterface.h | |
virtual TConstArrayView< const UScriptStruct * > GetAdditionalColumnsList() |
Returns a list of additional columns the widget requires to be added to its rows. | Elements/Interfaces/TypedElementDataStorageUiInterface.h | |
virtual const UE::Editor::DataStorage::Queries::FConditions * GetQueryConditions () |
Retrieves the query conditions that need to match for this widget constructor to produce a widget. | Elements/Interfaces/TypedElementDataStorageUiInterface.h | |
UE::Editor::DataStorage::RowHandle GetWidgetFactoryRow() |
Helper function to get the row containing the widget factory this constructor was factoried from | Elements/Interfaces/TypedElementDataStorageUiInterface.h | |
virtual bool Initialize
(
const UE::Editor::DataStorage::FMetaDataView& InArguments, |
Initializes a new constructor based on the provided arguments.. | Elements/Interfaces/TypedElementDataStorageUiInterface.h |
Overridden from FTedsWidgetConstructorBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual const UE::Editor::DataStorage::Queries::FConditions * GetQueryConditions
(
const UE::Editor::DataStorage::ICoreProvider* Storage |
Retrieves the query conditions that need to match for this widget constructor to produce a widget. | Elements/Interfaces/TypedElementDataStorageUiInterface.h | |
virtual bool Initialize
(
const UE::Editor::DataStorage::FMetaDataView& InArguments, |
To get around name hiding since the deprecated functions overload methods from the base class. | Elements/Interfaces/TypedElementDataStorageUiInterface.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddDefaultWidgetColumns
(
UE::Editor::DataStorage::RowHandle Row, |
Add the default misc columns we want a widget row to have. | Elements/Interfaces/TypedElementDataStorageUiInterface.h | |
virtual TSharedPtr< SWidget > CreateWidget
(
const UE::Editor::DataStorage::FMetaDataView& Arguments |
Create a new instance of the target widget. This is a required function. | Elements/Interfaces/TypedElementDataStorageUiInterface.h | |
virtual TSharedPtr< SWidget > CreateWidget
(
UE::Editor::DataStorage::ICoreProvider* DataStorage, |
Create a new instance of the target widget. This is a required function. | Elements/Interfaces/TypedElementDataStorageUiInterface.h | |
virtual FText DescribeColumnType
(
const UScriptStruct* ColumnType |
Creates a (friendly) name for the provided column type. | Elements/Interfaces/TypedElementDataStorageUiInterface.h | |
virtual bool FinalizeWidget
(
UE::Editor::DataStorage::ICoreProvider* DataStorage, |
Last opportunity to configure anything in the widget or the row. | Elements/Interfaces/TypedElementDataStorageUiInterface.h | |
UE::Editor::DataStorage::RowHandle GetTargetRow
(
UE::Editor::DataStorage::ICoreProvider* DataStorage, |
Helper function to get the actual target row with the data the widget is operating on (if applicable). | Elements/Interfaces/TypedElementDataStorageUiInterface.h | |
virtual bool SetColumns
(
UE::Editor::DataStorage::ICoreProvider* DataStorage, |
Set any values in columns if needed. | Elements/Interfaces/TypedElementDataStorageUiInterface.h |