1. Epic GamesDeveloper
  3. SMultiLineEditableText

SMultiLineEditableText

An editable text widget that supports multiple lines and soft word-wrapping.

API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Widgets > API/Runtime/Slate/Widgets/Text

Inheritance Hierarchy

References

   
Module Slate
Header /Engine/Source/Runtime/Slate/Public/Widgets/Text/SMultiLineEditableText.h
Include #include "Widgets/Text/SMultiLineEditableText.h"

Syntax

class SMultiLineEditableText :  
    public SWidget,  
    public ISlateEditableTextWidget

Remarks

An editable text widget that supports multiple lines and soft word-wrapping.

Variables

  Type Name Description
Protected variable TWeakPtr< FActiveTimerHandle > ActiveTickTimer The timer that is actively driving this widget to Tick() even when Slate is idle
Protected variable float AmountScrolledWhileRightMouseDown How much we scrolled while RMB was being held
Protected variable TAttribute< bool > bAllowContextMenu Whether the context menu can be opened
Protected variable TAttribute< bool > bAllowMultiLine Whether to allow multi-line text
Protected variable TAttribute< bool > bClearKeyboardFocusOnCommit True if we want the text control to lose focus on an text commit/revert events
Protected variable TAttribute< bool > bClearTextSelectionOnFocusLoss Whether to clear text selection when focus is lost
Protected variable TAttribute< bool > bIsReadOnly Sets whether this text box can actually be modified interactively by the user
Protected variable bool bIsSoftwareCursor Whether a software cursor is currently active
Protected variable TAttribute< bool > bRevertTextOnEscape True if any changes should be reverted if we receive an escape key
Protected variable TAttribute< bool > bSelectAllTextWhenFocused Whether to select all text when the user clicks to give focus on the widget
Protected variable TAttribute< bool > bSelectWordOnMouseDoubleClick Whether to select work on mouse double click
Protected variable TUniquePtr< FSlateEditableTextLayout > EditableTextLayout The text layout that deals with the editable text
Protected variable TSharedPtr< SScrollBar > HScrollBar The horizontal scroll bar widget
Protected variable TSharedPtr< FExtender > MenuExtender Menu extender for right-click context menu
Protected variable EModifierKey::Type ModiferKeyForNewLine The optional modifier key necessary to create a newline when typing into the editor.
Protected variable FOnContextMenuOpening OnContextMenuOpening Delegate to call before a context menu is opened
Protected variable FOnCursorMoved OnCursorMovedCallback Called when the cursor is moved within the text area
Protected variable FOnUserScrolled OnHScrollBarUserScrolled Called whenever the horizontal scrollbar is moved by the user
Protected variable FOnIsTypedCharValid OnIsTypedCharValid Called when a character is typed and we want to know if the text field supports typing this character.
Protected variable FOnKeyChar OnKeyCharHandler Callback delegate to have first chance handling of the OnKeyChar event
Protected variable FOnKeyDown OnKeyDownHandler Callback delegate to have first chance handling of the OnKeyDown event
Protected variable FOnTextChanged OnTextChangedCallback Called whenever the text is changed programmatically or interactively by the user
Protected variable FOnTextCommitted OnTextCommittedCallback Called whenever the text is committed.
Protected variable FOnUserScrolled OnVScrollBarUserScrolled Called whenever the vertical scrollbar is moved by the user
Protected variable FVector2f SoftwareCursorPosition The current position of the software cursor
Protected variable TAttribute< EVirtualKeyboardDismissAction > VirtualKeyboardDismissAction The message action to take when the virtual keyboard is dismissed by the user
Protected variable FVirtualKeyboardOptions VirtualKeyboardOptions Options to use for the virtual keyboard summoned by this widget
Protected variable TAttribute< EVirtualKeyboardTrigger > VirtualKeyboardTrigger The type of event that will trigger the display of the virtual keyboard
Protected variable TSharedPtr< SScrollBar > VScrollBar The vertical scroll bar widget

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

AdvanceSearch ( const bool InReverse
)

 Advance the current search to the next match (does nothing if not currently searching)
Public function Const bool Query to see if any text is selected within the document
Public function 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)
Protected function void Called to begin an undoable editable text transaction, marked as protected for use with FScopedEditableTextTransaction only
Public function 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)
Public function void Clear the active text selection
Public function void

Construct ( const FArguments& InArgs
)

  
Public function void Delete any currently selected text
Protected function void Called to end an undoable editable text transaction, marked as protected for use with FScopedEditableTextTransaction only
Public function void

ForceScroll ( int32 UserIndex,
float ScrollAxisMagnitude
)

 Force a single scroll operation.
Public function Const TCHAR

GetCharacterAt ( const FTextLocation& Location
)

 Get the character at Location
Public function Const void

GetCurrentTextLine ( FString& OutTextLine
)

 Fill OutTextLine with the text line where the current cursor location is at
Public function Const FTextLocation Get the interaction position of the cursor (where to insert, delete, etc, text from/to)
Public function Const FSlateFontInfo

GetFont ()

  
Public function Const FText Get the text that appears when there is no text in the text box
Public function Const TSharedPtr< const SScrollBar > Get the horizontal scroll bar widget
Public function Const int32 Get the total number of search results (0 if none)
Public function Const FText Returns the plain text string without richtext formatting
Public function Const TSharedPtr< const IRun > Get the run currently under the cursor, or null if there is no run currently under the cursor
Public function Const int32 Get the index of the search result (0 if none)
Public function Const FText Get the text that is currently being searched for (if any)
Public function Const TArray< TSharedRef< const IRun > > Get the runs currently that are current selected, some of which may be only partially selected
Public function Const FText Get the currently selected text
Public function Const FTextSelection Get the current selection
Public function Const FText

GetText ()

 Returns the text string
Public function Const void

GetTextLine ( const int32 InLineIndex,
FString& OutTextLine
)

 Fill OutTextLine with the text line at the specified index
Public function int32 Get the number of Text Lines
Public function Const TSharedPtr< const SScrollBar > Get the vertical scroll bar widget
Public function void

GoTo ( const ETextLocation NewLocation
)

 Move the cursor specified location
Public function void

GoTo ( const FTextLocation& NewLocation
)

 Move the cursor to the given location in the document (will also scroll to this point)
Public function void Insert the given run at the current cursor position
Public function void

InsertTextAtCursor ( const FString& InString
)

 Insert the given text at the current cursor position, correctly taking into account new line characters
Public function void

InsertTextAtCursor ( const FText& InText
)

 Insert the given text at the current cursor position, correctly taking into account new line characters
Protected function Const bool Return whether a RMB+Drag scroll operation is taking place
Protected function void

OnHScrollBarMoved ( const float InScrollOffsetFraction
)

  
Protected function void

OnVScrollBarMoved ( const float InScrollOffsetFraction
)

  
Public function void

Refresh ()

 Refresh this editable text immediately, rather than wait for the usual caching mechanisms to take affect on the text Tick
Public function void

ScrollTo ( const FTextLocation& NewLocation
)

 Scroll to the given location in the document (without moving the cursor)
Public function void

ScrollTo ( const ETextLocation NewLocation
)

 Scroll to the given location in the document (without moving the cursor)
Public function void Select all the text in the document
Public function void

SelectText ( const FTextLocation& InSelectionStart,
const FTextLocation& InCursorLocation
)

 Select a block of text
Public function void

SetAllowContextMenu ( const TAttribute< bool >& InAllowContextMenu
)

 See the AllowContextMenu attribute
Public function void

SetAutoWrapText ( const TAttribute< bool >& InAutoWrapText
)

 See AutoWrapText attribute
Public function void

SetClearKeyboardFocusOnCommit ( const TAttribute< bool >& InClearKeyboardFocusOnCommit
)

 Sets whether to clear keyboard focus when pressing enter to commit changes
Public function void

SetClearTextSelectionOnFocusLoss ( const TAttribute< bool >& InClearTextSelectionOnFocusLoss
)

 Sets whether to clear text selection when focus is lost
Public function void

SetFont ( const TAttribute< FSlateFontInfo >& InNewFont
)

 See attribute Font
Public function void

SetHintText ( const TAttribute< FText >& InHintText
)

 Sets the text that appears when there is no text in the text box
Public function void

SetIsReadOnly ( const TAttribute< bool >& InIsReadOnly
)

 Sets the ReadOnly attribute
Public function void

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

 See Justification attribute
Public function void

SetLineHeightPercentage ( const TAttribute< float >& InLineHeightPercentage
)

 See LineHeightPercentage attribute
Public function void

SetMargin ( const TAttribute< FMargin >& InMargin
)

 See Margin attribute
Public function void

SetOnKeyCharHandler ( FOnKeyChar InOnKeyCharHandler
)

 Sets the OnKeyCharHandler to provide first chance handling of the OnKeyChar event
Public function void

SetOnKeyDownHandler ( FOnKeyDown InOnKeyDownHandler
)

 Sets the OnKeyDownHandler to provide first chance handling of the OnKeyDown event
Public function void

SetOverflowPolicy ( TOptional< ETextOverflowPolicy > InOverflowPolicy
)

 Sets the overflow policy for this text block
Public function void

SetRevertTextOnEscape ( const TAttribute< bool >& InRevertTextOnEscape
)

 Sets whether to allow the user to back out of changes when they press the escape key
Public function void

SetSearchText ( const TAttribute< FText >& InSearchText
)

 Set the text that is currently being searched for (if any)
Public function void

SetSelectAllTextWhenFocused ( const TAttribute< bool >& InSelectAllTextWhenFocused
)

 Sets whether to select all text when the user clicks to give focus on the widget
Public function void

SetSelectWordOnMouseDoubleClick ( const TAttribute< bool >& InSelectWordOnMouseDoubleClick
)

 Sets whether to select word on the mouse double click
Public function void

SetText ( const TAttribute< FText >& InText
)

 Sets the text for this text block
Public function void

SetTextFlowDirection ( const TOptional< ETextFlowDirection >& InTextFlowDirection
)

 See TextFlowDirection attribute
Public function void

SetTextShapingMethod ( const TOptional< ETextShapingMethod >& InTextShapingMethod
)

 See TextShapingMethod attribute
Public function void

SetTextStyle ( const FTextBlockStyle* InTextStyle
)

 See attribute TextStyle
Public function void

SetVirtualKeyboardDismissAction ( TAttribute< EVirtualKeyboardDismissAction > InVirtualKeyboardDismissAction
)

 Set the VirtualKeyboardDismissAction attribute
Public function void

SetWrappingPolicy ( const TAttribute< ETextWrappingPolicy >& InWrappingPolicy
)

 Set WrappingPolicy attribute
Public function void

SetWrapTextAt ( const TAttribute< float >& InWrapTextAt
)

 See WrapTextAt attribute

Overridden from SWidget

  Type Name Description
Protected function Virtual void

CacheDesiredSize ( float InLayoutScaleMultiplier
)

 The system calls this method.
Protected function Virtual Const FVector2D

ComputeDesiredSize ( float LayoutScaleMultiplier
)

 Compute the ideal size necessary to display this widget.
Protected function Virtual Const bool Recomputes the volatility of the widget.
Protected function Virtual FChildren * Returns the useful children (if any) of this widget.
Protected function Virtual Const bool  
Protected function Virtual Const void

OnArrangeChildren ( const FGeometry& AllottedGeometry,
FArrangedChildren& ArrangedChildren
)

 Compute the Geometry of all the children and add populate the ArrangedChildren list with their values.
Protected function Virtual Const FCursorReply

OnCursorQuery ( const FGeometry& MyGeometry,
const FPointerEvent& CursorEvent
)

 The system asks each widget under the mouse to provide a cursor. This event is bubbled.
Protected function Virtual void

OnFocusLost ( const FFocusEvent& InFocusEvent
)

 Called when this widget loses focus. This event does not bubble.
Protected function Virtual FReply

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

 KEY INPUT Called when focus is given to this widget. This event does not bubble.
Protected function Virtual FReply

OnKeyChar ( const FGeometry& MyGeometry,
const FCharacterEvent& InCharacterEvent
)

 Called after a character is entered while this widget has keyboard focus
Protected function Virtual FReply

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

 Called after a key is pressed when this widget has focus (this event bubbles if not handled)
Protected function Virtual FReply

OnKeyUp ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

 Called after a key is released when this widget has focus
Protected function Virtual FReply

OnMouseButtonDoubleClick ( const FGeometry& InMyGeometry,
const FPointerEvent& InMouseEvent
)

 Called when a mouse button is double clicked. Override this in derived classes.
Protected function Virtual FReply

OnMouseButtonDown ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 MOUSE INPUT The system calls this method to notify the widget that a mouse button was pressed within it.
Protected function Virtual FReply

OnMouseButtonUp ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 The system calls this method to notify the widget that a mouse button was release within it.
Protected function Virtual FReply

OnMouseMove ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 The system calls this method to notify the widget that a mouse moved within it.
Protected function Virtual FReply

OnMouseWheel ( const FGeometry& MyGeometry,
const FPointerEvent& MouseEvent
)

 Called when the mouse wheel is spun. This event is bubbled.
Protected function Virtual Const int32

OnPaint ( const FPaintArgs& Args,
const FGeometry& AllottedGeometry,
const FSlateRect& MyCullingRect,
FSlateWindowElementList& OutDrawElements,
int32 LayerId,
const FWidgetStyle& InWidgetStyle,
bool bParentEnabled
)

 The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children.
Protected function Virtual Const bool Checks to see if this widget supports keyboard focus. Override this in derived classes.
Protected function Virtual void

Tick ( const FGeometry& AllottedGeometry,
const double InCurrentTime,
const float InDeltaTime
)

 Ticks this widget with Geometry.

Overridden from ISlateEditableTextWidget

  Type Name Description
Protected function Virtual Const TSharedPtr< SWidget > Build the context menu content to use for this widget (if any)
Protected function Virtual Const bool Are we currently able to insert a carriage return? (some widgets have modifier keys that need to be pressed)
Protected function Virtual Const bool

CanTypeCharacter ( const TCHAR InChar
)

 Are we able to insert the given character into our text?
Protected function Virtual void Ensure that we will get a Tick() soon (either due to having active focus, or something having changed progmatically and requiring an update) Does nothing if the active tick timer is already enabled
Protected function Virtual TSharedRef< SWidget > Get the Slate widget this interface is representing (may not be called during destruction)
Protected function Virtual TSharedPtr< SWidget > Get the Slate widget this interface is representing (may be null during destruction)
Protected function Virtual Const EVirtualKeyboardDismissAction Get the message action to take when the virtual keyboard is dismissed by the user
Protected function Virtual Const FVirtualKeyboardOptions Get the options for the virtual keyboard used for this widget
Protected function Virtual Const EVirtualKeyboardTrigger Get the type of event that will trigger the display of the virtual keyboard
Protected function Virtual Const EKeyboardType Get the type of virtual keyboard to use for this widget
Public function Virtual Const bool Is the text edit multi-line aware?
Public function Virtual Const bool Is the text displaying a password and should be obscured?
Public function Virtual Const bool Is the text currently read-only?
Protected function Virtual void

OnCursorMoved ( const FTextLocation& InLocation
)

 Called when the cursor is moved within the text area
Protected function Virtual void

OnTextChanged ( const FText& InText
)

 Called when the text has been changed by an edit operation
Protected function Virtual void

OnTextCommitted ( const FText& InText,
const ETextCommit::Type InTextAction
)

 Called when the text control has committed its current edit changes
Protected function Virtual Const bool Should we clear the keyboard focus when the user commits text to this widget?
Protected function Virtual Const bool Should the text clear its selection the widget loses focus?
Protected function Virtual Const bool Should the cursor be jumped to the end of the document when the widget gains focus?
Protected function Virtual Const bool Should we revert the text back to its original state when the user presses escape?
Protected function Virtual Const bool Should we select all text when the user commits text to this widget?
Protected function Virtual Const bool Should the text be selected when the widget gains focus?
Protected function Virtual Const bool Should we select word on mouse double click?
Protected function Virtual float

UpdateAndClampHorizontalScrollBar ( const float InViewOffset,
const float InViewFraction,
const EVisibility InVisiblityOverride
)

 Called when the fraction and offset of the horizontal scroll area has been recalculated.
Protected function Virtual float

UpdateAndClampVerticalScrollBar ( const float InViewOffset,
const float InViewFraction,
const EVisibility InVisiblityOverride
)

 Called when the fraction and offset of the vertical scroll area has been recalculated.

Classes

  Type Name Description
Public struct FArguments    
Public struct FScopedEditableTextTransaction Used to merge multiple text edit transactions within a scope  

Typedefs

Name Description
FOnCursorMoved Called when the cursor is moved within the text area

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page