Navigation
API > API/Editor > API/Editor/PropertyEditor
The builder for laying custom details
| Name | IDetailLayoutBuilder |
| Type | class |
| Header File | /Engine/Source/Editor/PropertyEditor/Public/DetailLayoutBuilder.h |
| Include Path | #include "DetailLayoutBuilder.h" |
Syntax
class IDetailLayoutBuilder
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IDetailLayoutBuilder() |
DetailLayoutBuilder.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnCategorySortOrderFunction | TFunction< void(const TMap< FName, IDetailCategoryBuilder * > &)> | DetailLayoutBuilder.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FDetailWidgetRow & AddCustomRowToCategory
(
TSharedPtr< IPropertyHandle > InPropertyHandle, |
Adds a custom row to the property's category automatically. | DetailLayoutBuilder.h | |
TSharedPtr< IPropertyHandle > AddObjectPropertyData
(
TConstArrayView< UObject* > Objects, |
Adds an external object's property to this details panel's PropertyMap. | DetailLayoutBuilder.h | |
IDetailPropertyRow & AddPropertyToCategory
(
TSharedPtr< IPropertyHandle > InPropertyHandle |
Adds the property to its given category automatically. | DetailLayoutBuilder.h | |
TSharedPtr< IPropertyHandle > AddStructurePropertyData
(
const TSharedPtr< FStructOnScope >& StructData, |
Adds an external structure's property data to this details panel's PropertyMap. | DetailLayoutBuilder.h | |
void DisableInstancedReference
(
TSharedRef< IPropertyHandle > PropertyHandle |
Force a property to behave as a normal, peer reference regardless of CPF_InstancedReference | DetailLayoutBuilder.h | |
bool DoesCategoryHaveGeneratedChildren
(
FName CategoryName |
DetailLayoutBuilder.h | ||
IDetailCategoryBuilder & EditCategory
(
FName CategoryName, |
Edits an existing category or creates a new one | DetailLayoutBuilder.h | |
IDetailCategoryBuilder & EditCategoryAllowNone
(
FName CategoryName, |
Edits an existing category or creates a new one If CategoryName is NAME_None, will enable access to properties without categories | DetailLayoutBuilder.h | |
IDetailPropertyRow * EditDefaultProperty
(
TSharedPtr< IPropertyHandle > InPropertyHandle |
Allows for the customization of a property row for a property that already exists on a class being edited in the details panel The property will remain in the default location but the widget or other attributes for the property can be changed Note This cannot be used to customize other customizations | DetailLayoutBuilder.h | |
IDetailPropertyRow * EditPropertyFromRoot
(
TSharedPtr< IPropertyHandle > InPropertyHandle |
Get the property row from the root of the details panel after it's been constructed, so this will work with default or custom properties | DetailLayoutBuilder.h | |
void ForceRefreshDetails() |
Refreshes the details view and regenerates all the customized layouts Use only when you need to remove or add complicated dynamic items | DetailLayoutBuilder.h | |
UClass * GetBaseClass() |
DetailLayoutBuilder.h | ||
void GetCategoryNames
(
TArray< FName >& OutCategoryNames |
Gets the current set of existing category names. | DetailLayoutBuilder.h | |
| DetailLayoutBuilder.h | |||
const IDetailsView * GetDetailsView () |
DetailLayoutBuilder.h | ||
| DetailLayoutBuilder.h | |||
TSharedPtr< const IDetailsView > GetDetailsViewSharedPtr () |
DetailLayoutBuilder.h | ||
void GetObjectsBeingCustomized
(
TArray< TWeakObjectPtr< UObject > >& OutObjects |
Gets the current object(s) being customized by this builder | DetailLayoutBuilder.h | |
TArray< TWeakObjectPtr< ObjectType > > GetObjectsOfTypeBeingCustomized () |
Gets the current object(s) being customized by this builder of ObjectType | DetailLayoutBuilder.h | |
TSharedRef< IPropertyHandle > GetProperty
(
const FName PropertyPath, |
Gets a handle to a property which can be used to read and write the property value and identify the property in other detail customization interfaces. | DetailLayoutBuilder.h | |
TSharedRef< IPropertyUtilities > GetPropertyUtilities() |
DetailLayoutBuilder.h | ||
const TArray< TWeakObjectPtr< UObject > > & GetSelectedObjects () |
Get the root objects observed by this layout. | DetailLayoutBuilder.h | |
TArray< TWeakObjectPtr< ObjectType > > GetSelectedObjectsOfType () |
Get the root objects (of ObjectType) observed by this layout. | DetailLayoutBuilder.h | |
void GetStructsBeingCustomized
(
TArray< TSharedPtr< FStructOnScope > >& OutStructs |
Gets the current struct(s) being customized by this builder | DetailLayoutBuilder.h | |
TSharedPtr< class FAssetThumbnailPool > GetThumbnailPool() |
Gets the thumbnail pool that should be used for rendering thumbnails in the details view | DetailLayoutBuilder.h | |
FName GetTopLevelProperty() |
Gets the top level property, for showing the warning for experimental or early access class | DetailLayoutBuilder.h | |
bool HasClassDefaultObject() |
DetailLayoutBuilder.h | ||
void HideCategory
(
FName CategoryName |
Hides an entire category | DetailLayoutBuilder.h | |
void HideProperty
(
const TSharedPtr< IPropertyHandle > PropertyHandle |
Hides a property from view | DetailLayoutBuilder.h | |
void HideProperty
(
FName PropertyPath, |
Hides a property from view | DetailLayoutBuilder.h | |
bool IsPropertyPathAllowed
(
const FString& InPath |
DetailLayoutBuilder.h | ||
bool IsPropertyVisible
(
TSharedRef< IPropertyHandle > PropertyHandle |
DetailLayoutBuilder.h | ||
bool IsPropertyVisible
(
const FPropertyAndParent& PropertyAndParent |
DetailLayoutBuilder.h | ||
void RegisterInstancedCustomPropertyTypeLayout
(
FName PropertyTypeName, |
Registers a custom detail layout delegate for a specific type in this layout only | DetailLayoutBuilder.h | |
void SetPropertyGenerationAllowListPaths
(
const TSet< FString >& InPropertyGenerationAllowListPaths |
This function sets property paths to generate PropertyNodes.This improves the performance for cases where PropertyView is only showing a few properties of the object by not generating all other PropertyNodes | DetailLayoutBuilder.h | |
void SortCategories
(
const FOnCategorySortOrderFunction& SortFunction |
Adds sort algorythm which overrides standard algorythm with that provided by the caller. | DetailLayoutBuilder.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FSlateFontInfo GetDetailFont() |
DetailLayoutBuilder.h | ||
static FSlateFontInfo GetDetailFontBold() |
DetailLayoutBuilder.h | ||
static FSlateFontInfo GetDetailFontItalic() |
DetailLayoutBuilder.h |