Navigation
API > API/Plugins > API/Plugins/NamingTokensUI
Editable text for displaying tokenized strings in either their unevaluated or resolved form.
| Name | UNamingTokensEditableText |
| Type | class |
| Header File | /Engine/Plugins/Developer/NamingTokens/Source/NamingTokensUI/Public/NamingTokensEditableText.h |
| Include Path | #include "NamingTokensEditableText.h" |
Syntax
UCLASS (MinimalAPI, Config=NamingTokens, defaultconfig, ClassGroup=UI,
Meta=(Category="NamingTokens UI", DisplayName="Naming Tokens Editable Text Box", prioritizeCategories="Content"))
class UNamingTokensEditableText : public UMultiLineEditableText
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UVisual → UWidget → UTextLayoutWidget → UMultiLineEditableText → UNamingTokensEditableText
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UNamingTokensEditableText() |
NamingTokensEditableText.h |
Classes
| Name | Remarks |
|---|---|
| FOnPreEvaluateNamingTokens |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnPreEvaluateNamingTokens | FOnPreEvaluateNamingTokens | Called before naming token evaluation. | NamingTokensEditableText.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Contexts | TArray< TObjectPtr< UObject > > | Contexts to include during our evaluation. | NamingTokensEditableText.h |
|
| EditableTextBoxStyle | TSharedPtr< FEditableTextBoxStyle > | The editable text box style we use. | NamingTokensEditableText.h | |
| MyNamingTokensEditableText | TSharedPtr< SNamingTokensEditableTextBox > | The editable text slate widget. | NamingTokensEditableText.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool GetCanDisplayResolvedText() |
Get if we can display resolved text. | NamingTokensEditableText.h |
|
bool GetDisplayBorderImage() |
If the border image should be displayed. | NamingTokensEditableText.h |
|
bool GetDisplayErrorMessage() |
If the error icon should be displayed. | NamingTokensEditableText.h |
|
bool GetDisplayTokenIcon() |
If the token icon should be displayed. | NamingTokensEditableText.h |
|
const FText & GetResolvedText() |
Retrieve the evaluated text. | NamingTokensEditableText.h |
|
const FText & GetTokenizedText() |
Retrieve the raw token text. | NamingTokensEditableText.h |
|
void SetBackgroundColor
(
const FSlateColor& InColor |
Set the background color. | NamingTokensEditableText.h |
|
void SetCanDisplayResolvedText
(
bool bValue |
Set whether we can display resolved text or not. | NamingTokensEditableText.h |
|
| Set the contexts to use during evaluation. | NamingTokensEditableText.h |
|
|
void SetDisplayBorderImage
(
bool bValue |
Set the background color of the border image. | NamingTokensEditableText.h |
|
void SetDisplayErrorMessage
(
bool bValue |
Set whether error messages are displayed for token formatting. | NamingTokensEditableText.h |
|
void SetDisplayTokenIcon
(
bool bValue |
Set whether the token icon is displayed. | NamingTokensEditableText.h |
|
void SetWidgetArgumentStyle
(
const FTextBlockStyle& InWidgetStyle |
Sets the argument style to use for the widget. | NamingTokensEditableText.h |
|
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
NamingTokensEditableText.h |
Protected
Overridden from UWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TSharedRef< SWidget > RebuildWidget() |
NamingTokensEditableText.h | ||
virtual void SynchronizeProperties() |
NamingTokensEditableText.h |
Overridden from UVisual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ReleaseSlateResources
(
bool bReleaseChildren |
NamingTokensEditableText.h |