1. Epic GamesDeveloper
  3. SEditableTextBox

SEditableTextBox

Editable text box widget

API > API/Runtime > API/Runtime/Slate

Editable text box widget

   
Name SEditableTextBox
Type class
Header File /Engine/Source/Runtime/Slate/Public/Widgets/Input/SEditableTextBox.h
Include Path #include "Widgets/Input/SEditableTextBox.h"

Syntax

class SEditableTextBox : public SBorder

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

SEditableTextBox()

   Widgets/Input/SEditableTextBox.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~SEditableTextBox()

   Widgets/Input/SEditableTextBox.h  

Structs

Name Remarks
FArguments  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
BorderImageFocused const FSlateBrush * Styling: border image to draw when focused Widgets/Input/SEditableTextBox.h  
BorderImageHovered const FSlateBrush * Styling: border image to draw when hovered Widgets/Input/SEditableTextBox.h  
BorderImageNormal const FSlateBrush * Styling: border image to draw when not hovered or focused Widgets/Input/SEditableTextBox.h  
BorderImageReadOnly const FSlateBrush * Styling: border image to draw when read only Widgets/Input/SEditableTextBox.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AdvanceSearch ( const bool InReverse
)

 Advance the current search to the next match (does nothing if not currently searching) Widgets/Input/SEditableTextBox.h  

bool AnyTextSelected()

 Query to see if any text is selected within the document Widgets/Input/SEditableTextBox.h  

void BeginSearch ( const FText& InSearchText,
const ESearchCase::Type InSearchCase,
const bool InReverse
)

 Begin a new text search (this is called automatically when the bound search text changes) Widgets/Input/SEditableTextBox.h  

void ClearSelection()

 Clear the active text selection Widgets/Input/SEditableTextBox.h  

void Construct ( const FArguments& InArgs
)

 Construct this widget Widgets/Input/SEditableTextBox.h  

void EnableTextInputMethodContext()

 Register and activate the IME context for the text layout of this textbox Widgets/Input/SEditableTextBox.h  

FText GetHintText()

 Returns the Hint text string Widgets/Input/SEditableTextBox.h  

FText GetSearchText()

 Get the text that is currently being searched for (if any) Widgets/Input/SEditableTextBox.h  

FText GetSelectedText()

 Get the currently selected text Widgets/Input/SEditableTextBox.h  

FText GetText()

 Returns the text string Widgets/Input/SEditableTextBox.h  

void GoTo ( const ETextLocation NewLocation
)

 Move the cursor to the specified location Widgets/Input/SEditableTextBox.h  

void GoTo ( const FTextLocation& NewLocation
)

 Move the cursor to the given location in the document Widgets/Input/SEditableTextBox.h  

bool HasError()

   Widgets/Input/SEditableTextBox.h  

bool IsPassword()

   Widgets/Input/SEditableTextBox.h  

bool IsReadOnly()

   Widgets/Input/SEditableTextBox.h  

void ScrollTo ( const ETextLocation NewLocation
)

 Scroll to the given location in the document (without moving the cursor) Widgets/Input/SEditableTextBox.h  

void ScrollTo ( const FTextLocation& NewLocation
)

 Scroll to the given location in the document (without moving the cursor) Widgets/Input/SEditableTextBox.h  

void SelectAllText()

 Select all the text in the document Widgets/Input/SEditableTextBox.h  

void SetAllowContextMenu ( TAttribute< bool > InAllowContextMenu
)

 See the AllowContextMenu attribute Widgets/Input/SEditableTextBox.h  

void SetClearKeyboardFocusOnCommit ( const TAttribute< bool >& InClearKeyboardFocusOnCommit
)

 Sets whether to clear keyboard focus when pressing enter to commit changes Widgets/Input/SEditableTextBox.h  

void SetError ( const FString& InError
)

   Widgets/Input/SEditableTextBox.h  

void SetError ( const FText& InError
)

 If InError is a non-empty string the TextBox will the ErrorReporting provided during construction If no error reporting was provided, the TextBox will create a default error reporter. Widgets/Input/SEditableTextBox.h  

void SetFocusedForegroundColor ( const TAttribute< FSlateColor >& InFocusedForegroundColor
)

 Sets the text color and opacity when this box has keyboard focus(overrides Style) Widgets/Input/SEditableTextBox.h  

void SetFont ( const TAttribute< FSlateFontInfo >& InFont
)

 Sets the font used to draw the text Widgets/Input/SEditableTextBox.h  

void SetHintText ( const TAttribute< FText >& InHintText
)

 See the HintText attribute Widgets/Input/SEditableTextBox.h  

void SetIsCaretMovedWhenGainFocus ( const TAttribute< bool >& InIsCaretMovedWhenGainFocus
)

 Workaround as we loose focus when the auto completion closes. Widgets/Input/SEditableTextBox.h  

void SetIsPassword ( TAttribute< bool > InIsPassword
)

 See the IsPassword attribute Widgets/Input/SEditableTextBox.h  

void SetIsReadOnly ( TAttribute< bool > InIsReadOnly
)

 See the IsReadOnly attribute Widgets/Input/SEditableTextBox.h  

void SetJustification ( const TAttribute< ETextJustify::Type >& InJustification
)

 See Justification attribute Widgets/Input/SEditableTextBox.h  

void SetMaximumLength ( const TAttribute< int32 >& InMaximumLength
)

 Sets the maximum text length that will be accepted by the widget Widgets/Input/SEditableTextBox.h  

void SetMinimumDesiredWidth ( const TAttribute< float >& InMinimumDesiredWidth
)

 Sets the minimum width that a text box should be. Widgets/Input/SEditableTextBox.h  

void SetOnKeyCharHandler ( FOnKeyChar InOnKeyCharHandler
)

 Sets the OnKeyCharHandler to provide first chance handling of the SEditableText's OnKeyChar event Widgets/Input/SEditableTextBox.h  

void SetOnKeyDownHandler ( FOnKeyDown InOnKeyDownHandler
)

 Sets the OnKeyDownHandler to provide first chance handling of the SEditableText's OnKeyDown event Widgets/Input/SEditableTextBox.h  

void SetOverflowPolicy ( TOptional< ETextOverflowPolicy > InOverflowPolicy
)

 Sets the overflow policy for this text block Widgets/Input/SEditableTextBox.h  

void SetReadOnlyForegroundColor ( const TAttribute< FSlateColor >& InReadOnlyForegroundColor
)

 Sets the text color and opacity when read-only (overrides Style) Widgets/Input/SEditableTextBox.h  

void SetRevertTextOnEscape ( const TAttribute< bool >& InRevertTextOnEscape
)

 Sets whether to allow the user to back out of changes when they press the escape key Widgets/Input/SEditableTextBox.h  

void SetSearchText ( const TAttribute< FText >& InSearchText
)

 Set the text that is currently being searched for (if any) Widgets/Input/SEditableTextBox.h  

void SetSelectAllTextOnCommit ( const TAttribute< bool >& InSelectAllTextOnCommit
)

 Sets whether to select all text when pressing enter to commit changes Widgets/Input/SEditableTextBox.h  

void SetSelectAllTextWhenFocused ( const TAttribute< bool >& InSelectAllTextWhenFocused
)

 Sets whether to select all text when the user clicks to give focus on the widget Widgets/Input/SEditableTextBox.h  

void SetSelectWordOnMouseDoubleClick ( const TAttribute< bool >& InSelectWordOnMouseDoubleClick
)

 Sets whether to select select word on mouse double click Widgets/Input/SEditableTextBox.h  

void SetStyle ( const FEditableTextBoxStyle* InStyle
)

 See attribute Style Widgets/Input/SEditableTextBox.h  

void SetText ( const TAttribute< FText >& InNewText
)

 Sets the text string currently being edited Widgets/Input/SEditableTextBox.h  

void SetTextBlockStyle ( const FTextBlockStyle* InTextStyle
)

 Sets the text block style currently used Widgets/Input/SEditableTextBox.h  

void SetTextBoxBackgroundColor ( const TAttribute< FSlateColor >& InBackgroundColor
)

 Sets the color of the background/border around the editable text (overrides Style) Widgets/Input/SEditableTextBox.h  

void SetTextBoxForegroundColor ( const TAttribute< FSlateColor >& InForegroundColor
)

 Sets the text color and opacity (overrides Style) Widgets/Input/SEditableTextBox.h  

void SetTextFlowDirection ( const TOptional< ETextFlowDirection >& InTextFlowDirection
)

 See TextFlowDirection attribute Widgets/Input/SEditableTextBox.h  

void SetTextShapingMethod ( const TOptional< ETextShapingMethod >& InTextShapingMethod
)

 See TextShapingMethod attribute Widgets/Input/SEditableTextBox.h  

void SetVirtualKeyboardDismissAction ( TAttribute< EVirtualKeyboardDismissAction > InVirtualKeyboardDismissAction
)

 Set the VirtualKeyboardDismissAction attribute Widgets/Input/SEditableTextBox.h  

Overridden from SWidget

Name Remarks Include Path Unreal Specifiers

virtual bool HasKeyboardFocus()

   Widgets/Input/SEditableTextBox.h  

virtual FReply OnFocusReceived ( const FGeometry& MyGeometry,
const FFocusEvent& InFocusEvent
)

   Widgets/Input/SEditableTextBox.h  

virtual FReply OnKeyDown ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

   Widgets/Input/SEditableTextBox.h  

virtual bool SupportsKeyboardFocus()

   Widgets/Input/SEditableTextBox.h  

Protected

Name Remarks Include Path Unreal Specifiers

void OnEditableTextChanged ( const FText& InText
)

 Callback for the editable text's OnTextChanged event Widgets/Input/SEditableTextBox.h  

void OnEditableTextCommitted ( const FText& InText,
ETextCommit::Type InCommitType
)

 Callback when the editable text is committed. Widgets/Input/SEditableTextBox.h  

Overridden from SWidget

Name Remarks Include Path Unreal Specifiers

virtual TSharedRef< FSlateAccessibleWidget > CreateAccessibleWidget()

   Widgets/Input/SEditableTextBox.h  

virtual TOptional< FText > GetDefaultAccessibleText ( EAccessibleType AccessibleType
) const

   Widgets/Input/SEditableTextBox.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page