IDetailsView

Interface class for all detail views

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

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

Public function

void

 

ClearSearch()

Clears any search terms in the current filter

Public function

void

 

ForceRefresh()

Force refresh

Public function Const

TSharedPtr< ...

 

GetExtensionHandler()

Public function

TSharedPtr< ...

 

GetFilterAreaWidget()

Returns the search area widget used to display search and view options so it can be placed in a custom location.

Public function

FOnGetDetail...

 

GetGenericLayoutDetailsDelegate()

Public function Const

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)

Public function Const

TSharedPtr< ...

 

GetHostTabManager()

Returns the tab manager of the hosting toolkit (can be nullptr if the details panel is not hosted within a tab)

Public function Const

FName

 

GetIdentifier()

Public function

FIsCustomRow...

 

GetIsCustomRowReadOnlyDelegate()

Public function

FIsCustomRow...

 

GetIsCustomRowVisibleDelegate()

Public function

FIsPropertyE...

 

GetIsPropertyEditingEnabledDelegate()

Public function

FIsPropertyR...

 

GetIsPropertyReadOnlyDelegate()

Public function

FIsPropertyV...

 

GetIsPropertyVisibleDelegate()

Public function Const

TSharedPtr< ...

 

GetKeyframeHandler()

Public function

TSharedPtr< ...

 

GetNameAreaWidget()

Returns the name area widget used to display object naming functionality so it can be placed in a custom location.

Public function Const

int32

 

GetNumVisibleTopLevelObjects()

This value will always be 1 if this details panel was not created with bAllowMultipleTopLevelObjects=true

Public function

FOnDisplayed...

 

GetOnDisplayedPropertiesChanged()

Public function Const

TArray< FPro...

 

GetPropertiesInOrderDisplayed()

Returns a list of all the properties displayed (via full path), order in list corresponds to draw order:

Public function Const

const FSelec...

 

GetSelectedActorInfo()

Public function Const

const TArray...

 

GetSelectedActors()

Public function Const

const TArray...

 

GetSelectedObjects()

List of all selected objects we are inspecting

Public function Const

bool

 

HasActiveSearch()

Public function Const

bool

 

HasClassDefaultObject()

Public function

void

 

HideFilterArea

(
    bool bIsVisible
)

Sets the visible state of the filter box/property grid area

Public function

void

 

HighlightProperty

(
    const FPropertyPath& Property
)

Creates a box around the treenode corresponding to Property and scrolls the treenode into view

Public function Virtual

void

 

InvalidateCachedState()

Invalidates any cached state without necessarily doing a complete rebuild.

Public function Const

bool

 

IsLocked()

Returns true if the details view is locked and cant have its observed objects changed

Public function Const

bool

 

IsPropertyEditingEnabled()

Public function Const

bool

 

IsUpdatable()

Public function Const

FOnFinishedC...

 

OnFinishedChangingProperties()

A delegate which is called after properties have been edited and PostEditChange has been called on all objects.

Public function

void

 

RefreshRootObjectVisibility()

Refreshes the visibility of root objects in this details view.

Public function

void

 

RegisterInstancedCustomPropertyLayout

(
    UStruct* Class,
    FOnGetDetailCustomizationInstance D...
)

Registers a custom detail layout delegate for a specific class in this instance of the details view only

Public function

void

 

RegisterInstancedCustomPropertyTypeLayout

(
    FName PropertyTypeName,
    FOnGetPropertyTypeCustomizationInst...,
    TSharedPtr< IPropertyTypeIdentifier...
)

Public function

void

 

RemoveInvalidObjects()

Removes all invalid objects being observed by this details panel

Public function

void

 

SetClassViewerFilters

(
    const TArray< TSharedRef< class ICl...
)

Sets the custom filter(s) to be used when selecting values for class properties in this view.

Public function

void

 

SetCustomFilterDelegate

(
    FSimpleDelegate InDelegate
)

Allows other systems to add a custom filter in the details panel

Public function

void

 

SetCustomFilterLabel

(
    FText InText
)

Public function

void

 

SetCustomValidatePropertyNodesFunction

Use this function to set a callback for SDetailsView that will skip the EnsureDataIsValid call in Tick.

Public function

void

 

SetDisableCustomDetailLayouts

(
    bool bInDisableCustomDetailLayouts
)

Disables or enables customization of the details view:

Public function

void

 

SetExtensionHandler

Public function

void

 

SetGenericLayoutDetailsDelegate

Sets a delegate to call to layout generic details not specific to an object being viewed

Public function

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)

Public function

void

 

SetIsCustomRowReadOnlyDelegate

(
    FIsCustomRowReadOnly InIsCustomRowV...
)

Sets a delegate to call to determine if a specific custom row should be visible in this instance of the details view

Public function

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

Public function

void

 

SetIsPropertyEditingEnabledDelegate

(
    FIsPropertyEditingEnabled IsPropert...
)

Sets a delegate to call to determine if the properties editing is enabled

Public function

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

Public function

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

Public function

void

 

SetKeyframeHandler

Public function

void

 

SetNameAreaCustomContent

(
    TSharedRef< SWidget >& InCustomCon...
)

Optionally add custom tools into the NameArea

Public function

void

 

SetObject

(
    UObject* InObject,
    bool bForceRefresh
)

Sets a single object that details view is viewing

Public function

void

 

SetObjectFilter

Sets an optional object filter to use for more complex handling of what a details panel is viewing.

Public function

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)

Public function

void

 

SetObjects

(
    const TArray< UObject* >& InO...,
    bool bForceRefresh,
    bool bOverrideLock
)

Sets the objects this details view is viewing

Public function

void

 

SetObjects

(
    const TArray< TWeakObjectPtr< UObje...,
    bool bForceRefresh,
    bool bOverrideLock
)

Public function

void

 

SetOnDisplayedPropertiesChanged

(
    FOnDisplayedPropertiesChanged InOnD...
)

Assigns delegate called when view is filtered, useful for updating external control logic:

Public function

void

 

SetOnObjectArrayChanged

(
    FOnObjectArrayChanged OnObjectArray...
)

Sets the callback for when the property view changes

Public function

void

 

SetRootObjectCustomizationInstance

(
    TSharedPtr< class IDetailRootObject...
)

Registers a customization that will be used only if this details panel contains multiple top level objects.

Public function

void

 

ShowAllAdvancedProperties()

Forces all advanced property sections to be in expanded state:

Public function

void

 

UnregisterInstancedCustomPropertyLayout

(
    UStruct* Class
)

Unregisters a custom detail layout delegate for a specific class in this instance of the details view only

Public function

void

 

UnregisterInstancedCustomPropertyTypeLayout

(
    FName PropertyTypeName,
    TSharedPtr< IPropertyTypeIdentifier...
)

Public function

void

 

UpdatePropertyAllowList

(
    const TSet< FPropertyPath > InAllow...
)

Sets the set of properties that are considered differing, used when filtering out identical properties