1. Epic GamesDeveloper
  3. IDetailsView

IDetailsView

Interface class for all detail views

API > API/Editor > API/Editor/PropertyEditor

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

  Type Name Description
Public function void Clears any search terms in the current filter
Public function Const int32 Returns the number of rows in the underlying TableView
Public function void Force refresh
Public function Const TSharedPtr< IDetailPropertyExtensionHandler >  
Public function TSharedPtr< SWidget > Returns the search area widget used to display search and view options so it can be placed in a custom location.
Public function FOnGetDetailCustomizationInstance &  
Public function Const TSharedPtr< FUICommandList > 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< FTabManager > 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  
Public function FIsCustomRowReadOnly &  
Public function FIsCustomRowVisible &  
Public function FIsPropertyEditingEnabled &  
Public function FIsPropertyReadOnly &  
Public function FIsPropertyVisible &  
Public function Const TSharedPtr< IDetailKeyframeHandler >  
Public function TSharedPtr< SWidget > Returns the name area widget used to display object naming functionality so it can be placed in a custom location.
Public function Const int32  
Public function FOnDisplayedPropertiesChanged &  
Public function Virtual Const FSlateRect

GetPaintSpacePropertyBounds ( const TSharedRef< FDetailTreeNode >& InDetailTreeNode,
bool IncludeChildren
)

 Returns the boundary (in paint space) of a detail tree node if it's currently visible Otherwise return an invalid boundary
Public function Const TArray< FPropertyPath > Returns a list of all the properties displayed (via full path), order in list corresponds to draw order:
Public function Const TArray< TPair< int32, FPropertyPath > > Returns the row number in the underlying TableView for each property being displayed.
Public function Const const FSelectedActorInfo &  
Public function Const const TArray< TWeakObjectPtr< AActor > > &  
Public function Const const TArray< TWeakObjectPtr< UObject > > & List of all selected objects we are inspecting
Public function Virtual Const FSlateRect

GetTickSpacePropertyBounds ( const TSharedRef< FDetailTreeNode >& InDetailTreeNode,
bool IncludeChildren
)

 Returns the boundary (in tick space) of a detail tree node if it's currently visible Otherwise return an invalid boundary
Public function Const bool  
Public function Const bool  
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 Invalidates any cached state without necessarily doing a complete rebuild.
Public function Virtual Const bool Returns true if the provided detail tree node is part of a collapsed/hidden subsection of the details panel
Public function Const bool Returns true if the details view is locked and cant have its observed objects changed
Public function Const bool  
Public function Const bool  
Public function Const FOnFinishedChangingProperties & A delegate which is called after properties have been edited and PostEditChange has been called on all objects.
Public function void Refreshes the visibility of root objects in this details view.
Public function void

RegisterInstancedCustomPropertyLayout ( UStruct* Class,
FOnGetDetailCustomizationInstance DetailLayoutDelegate
)

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

RegisterInstancedCustomPropertyTypeLayout ( FName PropertyTypeName,
FOnGetPropertyTypeCustomizationInstance PropertyTypeLayoutDelegate,
TSharedPtr< IPropertyTypeIdentifier > Identifier
)

  
Public function void Removes all invalid objects being observed by this details panel
Public function void 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  
Public function void

SetCustomValidatePropertyNodesFunction ( FOnValidateDetailsViewPropertyNodes InCustomValidatePropertyNodesFunction
)

 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  
Public function void

SetGenericLayoutDetailsDelegate ( FOnGetDetailCustomizationInstance OnGetGenericDetails
)

 Sets a delegate to call to layout generic details not specific to an object being viewed
Public function void 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 InIsCustomRowVisible
)

 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 InIsCustomRowVisible
)

 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 IsPropertyEditingEnabled
)

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

SetIsPropertyReadOnlyDelegate ( FIsPropertyReadOnly InIsPropertyReadOnly
)

 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 InIsPropertyVisible
)

 Sets a delegate to call to determine if a specific property should be visible in this instance of the details view
Public function void  
Public function void

SetNameAreaCustomContent ( TSharedRef< SWidget >& InCustomContent
)

 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 Sets an optional object filter to use for more complex handling of what a details panel is viewing.
Public function void 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* >& InObjects,
bool bForceRefresh,
bool bOverrideLock
)

 Sets the objects this details view is viewing
Public function void

SetObjects ( const TArray< TWeakObjectPtr< UObject > >& InObjects,
bool bForceRefresh,
bool bOverrideLock
)

  
Public function void

SetOnDisplayedPropertiesChanged ( FOnDisplayedPropertiesChanged InOnDisplayedPropertiesChangedDelegate
)

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

SetOnObjectArrayChanged ( FOnObjectArrayChanged OnObjectArrayChangedDelegate
)

 Sets the callback for when the property view changes
Public function void

SetRightColumnMinWidth ( float InMinWidth
)

 Sets the minimum width of the detail panel's right column.
Public function void Registers a customization that will be used only if this details panel contains multiple top level objects.
Public function void Forces all advanced property sections to be in expanded state:
Public function void Unregisters a custom detail layout delegate for a specific class in this instance of the details view only
Public function void  
Public function void

UpdatePropertyAllowList ( const TSet< FPropertyPath >& InAllowedProperties
)

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page