PropertyEditor

Windows
MacOS
Linux

Classes

Name

Description

Public struct

FAddPropertyParams

Parameters required for specifying behavior when adding external properties from detail customizations

Public class

FDetailArrayBuilder

Public struct

FDetailLayoutCallback

Callback executed to query the custom layout of details

Public struct

FDetailsObjectSet

Defines a set of objects and a common base class between them for a root object customization

Public struct

FDetailsViewArgs

Init params for a details view widget

Public class

FDetailsViewObjectFilter

An object filter determines the root objects that should be displayed from a set of given source objects passed to the details panel

Public struct

FDetailsViewObjectRoot

An object root is a collection of UObjects that represent a top level set of properties in a details panel When there are multiple objects in the root, the common base class for all those objects are found and the properties on that common base class are displayed When a user edits one of those properties, it will propagate the result to all objects in the root.

Public class

FDetailWidgetDecl

Widget declaration for custom widgets in a widget row

Public class

FDetailWidgetRow

Represents a single row of custom widgets in a details panel

Public class

FMaterialList

Public struct

FMaterialListDelegates

Public struct

FMaterialListItem

A Material item in a material list slot

Public struct

FNodeWidgetLayoutData

Layout data for node's content widgets.

Public struct

FNodeWidgets

The widget contents of the node. Any of these can be null depending on how the row was generated

Public struct

FPropertyAndParent

Public class

FPropertyEditorModule

Public struct

FPropertyInfo

Copyright Epic Games, Inc. All Rights Reserved.

Public struct

FPropertyListenerSettings

Public class

FPropertyPath

Public class

FPropertyRestriction

Public struct

FPropertyRowGeneratorArgs

Public struct

FPropertyTypeLayoutCallback

Public struct

FPropertyTypeLayoutCallbackList

Public class

FResetToDefaultOverride

Structure describing the delegates needed to override the behavior of reset to default in detail properties

Public class

FSectionList

Public struct

FSectionListDelegates

Public struct

FSectionListItem

A Section item in a Section list slot

Public struct

FSinglePropertyParams

Init params for a single property

Public struct

FStructureDetailsViewArgs

Struct used to control the visibility of properties in a Structure Detail View

Public struct

FVariablePrecisionNumericInterface

Allow more precision as the numbers get closer to zero

Public class

IDataSource

Public class

IDetailCategoryBuilder

Represents a category for the a details view

Public class

IDetailChildrenBuilder

Builder for adding children to a detail customization

Public class

IDetailCustomization

Interface for any class that lays out details for a specific class

Public class

IDetailCustomNodeBuilder

A custom node that can be given to a details panel category to customize widgets

Public class

IDetailGroup

A group in the details panel that can have children

Public class

IDetailKeyframeHandler

Public class

IDetailLayoutBuilder

The builder for laying custom details

Public class

IDetailPropertyExtensionHandler

Public class

IDetailPropertyRow

A single row for a property in a details panel

Public class

IDetailRootObjectCustomization

Interface for any class that lays out details for a specific class

Public class

IDetailsView

Interface class for all detail views

Public class

IDetailTreeNode

Public class

IMaterialListBuilder

Builds up a list of unique materials while creating some information about the materials

Public class

IPropertyChangeListener

Interface to a property change listener that broadcasts notifications when a property changes

Public class

IPropertyHandle

A handle to a property which is used to read and write the value without needing to handle Pre/PostEditChange, transactions, package modification A handle also is used to identify the property in detail customization interfaces

Public class

IPropertyHandleArray

A handle to an array property which allows you to manipulate the array

Public class

IPropertyHandleMap

A handle to a property which allows you to manipulate a Map

Public class

IPropertyHandleSet

A handle to a property which allows you to manipulate a Set

Public class

IPropertyRowGenerator

Public class

IPropertyTable

Public class

IPropertyTableCell

Copyright Epic Games, Inc. All Rights Reserved.

Public class

IPropertyTableCellPresenter

Copyright Epic Games, Inc. All Rights Reserved.

Public class

IPropertyTableColumn

Public class

IPropertyTableCustomColumn

Public class

IPropertyTableRow

Copyright Epic Games, Inc. All Rights Reserved.

Public class

IPropertyTableUtilities

Copyright Epic Games, Inc. All Rights Reserved.

Public class

IPropertyTableWidgetHandle

Copyright Epic Games, Inc. All Rights Reserved.

Public class

IPropertyTreeRow

Public class

IPropertyTypeCustomization

Base class for property type customizations

Public class

IPropertyTypeCustomizationUtils

Utilities for property type customization

Public class

IPropertyTypeIdentifier

Base class for adding an extra data to identify a custom property type

Public class

IPropertyUtilities

Settings for property editor widgets that call up to the base container for the widgets without knowing information about that container

Public class

ISectionListBuilder

Builds up a list of unique Sections while creating some information about the Sections

Public class

ISinglePropertyView

Represents a single property not in a property tree or details view for a single object Structs and Array properties cannot be used with this method

Public class

IStructCustomization

Deprecated IStructCustomization interface

Public class

IStructureDetailsView

Interface class for all detail views

Public class

SClassPropertyEntryBox

Simulates a class property field Can be used when a property should act like a FClassProperty but it isn't one

Public class

SMaterialSlotWidget

Helper class to create a material slot name widget for material lists

Public class

SObjectPropertyEntryBox

Simulates an object property field Can be used when a property should act like a FObjectProperty but it isn't one

Public class

SPerPlatformPropertiesWidget

SPerPlatformPropertiesWidget

Public class

SProperty

Represents a widget that can display a FProperty With the ability to customize the look of the property

Public class

SResetToDefaultMenu

Displays a reset to default menu for a set of properties Will hide itself automatically when all of the properties being observed are already at their default values

Public class

SStructPropertyEntryBox

Simulates a struct type property field Can be used when a property should act like a struct type but it isn't one

Constants

Name

Description

InvalidDetailWidgetName

Typedefs

Name

Description

FConstructExternalColumnCell

FConstructExternalColumnHeaders

FCustomDetailLayoutMap

FCustomDetailLayoutNameMap

FCustomPropertyTypeLayoutMap

This is a multimap as there many be more than one customization per property type

FIsCustomRowVisibilityFiltered

Delegate called to check if custom row visibility is filtered, i.e. whether FIsCustomRowVisible delegate will always return true no matter the parameters.

FIsCustomRowVisible

Delegate called to determine if a custom row should be visible.

FIsPropertyEditingEnabled

Delegate called to see if a property editing is enabled

FIsPropertyReadOnly

Delegate called to see if a property should be read-only

FIsPropertyVisible

Delegate called to see if a property should be visible

FIsResetToDefaultVisible

FOnAssetSelected

FOnCanCopyMaterialItem

FOnCanCopyMaterialList

FOnCanCopySectionItem

FOnCanCopySectionList

FOnComponentSelected

FOnCopyMaterialItem

FOnCopyMaterialList

FOnCopySectionItem

FOnCopySectionList

FOnDisplayedPropertiesChanged

Notification for when displayed properties changes (for instance, because the user has filtered some properties

FOnEnableSectionItem

FOnFinishedChangingProperties

A delegate which is called after properties have been edited and PostEditChange has been called on all objects.

FOnGenerateArrayElementWidget

FOnGenerateLODComboBox

FOnGenerateWidgetsForMaterial

FOnGenerateWidgetsForSection

FOnGetActorFilters

FOnGetDetailCustomizationInstance

Delegate called to get a detail layout for a specific object class

FOnGetMaterials

Delegate called when we need to get new materials for the list

FOnGetObject

Delegate used to get a generic object

FOnGetPropertyComboBoxStrings

FOnGetPropertyComboBoxValue

FOnGetPropertyTypeCustomizationInstance

Delegate called to get a property layout for a specific property type

FOnGetResetToDefaultText

Delegate used to get the text to display when resetting our value This will only be used when we are not using a property handle.

FOnGetSections

SECTION LIST Delegate called when we need to get new sections for the list

FOnInstancedPropertyIteration

FOnIsEnabled

FOnMaterialChanged

Delegate called when a user changes the material

FOnMaterialListDirty

FOnObjectArrayChanged

Notification for when a property view changes

FOnPasteMaterialItem

FOnPasteMaterialList

FOnPasteSectionItem

FOnPasteSectionList

FOnPropertyClicked

Notification for when a property is clicked by the user

FOnPropertyComboBoxValueSelected

FOnPropertyDoubleClicked

Notification for when a property is double clicked by the user

FOnPropertySelectionChanged

Notification for when a property selection changes.

FOnResetMaterialToDefaultClicked

FOnResetSectionToDefaultClicked

FOnSectionChanged

Delegate called when a user changes the Section

FOnSetClass

Delegate used to set a class

FOnSetObject

Delegate used to set a generic object

FOnSetStruct

Delegate used to set a struct

FOnShouldFilterAsset

FOnShouldFilterComponent

FOnShouldSetAsset

FResetToDefaultHandler

IStructCustomizationUtils

Deprecated IStructCustomizationUtils interface

Type

Enums

Name

Description

Public enum

ECategoryPriority::Type

Public enum

EDetailNodeType

Public enum

EEditDefaultsOnlyNodeVisibility

Public enum

EPropertyLocation::Type

The location of a property within a category

Public enum

EPropertyNamePlacement::Type

The location of a property name relative to its editor widget

Public enum

EPropertyTableColumnSizeMode::Type

Copyright Epic Games, Inc. All Rights Reserved.

Public enum

EPropertyTableOrientation::Type

Public enum

EPropertyTableSelectionUnit::Type

Public enum

FPropertyAccess::Result

Potential results from accessing the values of properties

Functions

Name Description

Public function

uint32

 

GetTypeHash

(
    FPropertyPath const& Path
)

Public function

bool

 

operator!=

(
    const FPropertyPath& LHS,
    const FPropertyPath& RHS
)

Public function

bool

 

operator==

(
    const FPropertyPath& LHS,
    const FPropertyPath& RHS
)

Public function

void

 

PropertyCustomizationHelpers::MakeInstancedPropertyCustomUI

(
    TMap< FName, IDetailGroup* >&...,
    IDetailCategoryBuilder& BaseCatego...,
    TSharedRef< IPropertyHandle >& Bas...,
    FOnInstancedPropertyIteration AddRo...
)

Loops through all of an instanced object property's child properties and call AddRowDelegate on properties that needs to be added to the UI to let us customize it.

Public function

TSharedRef< ...

 

PropertyCustomizationHelpers::MakePropertyComboBox

(
    const TSharedPtr< IPropertyHandle >...,
    FOnGetPropertyComboBoxStrings OnGet...,
    FOnGetPropertyComboBoxValue OnGetVa...,
    FOnPropertyComboBoxValueSelected On...
)

Build a combo button that you bind to a Name or String property or use general delegates

Variables

Name Description

Public variable

const Type

 

DefaultFlags

Normal way to call set value (make a transaction, call posteditchange)

Public variable

const Type

 

InteractiveChange

When PostEditChange is called mark the change as interactive (e.g, user is spinning a value in a spin box)

Public variable

const Type

 

NotTransactable

No transaction will be created when setting this value (no undo/redo)

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