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

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

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

Syntax

class FDetailsDisplayManager : public TSharedFromThis< FDetailsDisplayManager >

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

FDetailsDisplayManager()

   DetailsDisplayManager.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FDetailsDisplayManager()

   DetailsDisplayManager.h  

Typedefs

Name Type Remarks Include Path
FResetToDefault TBaseDelegate_NoParams< void >   DetailsDisplayManager.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnDetailsNeedsUpdate FOnDetailsNeedsUpdate   DetailsDisplayManager.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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 DetailsDisplayManager.h  
If returning true, the row widgets (ie. SDetailSingleItemRow, SDetailCategoryTableRow) will call ConstructPropertyUpdatedWidgetBuilder. DetailsDisplayManager.h  

virtual TSharedRef< SWidget > ConstructDetailTreeOverlay ()

 Returns a widget which will be put in an overlay slot which is over the detail tree portion of the widget. DetailsDisplayManager.h  
Returns a builder class which will generate a widget in place of the Extension widgets on an item row. DetailsDisplayManager.h  

bool GetCategoryHasAnyUpdatedProperties ( FName InCategoryObjectName
) const

   DetailsDisplayManager.h  

virtual TSharedPtr< SWidget > GetCategoryMenu ( FName InCategoryObjectName
)

 Gets the category menu SWidget and returns a shared pointer to it DetailsDisplayManager.h  

const FDetailsViewStyle * GetDetailsViewStyle()

 Returns the FDetailsViewStyle that is the current FDetailsViewStyle style DetailsDisplayManager.h  

virtual const FDetailsViewStyleKey & GetDetailsViewStyleKey()

 Returns the FDetailsViewStyleKey that is the Key to the current FDetailsViewStyle style DetailsDisplayManager.h  

virtual bool GetIsScrollBarNeeded ()

 Returns a bool indicating whether or not the scrollbar is needed on the details view. DetailsDisplayManager.h  

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 DetailsDisplayManager.h  

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 DetailsDisplayManager.h  

FMargin GetTablePadding()

 Returns the FMargin which provides the padding around the whole details view table DetailsDisplayManager.h  

virtual TOptional< bool > OverrideCreateCategoryNodes()

   DetailsDisplayManager.h  

void SetIsOuterCategory ( bool bInIsOuterCategory
)

 Sets whether the currently active category is an Outer category DetailsDisplayManager.h  

virtual void SetIsScrollBarNeeded ( bool bInIsScrollBarNeeded
)

 Set a bool indicating whether or not the scrollbar is needed on the details view. DetailsDisplayManager.h  

virtual bool ShouldHideComponentEditor()

 Returns a boolean indicating if the Component Editor should be hidden DetailsDisplayManager.h  

virtual bool ShouldShowCategoryMenu()

 Returns a bool indicating whether this DetailsViewObjectFilter instance should show a category menu DetailsDisplayManager.h  

virtual bool ShowEmptyCategoryIfRootUObjectHasNoPropertyData ( UObject* InNode
) const

 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 DetailsDisplayManager.h  

virtual bool SupportsDetailTreeOverlay ()

 Returns whether or not this display manager provides a widget to overlay over the detail tree. DetailsDisplayManager.h  

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

   DetailsDisplayManager.h  

void UpdateView()

 Updates the current details view DetailsDisplayManager.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool GetForceShowSubObjectEditor()

 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. DetailsDisplayManager.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page