Language:
Discover
By Skill Level
By Category

IDetailLayoutBuilder

Choose your OS:

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

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

UClass *

 

GetBaseClass()

The base class of the objects being customized in this detail layout

Public function Static

FSlateFontIn ...

 

GetDetailFont()

The font used for properties and details

Public function Static

FSlateFontIn ...

 

GetDetailFontBold()

The bold font used for properties and details

Public function Static

FSlateFontIn ...

 

GetDetailFontItalic()

The italic font used for properties and details

Public function

const IDetai ...

 

GetDetailsView()

The parent detail view for this layout builder

Public function

void

 

GetObjectsBeingCustomized

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

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

Public function

TSharedRef < ...

 

GetProperty

(
    const FName PropertyPath,
    const UClass * 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 TShare ...

 

GetPropertyUtilities()

The utilities various widgets need access to certain features of PropertyDetails

Public function

const TArray ...

 

GetSelectedObjects()

Get the root objects observed by this layout.

Public function

void

 

GetStructsBeingCustomized

(
    TArray < TSharedPtr < FStructOnScope ...
)

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

Public function

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

bool

 

HasClassDefaultObject()

True if an object in the builder is a class default object

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 UClass * ClassOutermost,
    FName InstanceName
)

Hides a property from view

Public function

bool

 

IsPropertyVisible

(
    TSharedRef < IPropertyHandle > Prope...
)

True if the property should be visible in the details panel or false if the specific details panel is not showing this property

Public function

bool

 

IsPropertyVisible

(
    const FPropertyAndParent & Property...
)

True if the property should be visible in the details panel or false if the specific details panel is not showing this property

References

Module

PropertyEditor

Header

Editor/PropertyEditor/Public/DetailLayoutBuilder.h