1. Epic GamesDeveloper
  3. FPropertyEditorModule

FPropertyEditorModule

API > API/Editor > API/Editor/PropertyEditor

Inheritance Hierarchy

References

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

Syntax

class FPropertyEditorModule : public IModuleInterface

Functions

  Type Name Description
Public function Virtual TSharedRef< class IDetailsView >

CreateDetailView ( const FDetailsViewArgs& DetailsViewArgs
)

 Creates a new detail view
Public function Virtual TSharedRef< SWindow >

CreateFloatingDetailsView ( const TArray< UObject* >& InObjects,
bool bIsLockable
)

 Convenience method for creating a new floating details window (a details view with its own top level window)
Public function Virtual TSharedRef< class IPropertyChangeListener > Creates a property change listener that notifies users via a delegate when a property on an object changes
Public function Virtual TSharedRef< FAssetEditorToolkit >

CreatePropertyEditorToolkit ( const TSharedPtr< IToolkitHost >& InitToolkitHost,
const TArray< TWeakObjectPtr< UObject > >& ObjectsToEdit
)

  
Public function Virtual TSharedRef< FAssetEditorToolkit >

CreatePropertyEditorToolkit ( const TSharedPtr< IToolkitHost >& InitToolkitHost,
const TArray< UObject* >& ObjectsToEdit
)

  
Public function Virtual TSharedRef< FAssetEditorToolkit >

CreatePropertyEditorToolkit ( const TSharedPtr< class IToolkitHost >& InitToolkitHost,
UObject* ObjectToEdit
)

  
Public function Virtual TSharedRef< class IPropertyRowGenerator >  
Public function Virtual TSharedRef< class IPropertyTable >  
Public function Virtual TSharedRef< SWidget >

CreatePropertyTableWidget ( const TSharedRef< class IPropertyTable >& PropertyTable,
const TArray< TSharedRef< class IPropertyTableCustomColumn > >& Customizations
)

  
Public function Virtual TSharedRef< SWidget >

CreatePropertyTableWidget ( const TSharedRef< class IPropertyTable >& PropertyTable
)

  
Public function Virtual TSharedRef< class IPropertyTableWidgetHandle >  
Public function Virtual TSharedRef< class IPropertyTableWidgetHandle >

CreatePropertyTableWidgetHandle ( const TSharedRef< IPropertyTable >& PropertyTable,
const TArray< TSharedRef< class IPropertyTableCustomColumn > >& Customizations
)

  
Public function Virtual TSharedPtr< class ISinglePropertyView >

CreateSingleProperty ( UObject* InObject,
FName InPropertyName,
const FSinglePropertyParams& InitParams
)

 Creates a standalone widget for a single property
Public function Virtual TSharedRef< class IStructureDetailsView >

CreateStructureDetailView ( const FDetailsViewArgs& DetailsViewArgs,
const FStructureDetailsViewArgs& StructureDetailsViewArgs,
TSharedPtr< class FStructOnScope > StructData,
const FText& CustomName
)

  
Public function Virtual TSharedRef< IPropertyTableCellPresenter >

CreateTextPropertyCellPresenter ( const TSharedRef< class FPropertyNode >& InPropertyNode,
const TSharedRef< class IPropertyTableUtilities >& InPropertyUtilities,
const FSlateFontInfo* InFontPtr,
const TSharedPtr< IPropertyTableCell >& InCell
)

  
Public function Virtual Const TSharedPtr< class IDetailsView >

FindDetailView ( const FName ViewIdentifier
)

 Find an existing detail view
Public function Virtual TSharedRef< FPropertySection >

FindOrCreateSection ( FName ClassName,
FName SectionName,
FText DisplayName
)

 Find an existing section or create a section for a class.
Public function FPropertyTypeLayoutCallback

FindPropertyTypeLayoutCallback ( FName PropertyTypeName,
const IPropertyHandle& PropertyHandle,
const FCustomPropertyTypeLayoutMap& InstancedPropertyTypeLayoutMapp
)

  
Public function Virtual Const TArray< TSharedPtr< FPropertySection > >

FindSectionsForCategory ( const UStruct* Struct,
FName CategoryName
)

 Find the section that the given category in the given struct should be a part of.
Public function Virtual Const void

GetAllSections ( const UStruct* Struct,
TArray< TSharedPtr< FPropertySection >>& OutSections
)

 Get all registered sections for the given struct (including the default section).
Public function Const const bool  
Public function Const const FCustomDetailLayoutNameMap &  
Public function FOnGenerateGlobalRowExtension & Get the global row extension generators.
Public function FPropertyTypeLayoutCallback

GetPropertyTypeCustomization ( const FProperty* InProperty,
const IPropertyHandle& PropertyHandle,
const FCustomPropertyTypeLayoutMap& InstancedPropertyTypeLayoutMap
)

  
Public function Virtual Const bool Returns true if there is an unlocked detail view
Public function Const bool

IsCustomizedStruct ( const UStruct* Struct,
const FCustomPropertyTypeLayoutMap& InstancePropertyTypeLayoutMap
)

  
Public function Virtual void Customization modules should call this when that module has been unloaded, loaded, etc...
Public function Virtual FPropertyEditorOpenedEvent &  
Public function Virtual void

RegisterCustomClassLayout ( FName ClassName,
FOnGetDetailCustomizationInstance DetailLayoutDelegate,
FRegisterCustomClassLayoutParams Params
)

 Registers a custom detail layout delegate for a specific class
Public function Virtual void

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

 Registers a property type customization A property type is a specific FProperty type, a struct, or enum type
Public function Virtual FStructProperty * Register a floating struct on scope so that the details panel may use it as a property
Public function Virtual void

RemoveDeletedObjects ( TArray< UObject* >& DeletedObjects
)

 Removes deleted objects from property views that are observing them
Public function Virtual void

RemoveSection ( FName ClassName,
FName SectionName
)

 Remove a given section from the given class.
Public function Virtual void

ReplaceViewedObjects ( const TMap< UObject*, UObject* >& OldToNewObjectMap
)

 Replaces objects being viewed by open property views with new objects
Public function void

SetCanUsePropertyMatrix ( const bool bInCanUsePropertyMatrix
)

  
Public function Virtual void Unregisters a custom detail layout delegate for a specific class name
Public function Virtual void Unregisters a custom detail layout for a property type
Public function Virtual void

UpdatePropertyViews ( const TArray< UObject* >& NewObjectList
)

 Refreshes property windows with a new list of objects to view

Overridden from IModuleInterface

  Type Name Description
Public function Virtual void Called by the module manager right before this module is unloaded
Public function Virtual void Called right after the module has been loaded

Classes

  Type Name Description
Public class FPropertyEditorOpenedEvent    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page