SNamingTokensEditableTextBox

An editable text box for displaying tokenized strings in either their unevaluated or resolved form.

API > API/Plugins > API/Plugins/NamingTokensUI

An editable text box for displaying tokenized strings in either their unevaluated or resolved form.

   
Name SNamingTokensEditableTextBox
Type class
Header File /Engine/Plugins/Developer/NamingTokens/Source/NamingTokensUI/Public/SNamingTokensEditableTextBox.h
Include Path #include "SNamingTokensEditableTextBox.h"

Syntax

class SNamingTokensEditableTextBox : public SCompoundWidget

Inheritance Hierarchy

Structs

Name Remarks
FArguments  
FCursorTokenData  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ArgumentStyle const FTextBlockStyle * The style to use for our argument formatting. SNamingTokensEditableTextBox.h  
bEnableSuggestionDropdown bool If suggestions are enabled by default. SNamingTokensEditableTextBox.h  
bFullyQualifyFilteredNamespaces bool If namespaces under FilterArgs.AdditionalNamespacesToInclude should autocomplete. SNamingTokensEditableTextBox.h  
bFullyQualifyGlobalTokenSuggestions bool If global tokens should have their namespace inserted too from suggestions. SNamingTokensEditableTextBox.h  
bModifyingSuggestionDropdown bool Suggesting box in the process of opening or closing. SNamingTokensEditableTextBox.h  
BoundText TAttribute< FText > The bound text which could return either tokenized or resolved text. SNamingTokensEditableTextBox.h  
Box TSharedPtr< SHorizontalBox >   SNamingTokensEditableTextBox.h  
bShowUnknownTokenWarning bool If the widget should warn when token(s) in the tokenized text are not recognized (unknown tokens). SNamingTokensEditableTextBox.h  
bShowUnsetTokenWarning bool If the widget should warn when token(s) in the tokenized text evaluate to an empty value (unset tokens). SNamingTokensEditableTextBox.h  
bSupportInlineEdit bool If the widget supports inline editing SNamingTokensEditableTextBox.h  
CanDisplayResolvedText TAttribute< bool > Attribute checking if we can display the resolved text. SNamingTokensEditableTextBox.h  
DisplayBorderImage TAttribute< bool > If the border image is used. SNamingTokensEditableTextBox.h  
DisplayErrorMessage TAttribute< bool > If error messages are displayed. SNamingTokensEditableTextBox.h  
DisplayTokenIcon TAttribute< bool > If we are displaying the token icon. SNamingTokensEditableTextBox.h  
DropdownAnchor TSharedPtr< SMenuAnchor > The dropdown filter UI anchor. SNamingTokensEditableTextBox.h  
EditableText TSharedPtr< SMultiLineEditableText > Editable text widget. SNamingTokensEditableTextBox.h  
ErrorReporting TSharedPtr< class IErrorReportingWidget >   SNamingTokensEditableTextBox.h  
EvaluationFrequency TAttribute< float > If set, specifies how frequently the tokenized text should be re-evaluated SNamingTokensEditableTextBox.h  
FilterWidget TSharedPtr< class SNamingTokenDataTreeViewWidget > The Dropdown widget. SNamingTokensEditableTextBox.h  
HScrollBar TSharedPtr< SScrollBar >   SNamingTokensEditableTextBox.h  
HScrollBarBox TSharedPtr< SBox >   SNamingTokensEditableTextBox.h  
LastCursorTokenData TSharedPtr< FCursorTokenData > Cursor token data of the last token data. SNamingTokensEditableTextBox.h  
Marshaller TSharedPtr< FNamingTokensStringSyntaxHighlighterMarshaller > The marshaller we use. SNamingTokensEditableTextBox.h  
NamespaceSuggestionPriority TArray< FString > A list prioritizing namespaces to show first in the dropdown. SNamingTokensEditableTextBox.h  
NamingTokenContexts TArray< TObjectPtr< UObject > > Contexts to provide to evaluation. SNamingTokensEditableTextBox.h  
NamingTokenFilterArgs FNamingTokenFilterArgs Filter args to use during evaluation. SNamingTokensEditableTextBox.h  
OnPreEvaluateTokens FSimpleDelegate Callback before we evaluate tokens. SNamingTokensEditableTextBox.h  
OnTokenizedTextChanged FOnTextChanged Callback when tokenized text is changed. SNamingTokensEditableTextBox.h  
OnTokenizedTextCommitted FOnTextCommitted Callback when tokenized text is committed. SNamingTokensEditableTextBox.h  
OnTokenizedTextEvaluated FOnTokenizedTextEvaluated Callback after the tokenized text has been evaluated SNamingTokensEditableTextBox.h  
OnValidateResolvedText FOnVerifyTextChanged Callback to verify resolved text when changed. Will return an error message to denote problems. SNamingTokensEditableTextBox.h  
OnValidateTokenizedText FOnVerifyTextChanged Callback to verify tokenized text when changed. Will return an error message to denote problems. SNamingTokensEditableTextBox.h  
ResolvedText TAttribute< FText >   SNamingTokensEditableTextBox.h  
ShouldEvaluateTokens TAttribute< bool > If true, this widget will evaluate the tokenized text to produce the resolved text SNamingTokensEditableTextBox.h  
TextBoxPaddingOverride TAttribute< FMargin > Textbox padding (overrides style) SNamingTokensEditableTextBox.h  
TextBoxStyle const FEditableTextBoxStyle * Style shared between Editable and NonEditable text widgets. SNamingTokensEditableTextBox.h  
TokenizedText TAttribute< FText >   SNamingTokensEditableTextBox.h  
UnknownTokenKeys TArray< FString > Token keys that were unknown during the last evaluation. SNamingTokensEditableTextBox.h  
UnsetTokenKeys TArray< FString > Token keys that evaluated to empty values during the last evaluation. SNamingTokensEditableTextBox.h  
ValidArguments TAttribute< TConstArrayView< FString > >   SNamingTokensEditableTextBox.h  
VScrollBar TSharedPtr< SScrollBar >   SNamingTokensEditableTextBox.h  
VScrollBarBox TSharedPtr< SBox >   SNamingTokensEditableTextBox.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Construct ( const FArguments& InArgs
)

 Constructs this widget with InArgs SNamingTokensEditableTextBox.h  

void EnterEditingMode()

 If inline editing is supported, gives focus to the editable text, and sets the visibility and display options to resemble an editable textbox SNamingTokensEditableTextBox.h  

void EvaluateNamingTokens()

 Evaluate the token text and update the resolved text. SNamingTokensEditableTextBox.h  

void ExitEditingMode()

 If inline editing is supported, sets the visibility and display options to resemble a read-only textblock SNamingTokensEditableTextBox.h  

const TAttribute< FText > & GetBoundText()

 Return the bound text attribute. SNamingTokensEditableTextBox.h  

TSharedPtr< SMultiLineEditableText > GetEditableText()

 Retrieve the editable text widget. SNamingTokensEditableTextBox.h  

const FText & GetResolvedText()

 Retrieve the resolved text. SNamingTokensEditableTextBox.h  

const FText & GetTokenizedText()

 Retrieve the raw tokenized text. SNamingTokensEditableTextBox.h  

void SetArgumentStyle ( const FTextBlockStyle* InArgumentStyle
)

 Sets the argument style to use. SNamingTokensEditableTextBox.h  

void SetContexts ( const TArray< UObject* >& InContexts
)

 Provide contexts to naming token evaluation. SNamingTokensEditableTextBox.h  

void SetEnableSuggestionDropdown ( bool bInEnableSuggestionDropdown
)

 If the suggestion box should be enabled. SNamingTokensEditableTextBox.h  

void SetFilterArgs ( const FNamingTokenFilterArgs& InFilterArgs
)

 Provide filter args to use during evaluation. SNamingTokensEditableTextBox.h  

void SetFullyQualifyFilteredNamespaces ( bool bNewValue
)

 Set whether namespaces under FilterArgs.AdditionalNamespacesToInclude should autocomplete. SNamingTokensEditableTextBox.h  

void SetNamespaceSuggestionPriority ( const TArray< FString >& InNamespaces
)

 Set the namespace priority to use when sorting dropdown suggestions. SNamingTokensEditableTextBox.h  

void SetNormalStyle ( const FEditableTextBoxStyle* InNormalStyle
)

 Sets the style to use. SNamingTokensEditableTextBox.h  

void SetShowUnknownTokenWarning ( bool bNewValue
)

 Set whether the widget should warn when token(s) in the tokenized text are not recognized. SNamingTokensEditableTextBox.h  

void SetShowUnsetTokenWarning ( bool bNewValue
)

 Set whether the widget should warn when token(s) in the tokenized text evaluate to an empty value. SNamingTokensEditableTextBox.h  

void SetSupportInlineEdit ( bool bInSupportInlineEdit
)

 If the textbox should look and behave like an inline editable textbox SNamingTokensEditableTextBox.h  

void SetTokenizedText ( const FText& InText
)

 Set the current tokenized text. SNamingTokensEditableTextBox.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page