Language:
Discover
By Skill Level
By Category

IDetailsView

Choose your OS:

Inheritance Hierarchy

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

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

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

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

FName

 

GetIdentifier()

The identifier for this details view, or NAME_None is this view is anonymous

Public function

FIsPropertyE ...

 

GetIsPropertyEditingEnabledDelegate()

Public function

FIsPropertyR ...

 

GetIsPropertyReadOnlyDelegate()

Public function

FIsPropertyV ...

 

GetIsPropertyVisibleDelegate()

Public function

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

int32

 

GetNumVisibleTopLevelObjects()

The number of visible top level objects.

Public function

FOnDisplayed ...

 

GetOnDisplayedPropertiesChanged()

Public function

TArray < FPro ...

 

GetPropertiesInOrderDisplayed()

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

Public function

const FSelec ...

 

GetSelectedActorInfo()

Returns information about the selected set of actors

Public function

const TArray ...

 

GetSelectedActors()

Returns list of selected actors we are inspecting

Public function

const TArray ...

 

GetSelectedObjects()

List of all selected objects we are inspecting

Public function

bool

 

HasActiveSearch()

True if there is any filter of properties active in this details panel

Public function

bool

 

HasClassDefaultObject()

Whether or not the details view is viewing a CDO

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

bool

 

IsLocked()

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

Public function

bool

 

IsPropertyEditingEnabled()

True if property editing is enabled (based on the FIsPropertyEditingEnabled delegate)

Public function

bool

 

IsUpdatable()

True if the details view can be updated from editor selection

Public function

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

 

SetDisableCustomDetailLayouts

(
    bool bInDisableCustomDetailLayouts
)

Disables or enables customization of the details view:

Public function

void

 

SetExtensionHandler

(
    TSharedPtr < class IDetailPropertyEx ...
)

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

 

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

(
    TSharedPtr < class IDetailKeyframeHa ...
)

Public function

void

 

SetObject

(
    UObject * InObject,
    bool bForceRefresh
)

Sets a single object that details view 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

 

UpdatePropertiesWhitelist

(
    const TSet < FPropertyPath > InWhite...
)

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

References

Module

PropertyEditor

Header

Editor/PropertyEditor/Public/IDetailsView.h