Language:
Discover
By Skill Level
By Category

IPropertyHandle

Choose your OS:

Inheritance Hierarchy

TSharedFromThis

IPropertyHandle

Syntax

class IPropertyHandle : public TSharedFromThis< IPropertyHandle >

Remarks

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

Destructors

Name Description

Public function Virtual

~IPropertyHandle()

Functions

Name Description

Public function

void

 

AccessRawData

(
    TArray < const void* >& RawDat...
)

Public function

void

 

AccessRawData

(
    TArray < void* >& RawData
)

Accesses the raw data of this property. (Each pointer can be cast to the property data type)

Public function

TArray < TSha ...

 

AddChildStructure

(
    TSharedRef < FStructOnScope > ChildS...
)

Adds a child structure

An array of interfaces to the properties that were added

Public function

void

 

AddRestriction

(
    TSharedRef < const class FPropertyRe ...
)

Adds a restriction to the possible values for this property.

Public function

TSharedPtr < ...

 

AsArray()

Returns this handle as an array if possible

Public function

TSharedPtr < ...

 

AsMap()

This handle as a map if possible

Public function

TSharedPtr < ...

 

AsSet()

This handle as a set if possible

Public function

bool

 

CanResetToDefault()

Returns whether or not the property can be set to default

Public function

void

 

ClearResetToDefaultCustomized()

Marks this property as not having a custom reset to default (useful when a widget customizing reset to default goes away)

Public function

TSharedRef < ...

 

CreatePropertyNameWidget

(
    const FText & NameOverride,
    const FText & ToolTipOverride,
    bool bDisplayResetToDefault,
    bool bDisplayText,
    bool bDisplayThumbnail
)

Creates a name widget for this property

the name widget for this property

Public function

TSharedRef < ...

 

CreatePropertyValueWidget

(
    bool bDisplayDefaultPropertyButtons
)

Creates a value widget for this property

the value widget for this property

Public function

bool

 

DiffersFromDefault()

Whether or not the value differs from its default

Public function

void

 

EnumerateConstRawData

(
    const EnumerateConstRawDataFuncRef ...
)

Public function

void

 

EnumerateRawData

(
    const EnumerateRawDataFuncRef & InR...
)

Return true to continue enumeration

Public function

void

 

ExecuteCustomResetToDefault

(
    const FResetToDefaultOverride & OnC...
)

Sets an override for this property's reset to default behavior

Public function

FString

 

GeneratePathToProperty()

Generates a path from the parent UObject class to this property

Public function

bool

 

GeneratePossibleValues

(
    TArray < TSharedPtr < FString > >& O...,
    TArray < FText >& OutToolTips,
    TArray < bool >& OutRestrictedItems
)

Generates a list of possible enum/class options for the property

Public function

bool

 

GenerateRestrictionToolTip

(
    const FString & Value,
    FText & OutTooltip
)

Generates a consistent tooltip describing this restriction for use in the editor.

Public function

bool

 

GetBoolMetaData

(
    const FName & Key
)

Find the metadata value associated with the key and return bool

Public function

TSharedPtr < ...

 

GetChildHandle

(
    uint32 Index
)

Gets a child handle of this handle.

Public function

TSharedPtr < ...

 

GetChildHandle

(
    FName ChildName,
    bool bRecurse
)

Gets a child handle of this handle.

Public function

UClass *

 

GetClassMetaData

(
    const FName & Key
)

Find the metadata value associated with the key and return UClass*

Public function

FString

 

GetDocumentationExcerptName()

The custom documentation except name for this property

Public function

FString

 

GetDocumentationLink()

The custom documentation link for this property

Public function

float

 

GetFLOATMetaData

(
    const FName & Key
)

Find the metadata value associated with the key and return float

Public function

int32

 

GetIndexInArray()

The index of this element in an array if it is in one. INDEX_NONE otherwise

Public function

const FStrin ...

 

GetInstanceMetaData

(
    const FName & Key
)

Get metadata value for 'Key' for this property instance (as opposed to the class)

Public function

int32

 

GetINTMetaData

(
    const FName & Key
)

Find the metadata value associated with the key and return int32

Public function

TSharedPtr < ...

 

GetKeyHandle()

The property handle to the key element for this value if this is a map element

Public function

const FStrin ...

 

GetMetaData

(
    const FName & Key
)

Find the metadata value associated with the key

The value associated with the key

Public function

UProperty &#...

 

GetMetaDataProperty()

Gets the property we should use to read meta-data

Public function

FPropertyAcc ...

 

GetNumChildren

(
    uint32 & OutNumChildren
)

The number of children the property handle has

Public function

uint32

 

GetNumOuterObjects()

Get the number objects that contain this property and are being observed in the property editor

Public function

int32

 

GetNumPerObjectValues()

Gets the number of objects that this handle is editing

Public function

void

 

GetOuterObjects

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

Get the objects that contain this property

Public function

void

 

GetOuterPackages

(
    TArray < UPackage * >& OuterPac...
)

Get the packages that contain this property

Public function

TSharedPtr < ...

 

GetParentHandle()

A handle to the parent array if this handle is an array element

Public function

FPropertyAcc ...

 

GetPerObjectValue

(
    const int32 ObjectIndex,
    FString & OutObjectValue
)

Gets a value for the specified object that this handle is editing

Public function

FPropertyAcc ...

 

GetPerObjectValues

(
    TArray < FString >& OutPerObjectVal...
)

Gets a unique value for each object this handle is editing

Public function

UProperty &#...

 

GetProperty()

Gets the property being edited

Public function

const UClass ...

 

GetPropertyClass()

Gets the class of the property being edited

Public function

FText

 

GetPropertyDisplayName()

The display name of the property

Public function

FText

 

GetResetToDefaultLabel()

A label suitable for displaying the reset to default value

Public function

FText

 

GetToolTipText()

Gets the property tool tip text.

Public function

FPropertyAcc ...

 

GetValue

(
    UObject *& OutValue
)

Public function

FPropertyAcc ...

 

GetValue

(
    FRotator & OutValue
)

Public function

FPropertyAcc ...

 

GetValue

(
    const UObject *& OutValue
)

Public function

FPropertyAcc ...

 

GetValue

(
    float& OutValue
)

Gets the typed value of a property.

Public function

FPropertyAcc ...

 

GetValue

(
    double& OutValue
)

Public function

FPropertyAcc ...

 

GetValue

(
    bool& OutValue
)

Public function

FPropertyAcc ...

 

GetValue

(
    int8 & OutValue
)

Public function

FPropertyAcc ...

 

GetValue

(
    int64 & OutValue
)

Public function

FPropertyAcc ...

 

GetValue

(
    int32 & OutValue
)

Public function

FPropertyAcc ...

 

GetValue

(
    uint8 & OutValue
)

Public function

FPropertyAcc ...

 

GetValue

(
    uint16 & OutValue
)

Public function

FPropertyAcc ...

 

GetValue

(
    uint32 & OutValue
)

Public function

FPropertyAcc ...

 

GetValue

(
    uint64 & OutValue
)

Public function

FPropertyAcc ...

 

GetValue

(
    FString & OutValue
)

Public function

FPropertyAcc ...

 

GetValue

(
    FText & OutValue
)

Public function

FPropertyAcc ...

 

GetValue

(
    FName & OutValue
)

Public function

FPropertyAcc ...

 

GetValue

(
    FVector & OutValue
)

Public function

FPropertyAcc ...

 

GetValue

(
    FVector2D & OutValue
)

Public function

FPropertyAcc ...

 

GetValue

(
    int16 & OutValue
)

Public function

FPropertyAcc ...

 

GetValue

(
    FAssetData & OutValue
)

Public function

FPropertyAcc ...

 

GetValue

(
    FQuat & OutValue
)

Public function

FPropertyAcc ...

 

GetValue

(
    FVector4 & OutValue
)

Public function

FPropertyAcc ...

 

GetValueAsDisplayString

(
    FString & OutValue,
    EPropertyPortFlags PortFlags
)

Gets the value formatted as a string, possibly using an alternate form more suitable for display in the UI

Public function

FPropertyAcc ...

 

GetValueAsDisplayText

(
    FText & OutValue
)

Gets the value formatted as a string, as Text, possibly using an alternate form more suitable for display in the UI

Public function

FPropertyAcc ...

 

GetValueAsFormattedString

(
    FString & OutValue,
    EPropertyPortFlags PortFlags
)

Gets the value formatted as a string.

The result of attempting to get the value

Public function

FPropertyAcc ...

 

GetValueAsFormattedText

(
    FText & OutValue
)

Gets the value formatted as a string, as Text.

The result of attempting to get the value

Public function

uint8 *

 

GetValueBaseAddress

(
    uint8 * Base
)

Calculates the memory address for the data associated with this item's value.

Public function

FPropertyAcc ...

 

GetValueData

(
    void*& OutAddress
)

Public function

bool

 

HasDocumentation()

True if this property has custom documentation, false otherwise

Public function

bool

 

HasMetaData

(
    const FName & Key
)

Determines if the property has any metadata associated with the key

Public function

bool

 

IsCustomized()

True if this property's UI is customized

Public function

bool

 

IsDisabled

(
    const FString & Value,
    TArray < FText >& OutReasons
)

Tests if a value is disabled for this property.

True if this value is disabled.

Public function

bool

 

IsDisabled

(
    const FString & Value
)

Tests if a value is disabled for this property

True if this value is disabled.

Public function

bool

 

IsEditConst()

Whether or not the property is edit const (can't be changed)

Public function

bool

 

IsHidden

(
    const FString & Value
)

Tests if a value is hidden for this property

True if this value is hidden.

Public function

bool

 

IsHidden

(
    const FString & Value,
    TArray < FText >& OutReasons
)

Tests if a value is hidden for this property.

True if this value is hidden.

Public function

bool

 

IsResetToDefaultCustomized()

True if this property's reset to default UI is customized (but not necessarialy the property UI itself)

Public function

bool

 

IsRestricted

(
    const FString & Value
)

Tests if a value is restricted for this property

True if this value is restricted.

Public function

bool

 

IsRestricted

(
    const FString & Value,
    TArray < FText >& OutReasons
)

Tests if a value is restricted for this property.

True if this value is restricted.

Public function

bool

 

IsValidHandle()

Whether or not the handle points to a valid property node.

Public function

void

 

MarkHiddenByCustomization()

Marks this property has hidden by customizaton (will not show up in the default place)

Public function

void

 

MarkResetToDefaultCustomized

(
    bool bCustomized
)

Marks this property has having a custom reset to default (reset to default will not show up in the default place)

Public function

void

 

NotifyFinishedChangingProperties()

Called to manually notify root objects that this property has finished changing This does not need to be called when SetValue functions are used since it will be called automatically

Public function

void

 

NotifyPostChange

(
    EPropertyChangeType::Type ChangeTyp...
)

Called to manually notify root objects that this property has changed This does not need to be called when SetValue functions are used since it will be called automatically

Public function

void

 

NotifyPreChange()

Called to manually notify root objects that this property is about to change This does not need to be called when SetValue functions are used since it will be called automatically

Public function

void

 

ResetToDefault()

Resets the value to its default

Public function

void

 

SetIgnoreValidation

(
    bool bInIgnore
)

Sets whether or not data validation should occur for this property and all of its children.

Public function

void

 

SetInstanceMetaData

(
    const FName & Key,
    const FString & Value
)

Set metadata value for 'Key' to 'Value' on this property instance (as opposed to the class)

Public function

FPropertyAcc ...

 

SetObjectValueFromSelection()

Sets the object value from the current editor selection Will fail if this handle isn't an object property

Public function

void

 

SetOnChildPropertyValueChanged

(
    const FSimpleDelegate & InOnChildPr...
)

Sets a delegate to call when the value of the property of a child is changed

Public function

void

 

SetOnChildPropertyValuePreChange

(
    const FSimpleDelegate & InOnChildPr...
)

Sets a delegate to call when the value of the property of a child is about to be changed

Public function

void

 

SetOnPropertyResetToDefault

(
    const FSimpleDelegate & InOnPropert...
)

Sets a delegate to call when the property is reset to default

Public function

void

 

SetOnPropertyValueChanged

(
    const FSimpleDelegate & InOnPropert...
)

Sets a delegate to call when the value of the property is changed

Public function

void

 

SetOnPropertyValuePreChange

(
    const FSimpleDelegate & InOnPropert...
)

Sets a delegate to call when the value of the property is about to be changed

Public function

FPropertyAcc ...

 

SetPerObjectValue

(
    const int32 ObjectIndex,
    const FString & ObjectValue,
    EPropertyValueSetFlags::Type Flags
)

Sets a value on the specified object that this handle is editing

Public function

FPropertyAcc ...

 

SetPerObjectValues

(
    const TArray < FString >& PerObject...,
    EPropertyValueSetFlags::Type Flags
)

Sets a unique value for each object this handle is editing

Public function

void

 

SetPropertyDisplayName

(
    FText InDisplayName
)

Allows the handle to override the node's display name

Public function

void

 

SetToolTipText

(
    const FText & ToolTip
)

Sets the tooltip shown for this property

Public function

FPropertyAcc ...

 

SetValue

(
    const FText & InValue,
    EPropertyValueSetFlags::Type Flags
)

Public function

FPropertyAcc ...

 

SetValue

(
    const FName & InValue,
    EPropertyValueSetFlags::Type Flags
)

Public function

FPropertyAcc ...

 

SetValue

(
    const FVector & InValue,
    EPropertyValueSetFlags::Type Flags
)

Public function

FPropertyAcc ...

 

SetValue

(
    const FVector2D & InValue,
    EPropertyValueSetFlags::Type Flags
)

Public function

FPropertyAcc ...

 

SetValue

(
    UObject *const& InValue,
    EPropertyValueSetFlags::Type Flags
)

Public function

FPropertyAcc ...

 

SetValue

(
    const FQuat & InValue,
    EPropertyValueSetFlags::Type Flags
)

Public function

FPropertyAcc ...

 

SetValue

(
    const FRotator & InValue,
    EPropertyValueSetFlags::Type Flags
)

Public function

FPropertyAcc ...

 

SetValue

(
    const FString & InValue,
    EPropertyValueSetFlags::Type Flags
)

Public function

FPropertyAcc ...

 

SetValue

(
    const FVector4 & InValue,
    EPropertyValueSetFlags::Type Flags
)

Public function

FPropertyAcc ...

 

SetValue

(
    const uint64 & InValue,
    EPropertyValueSetFlags::Type Flags
)

Public function

FPropertyAcc ...

 

SetValue

(
    const int64 & InValue,
    EPropertyValueSetFlags::Type Flags
)

Public function

FPropertyAcc ...

 

SetValue

(
    const uint16 & InValue,
    EPropertyValueSetFlags::Type Flags
)

Public function

FPropertyAcc ...

 

SetValue

(
    const uint8 & InValue,
    EPropertyValueSetFlags::Type Flags
)

Public function

FPropertyAcc ...

 

SetValue

(
    const int32 & InValue,
    EPropertyValueSetFlags::Type Flags
)

Public function

FPropertyAcc ...

 

SetValue

(
    const int16 & InValue,
    EPropertyValueSetFlags::Type Flags
)

Public function

FPropertyAcc ...

 

SetValue

(
    const int8 & InValue,
    EPropertyValueSetFlags::Type Flags
)

Public function

FPropertyAcc ...

 

SetValue

(
    const bool& InValue,
    EPropertyValueSetFlags::Type Flags
)

Public function

FPropertyAcc ...

 

SetValue

(
    const double& InValue,
    EPropertyValueSetFlags::Type Flags
)

Public function

FPropertyAcc ...

 

SetValue

(
    const float& InValue,
    EPropertyValueSetFlags::Type Flags
)

Sets the typed value of a property.

Public function

FPropertyAcc ...

 

SetValue

(
    const UObject *const& InValue,
    EPropertyValueSetFlags::Type Flags
)

Public function

FPropertyAcc ...

 

SetValue

(
    const uint32 & InValue,
    EPropertyValueSetFlags::Type Flags
)

Public function

FPropertyAcc ...

 

SetValue

(
    const FAssetData & InValue,
    EPropertyValueSetFlags::Type Flags
)

Public function

FPropertyAcc ...

 

SetValueFromFormattedString

(
    const FString & InValue,
    EPropertyValueSetFlags::Type Flags
)

Sets the value formatted as a string.

The result of attempting to set the value

Typedefs

Name

Description

EnumerateConstRawDataFuncRef

Return true to continue enumeration

EnumerateRawDataFuncRef

Enumerate the raw data of this property. (Each pointer can be cast to the property data type)

References

Module

PropertyEditor

Header

Editor/PropertyEditor/Public/PropertyHandle.h