IEditableTextProperty

Interface to allow [STextPropertyEditableTextBox](API\Editor\EditorWidgets\STextPropertyEditableTextBox) to be used to edit both properties and Blueprint pins

Windows
MacOS
Linux

References

Module

EditorWidgets

Header

/Engine/Source/Editor/EditorWidgets/Public/STextPropertyEditableTextBox.h

Include

#include "STextPropertyEditableTextBox.h"

Syntax

class IEditableTextProperty

Remarks

Interface to allow STextPropertyEditableTextBox to be used to edit both properties and Blueprint pins

Destructors

Name Description

Public function Virtual

~IEditableTextProperty()

Functions

Name Description

Public function Const

int32

 

GetNumTexts()

Get the number of FText instances being edited by this property

Public function Const

void

 

GetStableTextId

(
    const int32 InIndex,
    const ETextPropertyEditAction InEdi...,
    const FString& InTextSource,
    const FString& InProposedNamespace,
    const FString& InProposedKey,
    FString& OutStableNamespace,
    FString& OutStableKey
)

Get the stable text ID for the given index (check against GetNumTexts)

Public function Const

FText

 

GetText

(
    const int32 InIndex
)

Get the text at the given index (check against GetNumTexts)

Public function Const

FText

 

GetToolTipText()

Get the tooltip text associated with the property being edited

Public function Const

bool

 

IsDefaultValue()

Is the value associated with the properties the default value?

Public function Const

bool

 

IsMultiLineText()

Are the text properties being edited marked as multi-line?

Public function Const

bool

 

IsPassword()

Are the text properties being edited marked as password fields?

Public function Const

bool

 

IsReadOnly()

Are the text properties being edited read-only?

Public function Const

bool

 

IsValidText

(
    const FText& InText,
    FText& OutErrorMsg
)

Check to see if the given text is valid to use

Public function

void

 

RequestRefresh()

Request a refresh of the property UI (eg, due to a size change)

Public function

void

 

SetText

(
    const int32 InIndex,
    const FText& InText
)

Set the text at the given index (check against GetNumTexts)

Protected function Static

void

 

StaticStableTextId

(
    UObject* InObject,
    const ETextPropertyEditAction InEdi...,
    const FString& InTextSource,
    const FString& InProposedNamespace,
    const FString& InProposedKey,
    FString& OutStableNamespace,
    FString& OutStableKey
)

Get the localization ID we should use for the given object, and the given text instance

Protected function Static

void

 

StaticStableTextId

(
    UPackage* InPackage,
    const ETextPropertyEditAction InEdi...,
    const FString& InTextSource,
    const FString& InProposedNamespace,
    const FString& InProposedKey,
    FString& OutStableNamespace,
    FString& OutStableKey
)

Get the localization ID we should use for the given package, and the given text instance

Enums

Name

Description

Public enum

ETextPropertyEditAction

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