Navigation
API > API/Runtime > API/Runtime/TypedElementFramework > API/Runtime/TypedElementFramework/IUiProvider
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
RowHandle RegisterWidgetPurpose
(
const FPurposeInfo& InPurposeInfo |
Purposes | Elements/Interfaces/TypedElementDataStorageUiInterface.h | |
RowHandle RegisterWidgetPurpose
(
const FPurposeID& PurposeID, |
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, |
Elements/Interfaces/TypedElementDataStorageUiInterface.h |
RegisterWidgetPurpose(const FPurposeInfo &)
Description
Purposes
Widget purposes indicates how widgets can be used and categorizes/organizes the available widget factories. Purposes as used to match columns to widget constructors and provide contextual information on how the widgets get setup. In practice this allows tools to provide what purposes they support and TEDS UI will find the closest matching widget constructors that are compatible with the purpose. Register a widget purpose. Widget purposes indicates how widgets can be used and categorizes/organizes the available widget factories. If the same purpose is registered multiple times, only the first will be recorded and later registrations will be ignored and the return value will be InvalidRowHandle. The purposes will be mapped to the TEDS Mapping Table using InPurposeInfo.GeneratePurposeID() which can be used to lookup the purpose row.
| Name | RegisterWidgetPurpose |
| Type | function |
| Header File | /Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageUiInterface.h |
| Include Path | #include "Elements/Interfaces/TypedElementDataStorageUiInterface.h" |
RowHandle RegisterWidgetPurpose
(
const FPurposeInfo & InPurposeInfo
)
RegisterWidgetPurpose(const FPurposeID &, const FPurposeInfo &)
Description
Overload for RegisterWidgetPurpose that allows you to use a custom ID to map to the TEDS Mapping table for lookup
| Name | RegisterWidgetPurpose |
| Type | function |
| Header File | /Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageUiInterface.h |
| Include Path | #include "Elements/Interfaces/TypedElementDataStorageUiInterface.h" |
RowHandle RegisterWidgetPurpose
(
const FPurposeID & PurposeID,
const FPurposeInfo & InPurposeInfo
)
Parameters
| Name | Remarks |
|---|---|
| PurposeID | A unique ID for the purpose that can be used to look up the row handle later |
| InPurposeInfo | Struct with init params for the purpose |
RegisterWidgetPurpose(FName, EPurposeType, FText)
| Name | RegisterWidgetPurpose |
| Type | function |
| Header File | /Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageUiInterface.h |
| Include Path | #include "Elements/Interfaces/TypedElementDataStorageUiInterface.h" |
void RegisterWidgetPurpose
(
FName Purpose,
EPurposeType Type,
FText Description
)