Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. IDetailCategoryBuilder

IDetailCategoryBuilder

Represents a category for the a details view

API > API/Editor > API/Editor/PropertyEditor

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

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function TArray< TSharedPtr< IPropertyHandle > >

AddAllExternalStructureProperties ( TSharedPtr< IStructureDataProvider > StructProvider,
EPropertyLocation::Type Location,
TArray< IDetailPropertyRow* >* OutPropertiesRow
)

  
Public function TArray< TSharedPtr< IPropertyHandle > >

AddAllExternalStructureProperties ( TSharedRef< FStructOnScope > StructData,
EPropertyLocation::Type Location,
TArray< IDetailPropertyRow* >* OutPropertiesRow
)

 Adds all properties for the specified external structure to this category
Public function void

AddCustomBuilder ( TSharedRef< IDetailCustomNodeBuilder > InCustomBuilder,
bool bForAdvanced
)

 Adds a custom builder to the category (for more complicated layouts)
Public function FDetailWidgetRow &

AddCustomRow ( const FText& FilterString,
bool bForAdvanced
)

 Adds a custom widget row to the category
Public function 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
Public function IDetailPropertyRow *

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

 Adds an entire external object to this category.
Public function IDetailPropertyRow *

AddExternalStructure ( TSharedPtr< FStructOnScope > StructData,
EPropertyLocation::Type Location
)

 Adds an external standalone structure to this details panel
Public function IDetailPropertyRow *

AddExternalStructureProperty ( TSharedPtr< IStructureDataProvider > StructData,
FName PropertyName,
EPropertyLocation::Type Location,
const FAddPropertyParams& Params
)

  
Public function 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
Public function IDetailGroup &

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

 Adds a group to the category
Public function IDetailPropertyRow &

AddProperty ( TSharedPtr< IPropertyHandle > PropertyHandle,
EPropertyLocation::Type Location
)

 Adds a property, shown in the default way to the category
Public function IDetailPropertyRow &

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

 Adds a property, shown in the default way to the category
Public function void

AddPropertyDisableInstancedReference ( TSharedPtr< IPropertyHandle > PropertyHandle
)

 Add a property, but force it to behave as a normal, peer reference regardless of CPF_InstancedReference
Public function void

GetDefaultProperties ( TArray< TSharedRef< IPropertyHandle > >& OutAllProperties,
bool bSimpleProperties,
bool bAdvancedProperties
)

 Gets the default propeties of this category
Public function Const const FText &  
Public function Const IDetailLayoutBuilder &  
Public function Const int32 Gets the current sort order of the category
Public function Const const TOptional< FText > & Gets the localized tooltip for this category.
Public function IDetailCategoryBuilder &

HeaderContent ( TSharedRef< SWidget > InHeaderContent,
bool bWholeRowContent
)

 Adds header content to the category
Public function IDetailCategoryBuilder &

InitiallyCollapsed ( bool bShouldBeInitiallyCollapsed
)

 Whether or not the category should be initially collapsed
Public function Virtual Const 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
Public function Const bool  
Public function IDetailCategoryBuilder &

OnExpansionChanged ( FOnBooleanValueChanged InOnExpansionChanged
)

 Adds a delegate to the category which is called when the category expansion state changes
Public function Virtual Const TSharedPtr< FOnPasteFromText > Optional PasteFromText delegate for this category
Public function IDetailCategoryBuilder &

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

SetDisplayName ( const FText& DisplayName
)

 Set a new display name for this category.
Public function 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
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
Public function void

SetToolTip ( const FText& ToolTip
)

 Sets the localized tooltip for this category.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page