Navigation
API > API/Editor > API/Editor/StructUtilsEditor
Node builder for FInstancedPropertyBag children.
- ValueProperty is FInstancedStruct of the FInstancedPropertyBag
- StructProperty is FInstancedPropertyBag Can be used in a implementation of a IPropertyTypeCustomization CustomizeChildren() to display editable FInstancedPropertyBag contents. Use FPropertyBagDetails::MakeAddPropertyWidget() to create the add property widget. OnChildRowAdded() is called right after each property is added, which allows the property row to be customizable.
| Name | FPropertyBagInstanceDataDetails |
| Type | class |
| Header File | /Engine/Source/Editor/StructUtilsEditor/Public/PropertyBagDetails.h |
| Include Path | #include "PropertyBagDetails.h" |
Syntax
class FPropertyBagInstanceDataDetails : public FInstancedStructDataDetails
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FInstancedStructDataDetails → FPropertyBagInstanceDataDetails
Implements Interfaces
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FPropertyBagInstanceDataDetails
(
TSharedPtr< IPropertyHandle > InStructProperty, |
For backwards compatibility. | PropertyBagDetails.h | |
| PropertyBagDetails.h | |||
FPropertyBagInstanceDataDetails
(
const FPropertyBagInstanceDataDetails& Other |
PropertyBagDetails.h | ||
FPropertyBagInstanceDataDetails
(
const FConstructParams& ConstructParams |
Primary constructor. Values passed by parameter struct. | PropertyBagDetails.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
PRAGMA_DISABLE_DEPRECATION_WARNINGS ~FPropertyBagInstanceDataDetails() |
Required for deprecated variable 'bFixedLayout' and 'bAllowArrays'. TODO: Remove when removing 5.6 deprecations. | PropertyBagDetails.h |
Structs
| Name | Remarks |
|---|---|
| FConstructParams | |
| IPropertyBagOverrideProvider | Interface to allow to modify override status of a specific parameter. |
Enums
Public
| Name | Remarks |
|---|---|
| EPropertyOverrideState | Enum describing if a property is overridden, or undetermined (e.g. multiselection) |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| EnumeratePropertyBagFuncRef | TFunctionRef< bool(const FInstancedPropertyBag &, FInstancedPropertyBag &, IPropertyBagOverrideProvider &)> | Callback function for EnumeratePropertyBags. | PropertyBagDetails.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void EnumeratePropertyBags
(
TSharedPtr< IPropertyHandle > PropertyBagHandle, |
Called to enumerate each property bag on the property handle. | PropertyBagDetails.h | |
virtual bool HasPropertyOverrides () |
Method that is called to determine if a derived class has property override logic implemented. | PropertyBagDetails.h | |
virtual bool IsDefaultValue
(
TSharedPtr< IPropertyHandle > ChildPropertyHandle |
PropertyBagDetails.h | ||
virtual EPropertyOverrideState IsPropertyOverridden
(
TSharedPtr< IPropertyHandle > ChildPropertyHandle |
PropertyBagDetails.h | ||
virtual void PostChangeOverrides() |
Called after property override is changed. | PropertyBagDetails.h | |
virtual void PreChangeOverrides() |
Called before property override is changed. | PropertyBagDetails.h | |
virtual void ResetToDefault
(
TSharedPtr< IPropertyHandle > ChildPropertyHandle |
Called to reset the child property to default value. | PropertyBagDetails.h | |
virtual void SetPropertyOverride
(
TSharedPtr< IPropertyHandle > ChildPropertyHandle, |
Called to set the override state of specified child property. | PropertyBagDetails.h |
Overridden from FInstancedStructDataDetails
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnChildRowAdded
(
IDetailPropertyRow& ChildRow |
Called when a child is added, override to customize a child row. | PropertyBagDetails.h | |
virtual void OnGroupRowAdded
(
IDetailGroup& GroupRow, |
Called when a group is added, override to customize a group row. | PropertyBagDetails.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedRef< SWidget > OnPropertyNameContent
(
TSharedPtr< IPropertyHandle > ChildPropertyHandle, |
PropertyBagDetails.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| PropertyBagDetails.h | |||
FPropertyBagInstanceDataDetails & operator=
(
const FPropertyBagInstanceDataDetails& Other |
PropertyBagDetails.h |