1. Epic GamesDeveloper
  3. IDetailLayoutBuilder

IDetailLayoutBuilder

The builder for laying custom details

Unreal Engine C++ API Reference > Editor > PropertyEditor

References

   
Module PropertyEditor
Header /Engine/Source/Editor/PropertyEditor/Public/DetailLayoutBuilder.h
Include #include "DetailLayoutBuilder.h"

Syntax

class IDetailLayoutBuilder

Remarks

The builder for laying custom details

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function FDetailWidgetRow &

AddCustomRowToCategory ( TSharedPtr< IPropertyHandle > InPropertyHandle,
const FText& InCustomSearchString,
bool bForAdvanced
)

 Adds a custom row to the property's category automatically.
Public function TSharedPtr< IPropertyHandle >

AddObjectPropertyData ( TConstArrayView< UObject* > Objects,
FName PropertyName
)

 Adds an external object's property to this details panel's PropertyMap.
Public function IDetailPropertyRow &

AddPropertyToCategory ( TSharedPtr< IPropertyHandle > InPropertyHandle
)

 Adds the property to its given category automatically.
Public function TSharedPtr< IPropertyHandle >

AddStructurePropertyData ( const TSharedPtr< FStructOnScope >& StructData,
FName PropertyName
)

 Adds an external structure's property data to this details panel's PropertyMap.
Public function bool

DoesCategoryHaveGeneratedChildren ( FName CategoryName
)

  
Public function IDetailCategoryBuilder &

EditCategory ( FName CategoryName,
const FText& NewLocalizedDisplayName,
ECategoryPriority::Type CategoryType
)

 Edits an existing category or creates a new one
Public function IDetailCategoryBuilder &

EditCategoryAllowNone ( FName CategoryName,
const FText& NewLocalizedDisplayName,
ECategoryPriority::Type CategoryType
)

 Edits an existing category or creates a new one If CategoryName is NAME_None, will enable access to properties without categories
Public function 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
Public function 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
Public function void Refreshes the details view and regenerates all the customized layouts Use only when you need to remove or add complicated dynamic items
Public function Const UClass *  
Public function Const void

GetCategoryNames ( TArray< FName >& OutCategoryNames
)

 Gets the current set of existing category names.
Public function Static FSlateFontInfo  
Public function Static FSlateFontInfo  
Public function Static FSlateFontInfo  
Public function IDetailsView *  
Public function Const const IDetailsView *  
Public function Const void

GetObjectsBeingCustomized ( TArray< TWeakObjectPtr< UObject > >& OutObjects
)

 Gets the current object(s) being customized by this builder
Public function Const TArray< TWeakObjectPtr< ObjectType > > Gets the current object(s) being customized by this builder of ObjectType
Public function Const TSharedRef< IPropertyHandle >

GetProperty ( const FName PropertyPath,
const UStruct* ClassOutermost,
FName InstanceName
)

 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.
Public function Const TSharedRef< IPropertyUtilities >  
Public function Const const TArray< TWeakObjectPtr< UObject > > & Get the root objects observed by this layout.
Public function Const TArray< TWeakObjectPtr< ObjectType > > Get the root objects (of ObjectType) observed by this layout.
Public function Const void

GetStructsBeingCustomized ( TArray< TSharedPtr< FStructOnScope > >& OutStructs
)

 Gets the current struct(s) being customized by this builder
Public function Const TSharedPtr< class FAssetThumbnailPool > Gets the thumbnail pool that should be used for rendering thumbnails in the details view
Public function FName Gets the top level property, for showing the warning for experimental or early access class
Public function Const bool  
Public function void

HideCategory ( FName CategoryName
)

 Hides an entire category
Public function void

HideProperty ( const TSharedPtr< IPropertyHandle > PropertyHandle
)

 Hides a property from view
Public function void

HideProperty ( FName PropertyPath,
const UStruct* ClassOutermost,
FName InstanceName
)

 Hides a property from view
Public function Const bool

IsPropertyPathAllowed ( const FString& InPath
)

  
Public function Const bool

IsPropertyVisible ( TSharedRef< IPropertyHandle > PropertyHandle
)

  
Public function Const bool

IsPropertyVisible ( const FPropertyAndParent& PropertyAndParent
)

  
Public function void

RegisterInstancedCustomPropertyTypeLayout ( FName PropertyTypeName,
FOnGetPropertyTypeCustomizationInstance PropertyTypeLayoutDelegate,
TSharedPtr< IPropertyTypeIdentifier > Identifier
)

 Registers a custom detail layout delegate for a specific type in this layout only
Public function 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
Public function void Adds sort algorythm which overrides standard algorythm with that provided by the caller.

Typedefs

Name Description
FOnCategorySortOrderFunction  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page