1. Epic GamesDeveloper
  3. FPropertyEditorModule

FPropertyEditorModule

API > API/Editor > API/Editor/PropertyEditor

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

Syntax

class FPropertyEditorModule : public IModuleInterface

Implements Interfaces

Classes

Name Remarks
FPropertyEditorOpenedEvent  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AllDetailViews TArray< TWeakPtr< class SDetailsView > > All created detail views PropertyEditorModule.h  
AllSinglePropertyViews TArray< TWeakPtr< class SSingleProperty > > All created single property views PropertyEditorModule.h  
bCanUsePropertyMatrixOverride bool Override for if the Property Matrix is availabe PropertyEditorModule.h  
ClassNameToDetailLayoutNameMap FCustomDetailLayoutNameMap A mapping of class names to detail layout delegates, called when querying for custom detail layouts PropertyEditorModule.h  
ClassSectionMappings TMap< FName, TSharedPtr< FClassSectionMapping > > A mapping of class names to section mappings. PropertyEditorModule.h  
GlobalPropertyTypeToLayoutMap FCustomPropertyTypeLayoutMap A mapping of property names to property type layout delegates, called when querying for custom property layouts PropertyEditorModule.h  
GlobalThumbnailPool TSharedPtr< class FAssetThumbnailPool > Shared thumbnail pool used by property row generators PropertyEditorModule.h  
OnGenerateGlobalRowExtension FOnGenerateGlobalRowExtension Delegate called to extend the name column widget on a property row. PropertyEditorModule.h  
PropertyEditorOpened FPropertyEditorOpenedEvent Event to be called when a property editor is opened PropertyEditorModule.h  
PropertyHandleLayoutOverrides TMultiMap< FName, FPropertyHandleLayoutOverride > Registered list of override callbacks. PropertyEditorModule.h  
RegisteredStructToProxyMap TMap< FName, FStructProperty * > Mapping of registered floating UStructs to their struct proxy so they show correctly in the details panel PropertyEditorModule.h  
StructOnScopePropertyOwner UStruct * Container for ScopeOnStruct FStructProperty objects PropertyEditorModule.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual TSharedRef< class IDetailsView > CreateDetailView ( const FDetailsViewArgs& DetailsViewArgs
)

 Creates a new detail view PropertyEditorModule.h  

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

virtual TSharedRef< class IPropertyChangeListener > CreatePropertyChangeListener()

 Creates a property change listener that notifies users via a delegate when a property on an object changes PropertyEditorModule.h  

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

   PropertyEditorModule.h  

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

   PropertyEditorModule.h  

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

   PropertyEditorModule.h  

virtual TSharedRef< class IPropertyRowGenerator > CreatePropertyRowGenerator ( const FPropertyRowGeneratorArgs& InArgs
)

   PropertyEditorModule.h  

virtual TSharedRef< class IPropertyTable > CreatePropertyTable()

   PropertyEditorModule.h  

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

   PropertyEditorModule.h  

virtual TSharedRef< SWidget > CreatePropertyTableWidget ( const TSharedRef< class IPropertyTable >& PropertyTable
)

   PropertyEditorModule.h  

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

   PropertyEditorModule.h  
  PropertyEditorModule.h  

virtual TSharedPtr< class ISinglePropertyView > CreateSingleProperty ( const TSharedPtr< class IStructureDataProvider >& InStruct,
FName InPropertyName,
const FSinglePropertyParams& InitParams
)

 Creates a standalone widget for a single struct property PropertyEditorModule.h  

virtual TSharedPtr< class ISinglePropertyView > CreateSingleProperty ( UObject* InObject,
FName InPropertyName,
const FSinglePropertyParams& InitParams
)

 Creates a standalone widget for a single object property PropertyEditorModule.h  

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

   PropertyEditorModule.h  

virtual TSharedRef< class IStructureDetailsView > CreateStructureProviderDetailView ( const FDetailsViewArgs& DetailsViewArgs,
const FStructureDetailsViewArgs& StructureDetailsViewArgs,
TSharedPtr< IStructureDataProvider > StructProvider,
const FText& CustomName
)

   PropertyEditorModule.h  

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

   PropertyEditorModule.h  

virtual TSharedPtr< class IDetailsView > FindDetailView ( const FName ViewIdentifier
) const

 Find an existing detail view PropertyEditorModule.h  

virtual TSharedRef< FPropertySection > FindOrCreateSection ( FName ClassName,
FName SectionName,
FText DisplayName
)

 Find an existing section or create a section for a class. PropertyEditorModule.h  

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

   PropertyEditorModule.h  

virtual TArray< TSharedPtr< FPropertySection > > FindSectionsForCategory ( const UStruct* Struct,
FName CategoryName
) const

 Find the section that the given category in the given struct should be a part of. PropertyEditorModule.h  

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

 Get all registered sections for the given struct (including the default section). PropertyEditorModule.h  

const bool GetCanUsePropertyMatrix()

   PropertyEditorModule.h  

const FCustomDetailLayoutNameMap & GetClassNameToDetailLayoutNameMap()

   PropertyEditorModule.h  

FOnGenerateGlobalRowExtension & GetGlobalRowExtensionDelegate()

 Get the global row extension generators. PropertyEditorModule.h  

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

   PropertyEditorModule.h  

virtual bool HasUnlockedDetailViews()

 Returns true if there is an unlocked detail view PropertyEditorModule.h  

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

   PropertyEditorModule.h  
Customization modules should call this when that module has been unloaded, loaded, etc... PropertyEditorModule.h  

virtual FPropertyEditorOpenedEvent & OnPropertyEditorOpened()

   PropertyEditorModule.h  

virtual void RegisterCustomClassLayout ( FName ClassName,
FOnGetDetailCustomizationInstance DetailLayoutDelegate,
FRegisterCustomClassLayoutParams Params
)

 Registers a custom detail layout delegate for a specific class PropertyEditorModule.h  

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

virtual FDelegateHandle RegisterPropertyHandleLayoutOverride ( FName PropertyTypeName,
const FPropertyHandleLayoutOverride& Delegate
)

 Registers a property layout override callback PropertyEditorModule.h  

virtual FStructProperty * RegisterStructProperty ( const UStruct* StructClass
)

 Register a floating struct so that the details panel may use it as a property PropertyEditorModule.h  

virtual void RemoveDeletedObjects ( TArray< UObject* >& DeletedObjects
)

 Removes deleted objects from property views that are observing them PropertyEditorModule.h  

virtual void RemoveSection ( FName ClassName,
FName SectionName
)

 Remove a given section from the given class. PropertyEditorModule.h  

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

 Replaces objects being viewed by open property views with new objects PropertyEditorModule.h  

void SetCanUsePropertyMatrix ( const bool bInCanUsePropertyMatrix
)

   PropertyEditorModule.h  

virtual void UnregisterCustomClassLayout ( FName ClassName
)

 Unregisters a custom detail layout delegate for a specific class name PropertyEditorModule.h  

virtual void UnregisterCustomPropertyTypeLayout ( FName PropertyTypeName,
TSharedPtr< IPropertyTypeIdentifier > InIdentifier
)

 Unregisters a custom detail layout for a property type PropertyEditorModule.h  

virtual void UnregisterPropertyHandleLayoutOverride ( FDelegateHandle DelegateHandle
)

 Unregisters a property layout override callback PropertyEditorModule.h  

virtual void UpdatePropertyViews ( const TArray< UObject* >& NewObjectList
)

 Refreshes property windows with a new list of objects to view PropertyEditorModule.h  

Overridden from IModuleInterface

Name Remarks Include Path Unreal Specifiers

virtual void ShutdownModule()

 Called by the module manager right before this module is unloaded PropertyEditorModule.h  

virtual void StartupModule()

 Called right after the module has been loaded PropertyEditorModule.h  

Static

Name Remarks Include Path Unreal Specifiers

static void PopulateRowContextMenu ( UToolMenu* InToolMenu
)

   PropertyEditorModule.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page