FPropertyEditorModule

Windows
MacOS
Linux

Inheritance Hierarchy

IModuleInterface

FPropertyEditorModule

References

Module

PropertyEditor

Header

/Engine/Source/Editor/PropertyEditor/Public/PropertyEditorModule.h

Include

#include "PropertyEditorModule.h"

Syntax

class FPropertyEditorModule : public IModuleInterface

Functions

Name Description

Public function Virtual

TSharedRef< ...

 

CreateDetailView

(
    const FDetailsViewArgs& DetailsVie...
)

Creates a new detail view

Public function Virtual

TSharedRef< ...

 

CreateFloatingDetailsView

(
    const TArray< UObject* >& InO...,
    bool bIsLockable
)

Convenience method for creating a new floating details window (a details view with its own top level window)

Public function Virtual

TSharedRef< ...

 

CreatePropertyChangeListener()

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

Public function Virtual

TSharedRef< ...

 

CreatePropertyEditorToolkit

(
    const EToolkitMode::Type Mode,
    const TSharedPtr< IToolkitHost >& ...,
    const TArray< TWeakObjectPtr< UObje...
)

Public function Virtual

TSharedRef< ...

 

CreatePropertyEditorToolkit

(
    const EToolkitMode::Type Mode,
    const TSharedPtr< class IToolkitHos...,
    UObject* ObjectToEdit
)

Public function Virtual

TSharedRef< ...

 

CreatePropertyEditorToolkit

(
    const EToolkitMode::Type Mode,
    const TSharedPtr< IToolkitHost >& ...,
    const TArray< UObject* >& Obj...
)

Public function Virtual

TSharedRef< ...

 

CreatePropertyRowGenerator

(
    const FPropertyRowGeneratorArgs& I...
)

Public function Virtual

TSharedRef< ...

 

CreatePropertyTable()

Public function Virtual

TSharedRef< ...

 

CreatePropertyTableWidget

(
    const TSharedRef< class IPropertyTa...
)

Public function Virtual

TSharedRef< ...

 

CreatePropertyTableWidget

(
    const TSharedRef< class IPropertyTa...,
    const TArray< TSharedRef< class IPr...
)

Public function Virtual

TSharedRef< ...

 

CreatePropertyTableWidgetHandle

(
    const TSharedRef< IPropertyTable > ...
)

Public function Virtual

TSharedRef< ...

 

CreatePropertyTableWidgetHandle

(
    const TSharedRef< IPropertyTable > ...,
    const TArray< TSharedRef< class IPr...
)

Public function Virtual

TSharedPtr< ...

 

CreateSingleProperty

(
    UObject* InObject,
    FName InPropertyName,
    const FSinglePropertyParams& InitP...
)

Creates a standalone widget for a single property

Public function Virtual

TSharedRef< ...

 

CreateStructureDetailView

(
    const FDetailsViewArgs& DetailsVie...,
    const FStructureDetailsViewArgs& S...,
    TSharedPtr< class FStructOnScope > ...,
    const FText& CustomName
)

Public function Virtual

TSharedRef< ...

 

CreateTextPropertyCellPresenter

(
    const TSharedRef< class FPropertyNo...,
    const TSharedRef< class IPropertyTa...,
    const FSlateFontInfo* InFontPt...
)

Public function Virtual Const

TSharedPtr< ...

 

FindDetailView

(
    const FName ViewIdentifier
)

Find an existing detail view

Public function

FPropertyTyp...

 

FindPropertyTypeLayoutCallback

(
    FName PropertyTypeName,
    const IPropertyHandle& PropertyHan...,
    const FCustomPropertyTypeLayoutMap ...
)

Public function Const

const FCusto...

 

GetClassNameToDetailLayoutNameMap()

Public function

FPropertyTyp...

 

GetPropertyTypeCustomization

(
    const FProperty* InProperty,
    const IPropertyHandle& PropertyHan...,
    const FCustomPropertyTypeLayoutMap ...
)

Public function Virtual Const

bool

 

HasUnlockedDetailViews()

Returns true if there is an unlocked detail view

Public function Const

bool

 

IsCustomizedStruct

(
    const UStruct* Struct,
    const FCustomPropertyTypeLayoutMap ...
)

Public function Virtual

void

 

NotifyCustomizationModuleChanged()

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

Public function Virtual

FPropertyEdi...

 

OnPropertyEditorOpened()

Public function Virtual

void

 

RegisterCustomClassLayout

(
    FName ClassName,
    FOnGetDetailCustomizationInstance D...
)

Registers a custom detail layout delegate for a specific class

Public function Virtual

void

 

RegisterCustomPropertyTypeLayout

(
    FName PropertyTypeName,
    FOnGetPropertyTypeCustomizationInst...,
    TSharedPtr< IPropertyTypeIdentifier...
)

Registers a property type customization A property type is a specific FProperty type, a struct, or enum type

Public function Virtual

FStructPrope...

 

RegisterStructOnScopeProperty

(
    TSharedRef< FStructOnScope > Struct...
)

Register a floating struct on scope so that the details panel may use it as a property

Public function Virtual

void

 

RemoveDeletedObjects

(
    TArray< UObject* >& DeletedOb...
)

Removes deleted objects from property views that are observing them

Public function Virtual

void

 

ReplaceViewedObjects

(
    const TMap< UObject*, UObject ...
)

Replaces objects being viewed by open property views with new objects

Public function Virtual

void

 

UnregisterCustomClassLayout

(
    FName ClassName
)

Unregisters a custom detail layout delegate for a specific class name

Public function Virtual

void

 

UnregisterCustomPropertyTypeLayout

(
    FName PropertyTypeName,
    TSharedPtr< IPropertyTypeIdentifier...
)

Unregisters a custom detail layout for a properrty type

Public function Virtual

void

 

UpdatePropertyViews

(
    const TArray< UObject* >& New...
)

Refreshes property windows with a new list of objects to view

Overridden from IModuleInterface

Name Description

Public function Virtual

void

 

ShutdownModule()

Called by the module manager right before this module is unloaded

Public function Virtual

void

 

StartupModule()

Called right after the module has been loaded

Classes

Name

Description

Public class

FPropertyEditorOpenedEvent

Deprecated Functions

Name Description

Public function Virtual

void

 

RegisterCustomPropertyTypeLayout

(
    FName PropertyTypeName,
    FOnGetPropertyTypeCustomizationInst...,
    TSharedPtr< IPropertyTypeIdentifier...,
    TSharedPtr< IDetailsView > ForSpeci...
)

This version of RegisterCustomPropertyTypeLayout has been deprecated. For per-details instance customization call IDetailsView::RegisterInstancedCustomPropertyTypeLayout

Public function Virtual

void

 

UnregisterCustomPropertyTypeLayout

(
    FName PropertyTypeName,
    TSharedPtr< IPropertyTypeIdentifier...,
    TSharedPtr< IDetailsView > ForSpeci...
)

This version of UnregisterCustomPropertyTypeLayout has been deprecated. For per-details instance customization call IDetailsView::UnregisterInstancedCustomPropertyTypeLayout

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss