1. Epic GamesDeveloper
  3. SMultiLineEditableTextBox

SMultiLineEditableTextBox

Editable text box widget

API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Widgets > API/Runtime/Slate/Widgets/Input

Inheritance Hierarchy

References

   
Module Slate
Header /Engine/Source/Runtime/Slate/Public/Widgets/Input/SMultiLineEditableTextBox.h
Include #include "Widgets/Input/SMultiLineEditableTextBox.h"

Syntax

class SMultiLineEditableTextBox : public SBorder

Remarks

Editable text box widget

Variables

  Type Name Description
Protected variable TAttribute< bool > AllowContextMenu Whether to disable the context menu
Protected variable TAttribute< FSlateColor > BackgroundColorOverride Background color (overrides style)
Protected variable bool bHasExternalHScrollBar Whether we have an externally supplied horizontal scrollbar or one created internally
Protected variable bool bHasExternalVScrollBar Whether we have an externally supplied vertical scrollbar or one created internally
Protected variable TSharedPtr< SHorizontalBox > Box Allows for inserting additional widgets that extend the functionality of the text box
Protected variable TAttribute< bool > bSelectWordOnMouseDoubleClick Whether to select work on mouse double click
Protected variable TSharedPtr< SMultiLineEditableText > EditableText Editable text widget
Protected variable TSharedPtr< class IErrorReportingWidget > ErrorReporting SomeWidget reporting
Protected variable TAttribute< FSlateColor > FocusedForegroundColorOverride Focused foreground color (overrides style)
Protected variable TAttribute< FSlateFontInfo > FontOverride Font (overrides style)
Protected variable TAttribute< FSlateColor > ForegroundColorOverride Foreground color (overrides style)
Protected variable TSharedPtr< SScrollBar > HScrollBar Horiz scrollbar
Protected variable TSharedPtr< SBox > HScrollBarPaddingBox Box around the horiz scrollbar used for adding padding
Protected variable TAttribute< FMargin > HScrollBarPaddingOverride Horiz scrollbar padding (overrides style)
Protected variable FOnTextChanged OnTextChanged Called when the text is changed interactively
Protected variable FOnTextCommitted OnTextCommitted Called when the user commits their change to the editable text control
Protected variable FOnVerifyTextChanged OnVerifyTextChanged Callback to verify text when changed. Will return an error message to denote problems.
Protected variable TAttribute< FMargin > PaddingOverride Padding (overrides style)
Protected variable TAttribute< FSlateColor > ReadOnlyForegroundColorOverride Read-only foreground color (overrides style)
Protected variable const FEditableTextBoxStyle * Style  
Protected variable TSharedPtr< SScrollBar > VScrollBar Vert scrollbar
Protected variable TSharedPtr< SBox > VScrollBarPaddingBox Box around the vert scrollbar used for adding padding
Protected variable TAttribute< FMargin > VScrollBarPaddingOverride Vert scrollbar padding (overrides style)

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)
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
)

 Construct this widget
Public function void

ForceScroll ( int32 UserIndex,
float ScrollAxisMagnitude
)

  
Public function Const void

GetCurrentTextLine ( FString& OutTextLine
)

 Return 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 FText Returns the hint text string
Public function Const TSharedPtr< const SScrollBar > Get the horizontal scroll bar widget
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 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 FText

GetText ()

 Returns the text string
Public function Const TSharedPtr< const SScrollBar > Get the vertical scroll bar widget
Public function void

GoTo ( const ETextLocation NewLocation
)

 Move the cursor to the specified location
Public function void

GoTo ( const FTextLocation& NewLocation
)

 Move the cursor to the given location in the document
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 void

OnEditableTextChanged ( const FText& InText
)

 Callback for the editable text's OnTextChanged event
Protected function void

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

 Callback when the editable text is committed.
Public function void

Refresh ()

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

ScrollTo ( const ETextLocation NewLocation
)

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

ScrollTo ( const FTextLocation& 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

SetAllowContextMenu ( const TAttribute< bool >& InAllowContextMenu
)

 See the AllowContextMenu attribute
Public function void

SetAutoWrapText ( const TAttribute< bool >& InAutoWrapText
)

 See AutoWrapText attribute
Public function void

SetError ( const FString& 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.
Public function 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.
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
)

 Set 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 SMultiLineEditableText's OnKeyChar event
Public function void

SetOnKeyDownHandler ( FOnKeyDown InOnKeyDownHandler
)

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

SetOverflowPolicy ( TOptional< ETextOverflowPolicy > InOverflowPolicy
)

 Sets the overflow policy for this text block
Public function void

SetReadOnlyForegroundColor ( const TAttribute< FSlateColor >& InReadOnlyForegroundColor
)

 Sets the text color and opacity when read-only (overrides Style)
Public function void

SetSearchText ( const TAttribute< FText >& InSearchText
)

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

SetSelectWordOnMouseDoubleClick ( const TAttribute< bool >& InSelectWordOnMouseDoubleClick
)

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

SetStyle ( const FEditableTextBoxStyle* InStyle
)

 See attribute Style
Public function void

SetText ( const TAttribute< FText >& InNewText
)

 Sets the text string currently being edited
Public function void

SetTextBoxBackgroundColor ( const TAttribute< FSlateColor >& InBackgroundColor
)

 Sets the color of the background/border around the editable text (overrides Style)
Public function void

SetTextBoxForegroundColor ( const TAttribute< FSlateColor >& InForegroundColor
)

 Sets the text color and opacity (overrides Style)
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
Public function Virtual Const bool Checks to see if this widget currently has the keyboard focus
Public 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.
Public 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)
Public function Virtual Const bool Checks to see if this widget supports keyboard focus. Override this in derived classes.

Classes

  Type Name Description
Public struct FArguments    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page