1. Epic GamesDeveloper
  3. SMultiLineEditableTextBox

SMultiLineEditableTextBox

Editable text box widget

API > API/Runtime > API/Runtime/Slate

Editable text box widget

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

Syntax

class SMultiLineEditableTextBox : public SBorder

Inheritance Hierarchy

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/SMultiLineEditableTextBox.h  
BorderImageHovered const FSlateBrush * Styling: border image to draw when hovered Widgets/Input/SMultiLineEditableTextBox.h  
BorderImageNormal const FSlateBrush * Styling: border image to draw when not hovered or focused Widgets/Input/SMultiLineEditableTextBox.h  
BorderImageReadOnly const FSlateBrush * Styling: border image to draw when read only Widgets/Input/SMultiLineEditableTextBox.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/SMultiLineEditableTextBox.h  

bool AnyTextSelected()

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

void ApplyToSelection ( const FRunInfo& InRunInfo,
const FTextBlockStyle& InStyle
)

 Apply the given style to the currently selected text (or insert a new run at the current cursor position if no text is selected) Widgets/Input/SMultiLineEditableTextBox.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/SMultiLineEditableTextBox.h  

void ClearSelection()

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

void Construct ( const FArguments& InArgs
)

 Construct this widget Widgets/Input/SMultiLineEditableTextBox.h  

void ForceScroll ( int32 UserIndex,
float ScrollAxisMagnitude
)

   Widgets/Input/SMultiLineEditableTextBox.h  

void GetCurrentTextLine ( FString& OutTextLine
) const

 Return the text line where the current cursor location is at. Widgets/Input/SMultiLineEditableTextBox.h  

FTextLocation GetCursorLocation()

 Get the interaction position of the cursor (where to insert, delete, etc, text from/to) Widgets/Input/SMultiLineEditableTextBox.h  

FText GetHintText()

 Returns the hint text string Widgets/Input/SMultiLineEditableTextBox.h  

TSharedPtr< const SScrollBar > GetHScrollBar()

 Get the horizontal scroll bar widget Widgets/Input/SMultiLineEditableTextBox.h  

FText GetPlainText()

 Returns the plain text string without richtext formatting Widgets/Input/SMultiLineEditableTextBox.h  

TSharedPtr< const IRun > GetRunUnderCursor()

 Get the run currently under the cursor, or null if there is no run currently under the cursor Widgets/Input/SMultiLineEditableTextBox.h  

FText GetSearchText()

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

TArray< TSharedRef< const IRun > > GetSelectedRuns()

 Get the runs currently that are current selected, some of which may be only partially selected Widgets/Input/SMultiLineEditableTextBox.h  

FText GetSelectedText()

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

FText GetText()

 Returns the text string Widgets/Input/SMultiLineEditableTextBox.h  

TSharedPtr< const SScrollBar > GetVScrollBar()

 Get the vertical scroll bar widget Widgets/Input/SMultiLineEditableTextBox.h  

void GoTo ( const ETextLocation NewLocation
)

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

void GoTo ( const FTextLocation& NewLocation
)

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

void InsertRunAtCursor ( TSharedRef< IRun > InRun
)

 Insert the given run at the current cursor position Widgets/Input/SMultiLineEditableTextBox.h  

void InsertTextAtCursor ( const FString& InString
)

   Widgets/Input/SMultiLineEditableTextBox.h  

void InsertTextAtCursor ( const FText& InText
)

 Insert the given text at the current cursor position, correctly taking into account new line characters Widgets/Input/SMultiLineEditableTextBox.h  

void Refresh()

 Refresh this text box immediately, rather than wait for the usual caching mechanisms to take affect on the text Tick Widgets/Input/SMultiLineEditableTextBox.h  

void ScrollTo ( const ETextLocation NewLocation
)

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

void ScrollTo ( const FTextLocation& NewLocation
)

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

void SelectAllText()

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

void SetAllowContextMenu ( const TAttribute< bool >& InAllowContextMenu
)

 See the AllowContextMenu attribute Widgets/Input/SMultiLineEditableTextBox.h  

void SetApplyLineHeightToBottomLine ( const TAttribute< bool >& InApplyLineHeightToBottomLine
)

 See ApplyLineHeightToBottomLine attribute Widgets/Input/SMultiLineEditableTextBox.h  

void SetAutoWrapText ( const TAttribute< bool >& InAutoWrapText
)

 See AutoWrapText attribute Widgets/Input/SMultiLineEditableTextBox.h  

void SetError ( const FString& InError
)

   Widgets/Input/SMultiLineEditableTextBox.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/SMultiLineEditableTextBox.h  

void SetHintText ( const TAttribute< FText >& InHintText
)

 Sets the text that appears when there is no text in the text box Widgets/Input/SMultiLineEditableTextBox.h  

void SetIsReadOnly ( const TAttribute< bool >& InIsReadOnly
)

 Set the ReadOnly attribute Widgets/Input/SMultiLineEditableTextBox.h  

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

 See Justification attribute Widgets/Input/SMultiLineEditableTextBox.h  

void SetLineHeightPercentage ( const TAttribute< float >& InLineHeightPercentage
)

 See LineHeightPercentage attribute Widgets/Input/SMultiLineEditableTextBox.h  

void SetMargin ( const TAttribute< FMargin >& InMargin
)

 See Margin attribute Widgets/Input/SMultiLineEditableTextBox.h  

void SetMaximumLength ( const TAttribute< int32 >& InMaximumLength
)

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

void SetOnKeyCharHandler ( FOnKeyChar InOnKeyCharHandler
)

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

void SetOnKeyDownHandler ( FOnKeyDown InOnKeyDownHandler
)

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

void SetOverflowPolicy ( TOptional< ETextOverflowPolicy > InOverflowPolicy
)

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

void SetReadOnlyForegroundColor ( const TAttribute< FSlateColor >& InReadOnlyForegroundColor
)

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

void SetSearchText ( const TAttribute< FText >& InSearchText
)

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

void SetSelectWordOnMouseDoubleClick ( const TAttribute< bool >& InSelectWordOnMouseDoubleClick
)

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

void SetStyle ( const FEditableTextBoxStyle* InStyle
)

 See attribute Style Widgets/Input/SMultiLineEditableTextBox.h  

void SetText ( const TAttribute< FText >& InNewText
)

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

void SetTextBoxBackgroundColor ( const TAttribute< FSlateColor >& InBackgroundColor
)

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

void SetTextBoxForegroundColor ( const TAttribute< FSlateColor >& InForegroundColor
)

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

void SetTextFlowDirection ( const TOptional< ETextFlowDirection >& InTextFlowDirection
)

 See TextFlowDirection attribute Widgets/Input/SMultiLineEditableTextBox.h  

void SetTextShapingMethod ( const TOptional< ETextShapingMethod >& InTextShapingMethod
)

 See TextShapingMethod attribute Widgets/Input/SMultiLineEditableTextBox.h  

void SetTextStyle ( const FTextBlockStyle* InTextStyle
)

 See attribute TextStyle Widgets/Input/SMultiLineEditableTextBox.h  

void SetVirtualKeyboardDismissAction ( TAttribute< EVirtualKeyboardDismissAction > InVirtualKeyboardDismissAction
)

 Set the VirtualKeyboardDismissAction attribute Widgets/Input/SMultiLineEditableTextBox.h  

void SetWrappingPolicy ( const TAttribute< ETextWrappingPolicy >& InWrappingPolicy
)

 Set WrappingPolicy attribute Widgets/Input/SMultiLineEditableTextBox.h  

void SetWrapTextAt ( const TAttribute< float >& InWrapTextAt
)

 See WrapTextAt attribute Widgets/Input/SMultiLineEditableTextBox.h  

Overridden from SWidget

Name Remarks Include Path Unreal Specifiers

virtual bool HasKeyboardFocus()

   Widgets/Input/SMultiLineEditableTextBox.h  

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

   Widgets/Input/SMultiLineEditableTextBox.h  

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

   Widgets/Input/SMultiLineEditableTextBox.h  

virtual bool SupportsKeyboardFocus()

   Widgets/Input/SMultiLineEditableTextBox.h  

Protected

Name Remarks Include Path Unreal Specifiers

void OnEditableTextChanged ( const FText& InText
)

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

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

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page