IDetailCategoryBuilder | Unreal Engine 5.7 Documentation

API > API/Editor > API/Editor/PropertyEditor

Represents a category for the a details view


Name	IDetailCategoryBuilder
Type	class
Header File	/Engine/Source/Editor/PropertyEditor/Public/DetailCategoryBuilder.h
Include Path	#include "DetailCategoryBuilder.h"

Syntax

class IDetailCategoryBuilder

Destructors

Name	Remarks	Include Path	Unreal Specifiers
virtual ~IDetailCategoryBuilder()		DetailCategoryBuilder.h

Functions

Public

Name	Remarks	Include Path
TArray< TSharedPtr< IPropertyHandle > > AddAllExternalStructureProperties ( TSharedPtr< IStructureDataProvider > StructProvider, EPropertyLocation::Type Location, TArray< IDetailPropertyRow* >* OutPropertiesRow )		DetailCategoryBuilder.h
TArray< TSharedPtr< IPropertyHandle > > AddAllExternalStructureProperties ( TSharedRef< FStructOnScope > StructData, EPropertyLocation::Type Location, TArray< IDetailPropertyRow* >* OutPropertiesRow )	Adds all properties for the specified external structure to this category	DetailCategoryBuilder.h
void AddCustomBuilder ( TSharedRef< IDetailCustomNodeBuilder > InCustomBuilder, bool bForAdvanced )	Adds a custom builder to the category (for more complicated layouts)	DetailCategoryBuilder.h
FDetailWidgetRow & AddCustomRow ( const FText& FilterString, bool bForAdvanced )	Adds a custom widget row to the category	DetailCategoryBuilder.h
IDetailPropertyRow * AddExternalObjectProperty ( const TArray< UObject* >& Objects, FName PropertyName, EPropertyLocation::Type Location, const FAddPropertyParams& Params )	Adds an external object property that is not a property on the object(s) being customized	DetailCategoryBuilder.h
IDetailPropertyRow * AddExternalObjects ( const TArray< UObject* >& Objects, EPropertyLocation::Type Location, const FAddPropertyParams& Params )	Adds an entire external object to this category.	DetailCategoryBuilder.h
IDetailPropertyRow * AddExternalStructure ( TSharedPtr< FStructOnScope > StructData, EPropertyLocation::Type Location )	Adds an external standalone structure to this details panel	DetailCategoryBuilder.h
IDetailPropertyRow * AddExternalStructureProperty ( TSharedPtr< IStructureDataProvider > StructData, FName PropertyName, EPropertyLocation::Type Location, const FAddPropertyParams& Params )		DetailCategoryBuilder.h
IDetailPropertyRow * AddExternalStructureProperty ( TSharedPtr< FStructOnScope > StructData, 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	DetailCategoryBuilder.h
IDetailGroup & AddGroup ( FName GroupName, const FText& LocalizedDisplayName, bool bForAdvanced, bool bStartExpanded )	Adds a group to the category	DetailCategoryBuilder.h
IDetailPropertyRow & AddProperty ( TSharedPtr< IPropertyHandle > PropertyHandle, EPropertyLocation::Type Location )	Adds a property, shown in the default way to the category	DetailCategoryBuilder.h
IDetailPropertyRow & AddProperty ( FName PropertyPath, UClass* ClassOutermost, FName InstanceName, EPropertyLocation::Type Location )	Adds a property, shown in the default way to the category	DetailCategoryBuilder.h
void AddPropertyDisableInstancedReference ( TSharedPtr< IPropertyHandle > PropertyHandle )	Add a property, but force it to behave as a normal, peer reference regardless of CPF_InstancedReference	DetailCategoryBuilder.h
void GetDefaultProperties ( TArray< TSharedRef< IPropertyHandle > >& OutAllProperties, bool bSimpleProperties, bool bAdvancedProperties )	Gets the default properties of this category	DetailCategoryBuilder.h
const FText & GetDisplayName()		DetailCategoryBuilder.h
IDetailLayoutBuilder & GetParentLayout()		DetailCategoryBuilder.h
int32 GetSortOrder()	Gets the current sort order of the category	DetailCategoryBuilder.h
const TOptional< FText > & GetToolTip()	Gets the localized tooltip for this category.	DetailCategoryBuilder.h
IDetailCategoryBuilder & HeaderContent ( TSharedRef< SWidget > InHeaderContent, bool bWholeRowContent )	Adds header content to the category	DetailCategoryBuilder.h
IDetailCategoryBuilder & InitiallyCollapsed ( bool bShouldBeInitiallyCollapsed )	Whether or not the category should be initially collapsed	DetailCategoryBuilder.h
virtual bool IsEmpty()	If true, this Category should have no UProperty data associated with it, and will be shown as an empty stub with no expansion arrow	DetailCategoryBuilder.h
bool IsParentLayoutValid()		DetailCategoryBuilder.h
virtual TSharedPtr< FOnCopyToText > OnCopyToText()	Optional CopyToText delegate for this category	DetailCategoryBuilder.h
IDetailCategoryBuilder & OnExpansionChanged ( FOnBooleanValueChanged InOnExpansionChanged )	Adds a delegate to the category which is called when the category expansion state changes	DetailCategoryBuilder.h
virtual TSharedPtr< FOnPasteFromText > OnPasteFromText()	Optional PasteFromText delegate for this category	DetailCategoryBuilder.h
IDetailCategoryBuilder & RestoreExpansionState ( bool bRestore )	Sets whether or not the expansion state should be restored between sessions	DetailCategoryBuilder.h
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	DetailCategoryBuilder.h
void SetDisplayName ( const FText& DisplayName )	Set a new display name for this category.	DetailCategoryBuilder.h
virtual void SetIsEmpty ( bool bInIsEmpty )	Sets whether this Category is "Empty" ~ that is, should have no UProperty data associated with it, and will be shown as an empty stub with no expansion arrow	DetailCategoryBuilder.h
void SetShowAdvanced ( bool bShowAdvanced )	Sets whether or not this category should show its advanced properties.	DetailCategoryBuilder.h
void SetSortOrder ( int32 InSortOrder )	Sets the sort order of the category	DetailCategoryBuilder.h
void SetToolTip ( const FText& ToolTip )	Sets the localized tooltip for this category.	DetailCategoryBuilder.h

Navigation

Syntax

Destructors

Functions

Public