IDetailLayoutBuilder

The builder for laying custom details

Windows
MacOS
Linux

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

Name Description

Public function Virtual

~IDetailLayoutBuilder()

Functions

Name Description

Public function

FDetailWidge ...

 

AddCustomRowToCategory

(
    TSharedPtr < IPropertyHandle > InPro...,
    const FText & InCustomSearchString,
    bool bForAdvanced
)

Adds a custom row to the property's category automatically.

Public function

IDetailPrope ...

 

AddPropertyToCategory

(
    TSharedPtr < IPropertyHandle > InPro...
)

Adds the property to its given category automatically.

Public function

IDetailCateg ...

 

EditCategory

(
    FName CategoryName,
    const FText & NewLocalizedDisplayNa...,
    ECategoryPriority::Type CategoryTyp...
)

Edits an existing category or creates a new one

Public function

IDetailPrope ...

 

EditDefaultProperty

(
    TSharedPtr < IPropertyHandle > InPro...
)

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

void

 

ForceRefreshDetails()

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 *

 

GetBaseClass()

Public function Const

void

 

GetCategoryNames

(
    TArray < FName >& OutCategoryNames
)

Gets the current set of existing category names.

Public function Static

FSlateFontIn ...

 

GetDetailFont()

Public function Static

FSlateFontIn ...

 

GetDetailFontBold()

Public function Static

FSlateFontIn ...

 

GetDetailFontItalic()

Public function Const

const IDetai ...

 

GetDetailsView()

Public function Const

void

 

GetObjectsBeingCustomized

(
    TArray < TWeakObjectPtr < UObject > >...
)

Gets the current object(s) being customized by this builder

Public function Const

TSharedRef < ...

 

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

const TShare ...

 

GetPropertyUtilities()

Public function Const

const TArray ...

 

GetSelectedObjects()

Get the root objects observed by this layout.

Public function Const

void

 

GetStructsBeingCustomized

(
    TArray < TSharedPtr < FStructOnScope ...
)

Gets the current struct(s) being customized by this builder

Public function Const

TSharedPtr < ...

 

GetThumbnailPool()

Gets the thumbnail pool that should be used for rendering thumbnails in the details view

Public function

FName

 

GetTopLevelProperty()

Gets the top level property, for showing the warning for experimental or early access class

Public function Const

bool

 

HasClassDefaultObject()

Public function

void

 

HideCategory

(
    FName CategoryName
)

Hides an entire category

Public function

void

 

HideProperty

(
    const TSharedPtr < IPropertyHandle >...
)

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

 

IsPropertyVisible

(
    TSharedRef < IPropertyHandle > Prope...
)

Public function Const

bool

 

IsPropertyVisible

(
    const FPropertyAndParent & Property...
)

Public function

void

 

RegisterInstancedCustomPropertyTypeLayout

(
    FName PropertyTypeName,
    FOnGetPropertyTypeCustomizationInst ...,
    TSharedPtr < IPropertyTypeIdentifier ...
)

Registers a custom detail layout delegate for a specific type in this layout only

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback