1. Epic GamesDeveloper
  3. FDetailsDisplayManager

FDetailsDisplayManager

An [FDetailsDisplayManager](API\Editor\PropertyEditor\FDetailsDisplayManager) provides an API to tweak various settings of your details view, and provides some utility methods to work with Details.

API > API/Editor > API/Editor/PropertyEditor

Inheritance Hierarchy

  • TSharedFromThis< FDetailsDisplayManager >
  • FDetailsDisplayManager

References

   
Module PropertyEditor
Header /Engine/Source/Editor/PropertyEditor/Public/DetailsDisplayManager.h
Include #include "DetailsDisplayManager.h"

Syntax

class FDetailsDisplayManager : public TSharedFromThis< FDetailsDisplayManager >

Remarks

An FDetailsDisplayManager provides an API to tweak various settings of your details view, and provides some utility methods to work with Details.

Variables

  Type Name Description
Protected variable bool bIsOuterCategory A bool indicating whether or not the currently active category is an outer category
Protected variable bool bIsScrollBarNeeded A bool indicating whether or not the scrollbar is needed on the details view.
Protected variable TMap< FName, TSet< FProperty * > > CategoryNameToUpdatePropertySetMap A map of category object name to a set of properties that has been updated for it
Protected variable FName CategoryObjectName The name of the object defined by the currently active category
Public variable FOnDetailsNeedsUpdate OnDetailsNeedsUpdate  
Protected variable FDetailsViewStyleKey PrimaryStyleKey The primary style key for the details view.

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual bool

AddEmptyCategoryToDetailLayoutIfNeeded ( TSharedRef< FComplexPropertyNode > Node,
TSharedRef< FDetailLayoutBuilderImpl > DetailLayoutBuilder
)

 If TSharedRef Node has a valid UObject instance, add an empty properties Category to the DetailLayoutBuilder
Public function Const bool

GetCategoryHasAnyUpdatedProperties ( FName InCategoryObjectName
)

  
Public function Virtual TSharedPtr< SWidget >

GetCategoryMenu ( FName InCategoryObjectName
)

 Gets the category menu SWidget and returns a shared pointer to it
Public function Const const FDetailsViewStyle * Returns the FDetailsViewStyle that is the current FDetailsViewStyle style
Public function Virtual Const const FDetailsViewStyleKey & Returns the FDetailsViewStyleKey that is the Key to the current FDetailsViewStyle style
Public function Static bool Returns a boolean indicating whether the sub-object editor should show regardless of any object filter preference settings this would override any value retrieved from ShouldHideComponentEditor.
Public function Virtual Const bool Returns a bool indicating whether or not the scrollbar is needed on the details view.
Public function Virtual TSharedPtr< FPropertyUpdatedWidgetBuilder >

GetPropertyUpdatedWidget ( FResetToDefault ResetToDefault,
TSharedRef< FEditPropertyChain > InEditorPropertyChain,
FName InCategoryObjectName
)

 Returns a widget which will show in place of the reset to default button, or a nullptr if the default reset button should be used
Public function Virtual TSharedPtr< FPropertyUpdatedWidgetBuilder >

GetPropertyUpdatedWidget ( FResetToDefault ResetToDefault,
bool bIsCategoryUpdateWidget,
FName InCategoryObjectName
)

 Returns a widget which will show in place of the reset to default button, or a nullptr if the default reset button should be used
Public function Const FMargin Returns the FMargin which provides the padding around the whole details view table
Public function void

SetCategoryObjectName ( FName InCategoryObjectName
)

 Sets the name of the object defined by the currently active category
Public function void

SetIsOuterCategory ( bool bInIsOuterCategory
)

 Sets whether the currently active category is an Outer category
Public function Virtual void

SetIsScrollBarNeeded ( bool bInIsScrollBarNeeded
)

 Set a bool indicating whether or not the scrollbar is needed on the details view.
Public function Virtual bool Returns a boolean indicating if the Component Editor should be hidden
Public function Virtual bool Returns a bool indicating whether this DetailsViewObjectFilter instance should show a category menu
Public function Virtual Const bool Returns true if the specified UObject is a Root Node Object and should show an empty Category stub even if it has no UProperty Data, else it returns false
Public function void

UpdatePropertyForCategory ( FName InCategoryObjectName,
FProperty* Property,
bool bAddProperty
)

  
Public function Const void Updates the current details view

Typedefs

Name Description
FResetToDefault  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page