IDetailCategoryBuilder

Represents a category for the a details view

Windows
MacOS
Linux

References

Module

PropertyEditor

Header

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

Include

#include "DetailCategoryBuilder.h"

Syntax

class IDetailCategoryBuilder

Remarks

Represents a category for the a details view

Destructors

Name Description

Public function Virtual

~IDetailCategoryBuilder()

Functions

Name Description

Public function

TArray< TSha...

 

AddAllExternalStructureProperties

(
    TSharedRef< FStructOnScope > Struct...,
    EPropertyLocation::Type Location
)

Adds all properties for the specified external structure to this category

Public function

void

 

AddCustomBuilder

(
    TSharedRef< IDetailCustomNodeBuilde...,
    bool bForAdvanced
)

Adds a custom builder to the category (for more complicated layouts)

Public function

FDetailWidge...

 

AddCustomRow

(
    const FText& FilterString,
    bool bForAdvanced
)

Adds a custom widget row to the category

Public function

IDetailPrope...

 

AddExternalObjectProperty

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

Adds an external object property that is not a property on the object(s) being customized

Public function

IDetailPrope...

 

AddExternalObjects

(
    const TArray< UObject* >& Obj...,
    EPropertyLocation::Type Location,
    const FAddPropertyParams& Params
)

Adds an entire external object to this category.

Public function

IDetailPrope...

 

AddExternalStructure

(
    TSharedPtr< FStructOnScope > Struct...,
    EPropertyLocation::Type Location
)

Adds an external standalone structure to this details panel

Public function

IDetailPrope...

 

AddExternalStructureProperty

(
    TSharedPtr< FStructOnScope > Struct...,
    FName PropertyName,
    EPropertyLocation::Type Location,
    const FAddPropertyParams& Params
)

Adds an external property, that is contained within a UStruct, that is not a property on the object(s) being customized

Public function

IDetailGroup...

 

AddGroup

(
    FName GroupName,
    const FText& LocalizedDisplayName,
    bool bForAdvanced,
    bool bStartExpanded
)

Adds a group to the category

Public function

IDetailPrope...

 

AddProperty

(
    FName PropertyPath,
    UClass* ClassOutermost,
    FName InstanceName,
    EPropertyLocation::Type Location
)

Adds a property, shown in the default way to the category

Public function

IDetailPrope...

 

AddProperty

(
    TSharedPtr< IPropertyHandle > Prope...,
    EPropertyLocation::Type Location
)

Adds a property, shown in the default way to the category

Public function

void

 

GetDefaultProperties

(
    TArray< TSharedRef< IPropertyHandle...,
    bool bSimpleProperties,
    bool bAdvancedProperties
)

Gets the default propeties of this category

Public function Const

const FText ...

 

GetDisplayName()

Public function Const

IDetailLayou...

 

GetParentLayout()

Public function Const

int32

 

GetSortOrder()

Gets the current sort order of the category

Public function

IDetailCateg...

 

HeaderContent

(
    TSharedRef< SWidget > InHeaderConte...
)

Adds header content to the category

Public function

IDetailCateg...

 

InitiallyCollapsed

(
    bool bShouldBeInitiallyCollapsed
)

Whether or not the category should be initially collapsed

Public function Const

bool

 

IsParentLayoutValid()

Public function

IDetailCateg...

 

OnExpansionChanged

(
    FOnBooleanValueChanged InOnExpansio...
)

Adds a delegate to the category which is called when the category expansion state changes

Public function

IDetailCateg...

 

RestoreExpansionState

(
    bool bRestore
)

Sets whether or not the expansion state should be restored between sessions

Public function

void

 

SetCategoryVisibility

(
    bool bVisible
)

Sets whether or not this category is hidden or shown This is designed to be used for dynamic category visibility after construction of the category

Public function

void

 

SetShowAdvanced

(
    bool bShowAdvanced
)

Sets whether or not this category should show its advanced properties.

Public function

void

 

SetSortOrder

(
    int32 InSortOrder
)

Sets the sort order of the category

Deprecated Functions

Name Description

Public function

TArray< TSha...

 

AddExternalProperties

(
    TSharedRef< FStructOnScope > Struct...,
    EPropertyLocation::Type Location
)

AddExternalProperty is deprecated. Use AddAllExternalStructureProperties instead

Public function

IDetailPrope...

 

AddExternalProperty

(
    TSharedPtr< FStructOnScope > Struct...,
    FName PropertyName,
    EPropertyLocation::Type Location
)

AddExternalProperty is deprecated. Use AddExternalStructureProperty instead

Public function

IDetailPrope...

 

AddExternalProperty

(
    const TArray< UObject* >& Obj...,
    FName PropertyName,
    EPropertyLocation::Type Location
)

AddExternalProperty is deprecated. Use AddExternalObjectProperty 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