Navigation
API > API/Runtime > API/Runtime/TypedElementFramework > API/Runtime/TypedElementFramework/IUiProvider
Struct describing the default init params for a widget purpose. These can also be added to the purpose row post init using the columns in WidgetPurposeColumns.h
| Name | FPurposeInfo |
| Type | struct |
| Header File | /Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageUiInterface.h |
| Include Path | #include "Elements/Interfaces/TypedElementDataStorageUiInterface.h" |
Syntax
struct FPurposeInfo
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FPurposeInfo
(
const FWidgetPurposeNameColumn& WidgetPurposeNameColumn |
Create an FPurposeInfo struct using FWidgetPurposeNameColumn | Elements/Interfaces/TypedElementDataStorageUiInterface.h | |
FPurposeInfo
(
const FName& InLegacyPurposeName, |
Create an FPurposeInfo struct using a legacy purpose name to parse it as Namespace.Name.Frame (e.g "SceneOutliner.Cell.Large") | Elements/Interfaces/TypedElementDataStorageUiInterface.h | |
FPurposeInfo
(
const FName& InNamespace, |
Default constructor for FPurposeInfo, the members with a default value are optional when you only need an FPurposeInfo to look up FPurposeID | Elements/Interfaces/TypedElementDataStorageUiInterface.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Description | FText | A user facing description for the purpose | Elements/Interfaces/TypedElementDataStorageUiInterface.h | |
| Frame | FName | An optional suffix for the purpose (e.g "Large", "Small", "Default") | Elements/Interfaces/TypedElementDataStorageUiInterface.h | |
| Name | FName | The name of the purpose (e.g "RowLabel", "Cell") | Elements/Interfaces/TypedElementDataStorageUiInterface.h | |
| Namespace | FName | The namespace the purpose belongs to (e.g "General", "SceneOutliner") | Elements/Interfaces/TypedElementDataStorageUiInterface.h | |
| ParentPurposeID | FPurposeID | The parent purpose. | Elements/Interfaces/TypedElementDataStorageUiInterface.h | |
| Type | EPurposeType | The purpose type | Elements/Interfaces/TypedElementDataStorageUiInterface.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FPurposeID GeneratePurposeID() |
Convert this PurposeInfo to a PurposeID that can be used to look up the purpose row | Elements/Interfaces/TypedElementDataStorageUiInterface.h | |
FName ToString() |
Convert this PurposeInfo to a human-readable name in the legacy format ("Namespace.Name.Frame") | Elements/Interfaces/TypedElementDataStorageUiInterface.h |