UE::Editor::DataStorage::IUiProvider::FPurposeInfo Struct Reference

#include <TypedElementDataStorageUiInterface.h>

Public Member Functions
TYPEDELEMENTFRAMEWORK_API	FPurposeInfo (const FName &InNamespace, const FName &InName, const FName &InFrame, EPurposeType InPurposeType=EPurposeType::UniqueByNameAndColumn, const FText &InDescription=FText::GetEmpty(), const FPurposeID &InParent=FPurposeID())
TYPEDELEMENTFRAMEWORK_API	FPurposeInfo (const FName &InLegacyPurposeName, EPurposeType InPurposeType, const FText &InDescription, const FPurposeID &InParent=FPurposeID())
TYPEDELEMENTFRAMEWORK_API	FPurposeInfo (const FWidgetPurposeNameColumn &WidgetPurposeNameColumn)
TYPEDELEMENTFRAMEWORK_API FPurposeID	GeneratePurposeID () const
TYPEDELEMENTFRAMEWORK_API FName	ToString () const

Public Attributes
FName	Namespace
FName	Name
FName	Frame
EPurposeType	Type
FText	Description
FPurposeID	ParentPurposeID

Constructor & Destructor Documentation

FPurposeInfo() [1/3]

UE::Editor::DataStorage::IUiProvider::FPurposeInfo::FPurposeInfo	(	const FName &	InNamespace,
		const FName &	InName,
		const FName &	InFrame,
		EPurposeType	InPurposeType = EPurposeType::UniqueByNameAndColumn,
		const FText &	InDescription = FText::GetEmpty(),
		const FPurposeID &	InParent = FPurposeID()
	)

Default constructor for FPurposeInfo, the members with a default value are optional when you only need an FPurposeInfo to look up FPurposeID

FPurposeInfo() [2/3]

UE::Editor::DataStorage::IUiProvider::FPurposeInfo::FPurposeInfo	(	const FName &	InLegacyPurposeName,
		EPurposeType	InPurposeType,
		const FText &	InDescription,
		const FPurposeID &	InParent = FPurposeID()
	)

Create an FPurposeInfo struct using a legacy purpose name to parse it as Namespace.Name.Frame (e.g "SceneOutliner.Cell.Large")

FPurposeInfo() [3/3]

UE::Editor::DataStorage::IUiProvider::FPurposeInfo::FPurposeInfo ( const FWidgetPurposeNameColumn &  WidgetPurposeNameColumn )

explicit

Create an FPurposeInfo struct using FWidgetPurposeNameColumn

Member Function Documentation

GeneratePurposeID()

UE::Editor::DataStorage::IUiProvider::FPurposeID UE::Editor::DataStorage::IUiProvider::FPurposeInfo::GeneratePurposeID

(

)

const

Convert this PurposeInfo to a PurposeID that can be used to look up the purpose row

ToString()

FName UE::Editor::DataStorage::IUiProvider::FPurposeInfo::ToString

(

)

const

Convert this PurposeInfo to a human-readable name in the legacy format ("Namespace.Name.Frame")

Member Data Documentation

Description

FText UE::Editor::DataStorage::IUiProvider::FPurposeInfo::Description

A user facing description for the purpose

Frame

FName UE::Editor::DataStorage::IUiProvider::FPurposeInfo::Frame

An optional suffix for the purpose (e.g "Large", "Small", "Default")

Name

FName UE::Editor::DataStorage::IUiProvider::FPurposeInfo::Name

The name of the purpose (e.g "RowLabel", "Cell")

Namespace

FName UE::Editor::DataStorage::IUiProvider::FPurposeInfo::Namespace

The namespace the purpose belongs to (e.g "General", "SceneOutliner")

ParentPurposeID

FPurposeID UE::Editor::DataStorage::IUiProvider::FPurposeInfo::ParentPurposeID

The parent purpose. If valid, widget construction methods will go up the hierarchy if no widgets were found for a purpose

Type

EPurposeType UE::Editor::DataStorage::IUiProvider::FPurposeInfo::Type

The purpose type

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/TypedElementFramework/Public/Elements/Interfaces/TypedElementDataStorageUiInterface.h
• Engine/Source/Runtime/TypedElementFramework/Private/Elements/Interfaces/TypedElementDataStorageUiInterface.cpp