1. Epic GamesDeveloper
  3. IDetailsView

IDetailsView

Interface class for all detail views

API > API/Editor > API/Editor/PropertyEditor

Interface class for all detail views

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

Syntax

class IDetailsView :  
    public SCompoundWidget,  
    public IScrollableWidget

Inheritance Hierarchy

Implements Interfaces

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ClearSearch()

 Clears any search terms in the current filter IDetailsView.h  

int32 CountRows()

 Returns the number of rows in the underlying TableView IDetailsView.h  

void ForceRefresh()

 Causes the details view to be refreshed (new widgets generated) with the current set of objects IDetailsView.h  

TSharedPtr< IDetailPropertyChildrenCustomizationHandler > GetChildrenCustomizationHandler()

   IDetailsView.h  

TSharedPtr< IDetailPropertyExtensionHandler > GetExtensionHandler()

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

FOnGetDetailCustomizationInstance & GetGenericLayoutDetailsDelegate()

   IDetailsView.h  

TSharedPtr< FUICommandList > 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) IDetailsView.h  

TSharedPtr< FTabManager > GetHostTabManager()

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

FName GetIdentifier()

   IDetailsView.h  

FIsCustomRowReadOnly & GetIsCustomRowReadOnlyDelegate()

   IDetailsView.h  

FIsCustomRowVisible & GetIsCustomRowVisibleDelegate()

   IDetailsView.h  

FIsPropertyEditingEnabled & GetIsPropertyEditingEnabledDelegate()

   IDetailsView.h  

FIsPropertyReadOnly & GetIsPropertyReadOnlyDelegate()

   IDetailsView.h  

FIsPropertyVisible & GetIsPropertyVisibleDelegate()

   IDetailsView.h  

TSharedPtr< IDetailKeyframeHandler > GetKeyframeHandler()

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

int32 GetNumVisibleTopLevelObjects()

   IDetailsView.h  

FOnDisplayedPropertiesChanged & GetOnDisplayedPropertiesChanged()

   IDetailsView.h  

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

 Returns the boundary (in paint space) of a detail tree node if it's currently visible Otherwise return an invalid boundary IDetailsView.h  

TArray< FPropertyPath > GetPropertiesInOrderDisplayed()

 Returns a list of all the properties displayed (via full path), order in list corresponds to draw order: IDetailsView.h  
Returns the row number in the underlying TableView for each property being displayed. IDetailsView.h  

float GetRightColumnMinWidth()

 Gets the minimum width of the detail panel's right column. IDetailsView.h  

FVector2D GetScrollDistance()

   IDetailsView.h  

FVector2D GetScrollDistanceRemaining()

   IDetailsView.h  

TSharedRef< SWidget > GetScrollWidget()

   IDetailsView.h  

const FSelectedActorInfo & GetSelectedActorInfo()

   IDetailsView.h  

const TArray< TWeakObjectPtr< AActor > > & GetSelectedActors()

   IDetailsView.h  

const TArray< TWeakObjectPtr< UObject > > & GetSelectedObjects()

 List of all selected objects we are inspecting IDetailsView.h  

const FDetailsViewStyleKey & GetStyleKey()

 Gets the FDetailsViewStyleKey& which provides a Key to the current style for a Details View IDetailsView.h  

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

 Returns the boundary (in tick space) of a detail tree node if it's currently visible Otherwise return an invalid boundary IDetailsView.h  

bool HasActiveSearch()

   IDetailsView.h  

bool HasClassDefaultObject()

   IDetailsView.h  

void HideFilterArea ( bool bIsVisible
)

 Sets the visible state of the filter box/property grid area IDetailsView.h  

void HighlightProperty ( const FPropertyPath& Property
)

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

virtual void InvalidateCachedState()

 Invalidates any cached state without necessarily doing a complete rebuild. IDetailsView.h  

virtual bool IsAncestorCollapsed ( const TSharedRef< IDetailTreeNode >& Node
) const

 Returns true if the provided detail tree node is part of a collapsed/hidden subsection of the details panel IDetailsView.h  

bool IsDefaultStyle()

 Returns a bool indicating whether the given FDetailsViewStyleKey is the default Details View Style IDetailsView.h  

bool IsLocked()

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

bool IsPropertyEditingEnabled()

   IDetailsView.h  

bool IsUpdatable()

   IDetailsView.h  

FOnFinishedChangingProperties & OnFinishedChangingProperties ()

 A delegate which is called after properties have been edited and PostEditChange has been called on all objects. IDetailsView.h  
Refreshes the visibility of root objects in this details view. IDetailsView.h  

void RegisterInstancedCustomPropertyLayout ( UStruct* Class,
FOnGetDetailCustomizationInstance DetailLayoutDelegate
)

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

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

   IDetailsView.h  

void RemoveInvalidObjects()

 Removes all invalid objects being observed by this details panel IDetailsView.h  

void RequestForceRefresh()

 Request the details view to be refreshed (new widgets generated) with the current set of objects on the next Tick IDetailsView.h  

bool ResetToDefaultSection()

 Resets the selected sections to the default 'All' section. IDetailsView.h  

void ScrollPropertyIntoView ( const FPropertyPath& Property,
bool bExpandProperty
)

 Scrolls the treenode for the specific property into view IDetailsView.h  

void SetChildrenCustomizationHandler ( TSharedPtr< IDetailPropertyChildrenCustomizationHandler > InExtensionHandler
)

   IDetailsView.h  

void SetClassViewerFilters ( const TArray< TSharedRef< IClassViewerFilter > >& InFilters
)

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

void SetCustomFilterDelegate ( FSimpleDelegate InDelegate
)

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

void SetCustomFilterLabel ( FText InText
)

   IDetailsView.h  

void SetCustomValidatePropertyNodesFunction ( FOnValidateDetailsViewPropertyNodes InCustomValidatePropertyNodesFunction
)

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

void SetDisableCustomDetailLayouts ( bool bInDisableCustomDetailLayouts
)

 Disables or enables customization of the details view: IDetailsView.h  

void SetExtensionHandler ( TSharedPtr< IDetailPropertyExtensionHandler > InExtensionHandler
)

   IDetailsView.h  

void SetGenericLayoutDetailsDelegate ( FOnGetDetailCustomizationInstance OnGetGenericDetails
)

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

void SetHostTabManager ( TSharedPtr< FTabManager > InTabManager
)

 Sets the tab manager of the hosting toolkit (can be nullptr if the details panel is not hosted within a tab) IDetailsView.h  

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

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

void SetIsPropertyEditingEnabledDelegate ( FIsPropertyEditingEnabled IsPropertyEditingEnabled
)

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

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

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

void SetKeyframeHandler ( TSharedPtr< IDetailKeyframeHandler > InKeyframeHandler
)

   IDetailsView.h  

void SetNameAreaCustomContent ( TSharedRef< SWidget >& InCustomContent
)

 Optionally add custom tools into the NameArea IDetailsView.h  

void SetObject ( UObject* InObject,
bool bForceRefresh
)

 Sets a single object that details view is viewing IDetailsView.h  

void SetObjectFilter ( TSharedPtr< FDetailsViewObjectFilter > InFilter
)

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

void SetObjectPackageOverrides ( const TMap< TWeakObjectPtr< UObject >, TWeakObjectPtr< UPackage > >& InMapping
)

 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) IDetailsView.h  

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

 Sets the objects this details view is viewing IDetailsView.h  

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

   IDetailsView.h  

void SetOnDisplayedPropertiesChanged ( FOnDisplayedPropertiesChanged InOnDisplayedPropertiesChangedDelegate
)

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

void SetOnObjectArrayChanged ( FOnObjectArrayChanged OnObjectArrayChangedDelegate
)

 Sets the callback for when the property view changes IDetailsView.h  

void SetRightColumnMinWidth ( float InMinWidth
)

 Sets the minimum width of the detail panel's right column. IDetailsView.h  

void SetRootExpansionStates ( const bool bExpand,
const bool bRecurse
)

 Sets the expansion state all root nodes and optionally all of their children IDetailsView.h  
Registers a customization that will be used only if this details panel contains multiple top level objects. IDetailsView.h  

void ShowAllAdvancedProperties()

 Forces all advanced property sections to be in expanded state: IDetailsView.h  

void UnregisterInstancedCustomPropertyLayout ( UStruct* Class
)

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

void UnregisterInstancedCustomPropertyTypeLayout ( FName PropertyTypeName,
TSharedPtr< IPropertyTypeIdentifier > Identifier
)

   IDetailsView.h  

void UpdatePropertyAllowList ( const TSet< FPropertyPath >& InAllowedProperties
)

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

void UpdateStyleKey()

 Updates FDetailsViewStyleKey&StyleKey for the current IDetailsView state IDetailsView.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page