IDetailChildrenBuilder

Builder for adding children to a detail customization

Windows
MacOS
Linux

References

Module

PropertyEditor

Header

/Engine/Source/Editor/PropertyEditor/Public/IDetailChildrenBuilder.h

Include

#include "IDetailChildrenBuilder.h"

Syntax

class IDetailChildrenBuilder

Remarks

Builder for adding children to a detail customization

Destructors

Name Description

Public function Virtual

~IDetailChildrenBuilder()

Functions

Name Description

Public function

TArray< TSha...

 

AddAllExternalStructureProperties

(
    TSharedRef< FStructOnScope > ChildS...
)

Adds all the properties of an external structure as a children

Public function

IDetailChild...

 

AddCustomBuilder

Adds a custom builder as a child

Public function

FDetailWidge...

 

AddCustomRow

(
    const FText& SearchString
)

Adds new custom content as a child to the struct

Public function

IDetailPrope...

 

AddExternalObjectProperty

(
    const TArray< UObject* >& Obj...,
    FName PropertyName,
    const FAddPropertyParams& Params
)

Adds a set of objects to as a child.

Public function

IDetailPrope...

 

AddExternalObjects

(
    const TArray< UObject* >& Obj...,
    FName UniqueIdName
)

Adds a set of objects to as a child.

Public function

IDetailPrope...

 

AddExternalStructure

(
    TSharedRef< FStructOnScope > ChildS...,
    FName UniqueIdName
)

Adds a custom structure as a child

Public function

IDetailPrope...

 

AddExternalStructureProperty

(
    TSharedRef< FStructOnScope > ChildS...,
    FName PropertyName,
    const FAddPropertyParams& Params
)

Adds a property from a custom structure as a child

Public function

IDetailGroup...

 

AddGroup

(
    FName GroupName,
    const FText& LocalizedDisplayName
)

Adds a group to the category

Public function

IDetailPrope...

 

AddProperty

(
    TSharedRef< IPropertyHandle > Prope...
)

Adds a property to the struct

Public function

TSharedRef< ...

 

GenerateStructValueWidget

(
    TSharedRef< IPropertyHandle > Struc...
)

Generates a value widget from a customized struct If the customized struct has no value widget an empty widget will be returned

Public function Const

IDetailCateg...

 

GetParentCategory()

Public function Const

IDetailGroup...

 

GetParentGroup()

Deprecated Functions

Name Description

Public function

FDetailWidge...

 

AddChildContent

(
    const FText& SearchString
)

AddChildContent has been deprecated. Use AddCustomRow instead

Public function

IDetailChild...

 

AddChildCustomBuilder

AddChildCustomBuilder has been deprecated. Use AddCustomBuilder instead

Public function

IDetailGroup...

 

AddChildGroup

(
    FName GroupName,
    const FText& LocalizedDisplayName
)

AddChildGroup has been deprecated. Use AddGroup instead

Public function

IDetailPrope...

 

AddChildProperty

(
    TSharedRef< IPropertyHandle > Prope...
)

AddChildProperty has been deprecated. Use AddProperty instead

Public function

IDetailPrope...

 

AddChildStructure

(
    TSharedRef< FStructOnScope > ChildS...,
    FName PropertyName,
    FName UniqueIdName
)

AddChildStructure has been deprecated. Use AddExternalStructureProperty instead

Public function

IDetailPrope...

 

AddExternalObjectProperty

(
    const TArray< UObject* >& Obj...,
    FName PropertyName,
    FName UniqueIdName,
    TOptional< bool > bAllowChildrenOve...,
    TOptional< bool > bCreateCategoryNo...
)

Please use the overload that accepts an FAddPropertyParams structure

Public function

IDetailPrope...

 

AddExternalStructureProperty

(
    TSharedRef< FStructOnScope > ChildS...,
    FName PropertyName,
    FName UniqueIdName
)

Please use the overload that accepts an FAddPropertyParams structure

Public function Virtual

TArray< TSha...

 

AddStructure

(
    TSharedRef< FStructOnScope > ChildS...
)

This version of AddStructure has been deprecated. Use AddAllExternalStructureProperties instead

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss