Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Editor > PropertyEditor > IDetailsView

Light Theme

Dark Theme

IDetailsView

Interface class for all detail views

Windows

MacOS

Linux

Inheritance Hierarchy

FSlateControlledConstruction

TSharedFromThis

SWidget

SCompoundWidget

IDetailsView

References

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

Syntax

class IDetailsView : public SCompoundWidget

Remarks

Interface class for all detail views

Functions

	Name	Description
void	ClearSearch()	Clears any search terms in the current filter
void	ForceRefresh()	Force refresh
TSharedPtr< ...	GetExtensionHandler()
TSharedPtr< ...	GetFilterAreaWidget()	Returns the search area widget used to display search and view options so it can be placed in a custom location.
FOnGetDetail...	GetGenericLayoutDetailsDelegate()
TSharedPtr< ...	GetHostCommandList()	Returns the command list of the hosting toolkit (can be nullptr if the widget that contains the details panel didn't route a command list in)
TSharedPtr< ...	GetHostTabManager()	Returns the tab manager of the hosting toolkit (can be nullptr if the details panel is not hosted within a tab)
FName	GetIdentifier()
FIsCustomRow...	GetIsCustomRowVisibilityFilteredDelegate()
FIsCustomRow...	GetIsCustomRowVisibleDelegate()
FIsPropertyE...	GetIsPropertyEditingEnabledDelegate()
FIsPropertyR...	GetIsPropertyReadOnlyDelegate()
FIsPropertyV...	GetIsPropertyVisibleDelegate()
TSharedPtr< ...	GetKeyframeHandler()
TSharedPtr< ...	GetNameAreaWidget()	Returns the name area widget used to display object naming functionality so it can be placed in a custom location.
int32	GetNumVisibleTopLevelObjects()
FOnDisplayed...	GetOnDisplayedPropertiesChanged()
TArray< FPro...	GetPropertiesInOrderDisplayed()	Returns a list of all the properties displayed (via full path), order in list corresponds to draw order:
const FSelec...	GetSelectedActorInfo()
const TArray...	GetSelectedActors()
const TArray...	GetSelectedObjects()	List of all selected objects we are inspecting
bool	HasActiveSearch()
bool	HasClassDefaultObject()
void	HideFilterArea ( bool bIsVisible )	Sets the visible state of the filter box/property grid area
void	HighlightProperty ( const FPropertyPath& Property )	Creates a box around the treenode corresponding to Property and scrolls the treenode into view
bool	IsLocked()	Returns true if the details view is locked and cant have its observed objects changed
bool	IsPropertyEditingEnabled()
bool	IsUpdatable()
FOnFinishedC...	OnFinishedChangingProperties()	A delegate which is called after properties have been edited and PostEditChange has been called on all objects.
void	RefreshRootObjectVisibility()	Refreshes the visibility of root objects in this details view.
void	RegisterInstancedCustomPropertyLayout ( UStruct* Class, FOnGetDetailCustomizationInstance D... )	Registers a custom detail layout delegate for a specific class in this instance of the details view only
void	RegisterInstancedCustomPropertyTypeLayout ( FName PropertyTypeName, FOnGetPropertyTypeCustomizationInst..., TSharedPtr< IPropertyTypeIdentifier... )
void	RemoveInvalidObjects()	Removes all invalid objects being observed by this details panel
void	SetCustomFilterDelegate ( FSimpleDelegate InDelegate )	Allows other systems to add a custom filter in the details panel
void	SetCustomFilterLabel ( FText InText )
void	SetDisableCustomDetailLayouts ( bool bInDisableCustomDetailLayouts )	Disables or enables customization of the details view:
void	SetExtensionHandler ( TSharedPtr< class IDetailPropertyEx... )
void	SetGenericLayoutDetailsDelegate ( FOnGetDetailCustomizationInstance O... )	Sets a delegate to call to layout generic details not specific to an object being viewed
void	SetHostTabManager ( TSharedPtr< FTabManager > InTabMana... )	Sets the tab manager of the hosting toolkit (can be nullptr if the details panel is not hosted within a tab)
void	SetIsCustomRowVisibilityFilteredDelegate ( FIsCustomRowVisibilityFiltered InIs... )	Sets a delegate to call to check if custom row visibility is filtered, i.e. whether the FIsCustomRowVisible delegate will always return true no matter the parameters.
void	SetIsCustomRowVisibleDelegate ( FIsCustomRowVisible InIsCustomRowVi... )	Sets a delegate to call to determine if a specific custom row should be visible in this instance of the details view
void	SetIsPropertyEditingEnabledDelegate ( FIsPropertyEditingEnabled IsPropert... )	Sets a delegate to call to determine if the properties editing is enabled
void	SetIsPropertyReadOnlyDelegate ( FIsPropertyReadOnly InIsPropertyRea... )	Sets a delegate to call to determine if a specific property should be read-only in this instance of the details view
void	SetIsPropertyVisibleDelegate ( FIsPropertyVisible InIsPropertyVisi... )	Sets a delegate to call to determine if a specific property should be visible in this instance of the details view
void	SetKeyframeHandler ( TSharedPtr< class IDetailKeyframeHa... )
void	SetObject ( UObject* InObject, bool bForceRefresh )	Sets a single object that details view is viewing
void	SetObjectFilter ( TSharedPtr< FDetailsViewObjectFilte... )	Sets an optional object filter to use for more complex handling of what a details panel is viewing.
void	SetObjectPackageOverrides ( const TMap< TWeakObjectPtr< UObject... )	Set overrides that should be used when looking for packages that contain the given object (used when editing a transient copy of an object, but you need access to th real package)
void	SetObjects ( const TArray< UObject* >& InO..., bool bForceRefresh, bool bOverrideLock )	Sets the objects this details view is viewing
void	SetObjects ( const TArray< TWeakObjectPtr< UObje..., bool bForceRefresh, bool bOverrideLock )
void	SetOnDisplayedPropertiesChanged ( FOnDisplayedPropertiesChanged InOnD... )	Assigns delegate called when view is filtered, useful for updating external control logic:
void	SetOnObjectArrayChanged ( FOnObjectArrayChanged OnObjectArray... )	Sets the callback for when the property view changes
void	SetRootObjectCustomizationInstance ( TSharedPtr< class IDetailRootObject... )	Registers a customization that will be used only if this details panel contains multiple top level objects.
void	ShowAllAdvancedProperties()	Forces all advanced property sections to be in expanded state:
void	UnregisterInstancedCustomPropertyLayout ( UStruct* Class )	Unregisters a custom detail layout delegate for a specific class in this instance of the details view only
void	UnregisterInstancedCustomPropertyTypeLayout ( FName PropertyTypeName, TSharedPtr< IPropertyTypeIdentifier... )
void	UpdatePropertiesWhitelist ( const TSet< FPropertyPath > InWhite... )	Sets the set of properties that are considered differing, used when filtering out identical properties

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss