code: namespace ETextRole { enum Type { Custom, ButtonText, ComboText, } }


description: Called to dismiss the active context menu

module: Slate

code: void Dismiss()


description: Called before you summon your context menu

code: void PrepareToSummon()


description: Called to reset the active context menu state

code: void Reset()


description: Called if your context menu summon fails

code: void SummonFailed()


description: Called when you've successfully summoned your context menu

code: void SummonSucceeded ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IMenu](API\Runtime\Slate\Framework\Application\IMenu) > & InMenu )


description: Check to see whether this context is valid (either pending or active)

code: bool IsValid() const


className: FActiveTextEditContextMenu

description: Manages the state for an active context menu

code: class FActiveTextEditContextMenu


description: Create an undo for this cursor data


description: Get the alignment of the cursor


description: Get the interaction position of the cursor (where to insert, delete, etc, text from/to)


description: Get the literal position of the cursor (note: this may not be the correct place to insert text to, use GetCursorInteractionLocation for that)


description: Get the direction of the text under the cursor


description: Restore this cursor data from an undo

code: void RestoreFromUndo ( const [FCursorInfo](API\Runtime\Slate\Widgets\Text\FCursorInfo) & UndoData )


description: Set the literal position and alignment of the cursor

code: void SetCursorLocationAndAlignment ( const [FTextLayout](API\Runtime\Slate\Framework\Text\FTextLayout) & InTextLayout, const [FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) & InCursorPosition, const [ECursorAlignment](API\Runtime\Slate\Widgets\Text\SlateEditableTextTypes__ECursorA-) InCursorAlignment )


description: Set the position of the cursor, and then work out the correct alignment based on the current text layout

code: void SetCursorLocationAndCalculateAlignment ( const [FTextLayout](API\Runtime\Slate\Framework\Text\FTextLayout) & InTextLayout, const [FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) & InCursorPosition )


description: Update the last cursor interaction time to now

code: void UpdateLastCursorInteractionTime()


className: FCursorInfo

description: Store the information about the current cursor position

code: class FCursorInfo


code: static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FCursorLineHighlighter](API\Runtime\Slate\Widgets\Text\FCursorLineHighlighter) > Create ( const [FCursorInfo](API\Runtime\Slate\Widgets\Text\FCursorInfo) * InCursorInfo )


code: virtual int32 OnPaint ( const [FPaintArgs](API\Runtime\SlateCore\Types\FPaintArgs) & Args, const [FTextLayout::FLineView](API\Runtime\Slate\Framework\Text\FTextLayout\FLineView) & Line, const float OffsetX, const float Width, const [FTextBlockStyle](API\Runtime\SlateCore\Styling\FTextBlockStyle) & DefaultStyle, const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, const [FSlateRect](API\Runtime\SlateCore\Layout\FSlateRect) & MyCullingRect, [FSlateWindowElementList](API\Runtime\SlateCore\Rendering\FSlateWindowElementList) & OutDrawElements, int32 LayerId, const [FWidgetStyle](API\Runtime\SlateCore\Styling\FWidgetStyle) & InWidgetStyle, bool bParentEnabled ) const


code: void SetCursorBrush ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * > & InCursorBrush )


className: FCursorLineHighlighter

description: Run highlighter used to draw the cursor

code: class FCursorLineHighlighter : public [ISlateLineHighlighter](API\Runtime\Slate\Framework\Text\ISlateLineHighlighter)

CursorBrush

type: TAttribute< con...

description: Brush used to draw the cursor

CursorInfo

type: constFCursorIn...

description: Cursor data that this highlighter is tracking


code: FCursorLineHighlighter ( const [FCursorInfo](API\Runtime\Slate\Widgets\Text\FCursorInfo) * InCursorInfo )


description: Creates a MoveCursor action that describes moving by a single character in any of the cardinal directions.

code: static [FMoveCursor](API\Runtime\Slate\Widgets\Text\FMoveCursor) Cardinal ( ECursorMoveGranularity Granularity, FIntPoint Direction, ECursorAction Action )


description: ECursorAction

code: ECursorAction GetAction() const


description: Geometry Scale at the time of the event that caused this action

code: float GetGeometryScale() const


description: When using directional movement (i.e. Character or Word granularity; not screen position, which way to move.)

code: FIntPoint GetMoveDirection() const


description: Which position in the widget where the user touched when using ScreenPosition mode.

code: FVector2D GetLocalPosition() const


description: Move one character at a time, or one word?


description: ECursorMoveMethod

code: ECursorMoveMethod GetMoveMethod() const


description: Is the cursor moving left/right; Only valid for word and character movement methods.

code: bool IsHorizontalMovement() const


description: Creates a MoveCursor action that describes moving the text cursor by selecting an arbitrary coordinate on the screen. e.g. User user touches a touch device screen or uses the mouse to point at text.

code: static [FMoveCursor](API\Runtime\Slate\Widgets\Text\FMoveCursor) ViaScreenPointer ( FVector2D LocalPosition, float GeometryScale, ECursorAction Action )


className: FMoveCursor

description: No constructors are accessible with public or protected access.

code: class FMoveCursor


description: Is the cursor moving up/down; Only valid for word and character movement methods.

code: bool IsVerticalMovement() const


code: FScrollInfo ( const [FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) InPosition, const [ECursorAlignment](API\Runtime\Slate\Widgets\Text\SlateEditableTextTypes__ECursorA-) InAlignment )


className: FScrollInfo

description: Information needed to be able to scroll to a given point

code: struct FScrollInfo

Alignment

type: ECursorAlignmen...

description: The alignment at the given position.

Position

type: FTextLocation

description: The location in the document to scroll to (in line model space)


description: Query to see if any text is selected within the document

code: bool AnyTextSelected() const


description: Apply the given style to the currently selected text (or insert a new run at the current cursor position if no text is selected)

code: void ApplyToSelection ( const [FRunInfo](API\Runtime\Slate\Framework\Text\FRunInfo) & InRunInfo, const [FTextBlockStyle](API\Runtime\SlateCore\Styling\FTextBlockStyle) & InStyle )


description: Advance the current search to the next match (does nothing if not currently searching)

code: void AdvanceSearch ( const bool InReverse )


description: Called to begin an undoable editable text transaction

code: void BeginEditTransation()


description: Are we able to copy the currently selected text?

code: bool CanExecuteCopy() const


description: Begin a new text search (this is called automatically when BoundSearchText changes)

code: void BeginSearch ( const [FText](API\Runtime\Core\Internationalization\FText) & InSearchText, const [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) InSearchCase, const bool InReverse )


code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > BuildDefaultContextMenu ( const [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FExtender](API\Runtime\Slate\Framework\MultiBox\FExtender) > & InMenuExtender ) const


description: Are we able to cut the currently selected text?

code: bool CanExecuteCut() const


description: Are we able to delete the currently selected text?

code: bool CanExecuteDelete() const


code: void CacheDesiredSize ( float LayoutScaleMultiplier )


description: Are we able to paste the text from the clipboard into this document?

code: bool CanExecutePaste() const


description: Are we currently able to execute a redo action?

code: bool CanExecuteRedo() const


description: Are we able to execute the "Select All" command?

code: bool CanExecuteSelectAll() const


description: Are we currently able to execute an undo action?

code: bool CanExecuteUndo() const


description: Clear the current undo stack

code: void ClearUndoStates()


description: Clear the active text selection

code: void ClearSelection()


description: Copy the currently selected text and place it on the clipboard

code: void CopySelectedTextToClipboard()


code: FVector2D ComputeDesiredSize ( float LayoutScaleMultiplier ) const


description: Cut the currently selected text and place it on the clipboard

code: void CutSelectedTextToClipboard()


description: Called to end an undoable editable text transaction

code: void EndEditTransaction()


description: Delete any currently selected text

code: void DeleteSelectedText()


description: Force the text layout to be updated from the marshaller

code: void ForceRefreshTextLayout ( const [FText](API\Runtime\Core\Internationalization\FText) & CurrentText )


description: Register and activate the IME context for this text layout

code: void EnableTextInputMethodContext()


description: Get the character at Location

code: TCHAR GetCharacterAt ( const [FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) & Location ) const


description: Returns whether or not we are auto wrapping text

code: bool GetAutoWrapText() const


description: Returns the computed wrap location for this layout

code: float GetComputedWrappingWidth() const


description: Fill OutTextLine with the text line where the current cursor location is at

code: void GetCurrentTextLine ( [FString](API\Runtime\Core\Containers\FString) & OutTextLine ) const


description: Get the interaction position of the cursor (where to insert, delete, etc, text from/to)


description: Gets the current editable text for this text block Note: We don't store text in this form (it's stored as lines in the text layout) so every call to this function has to reconstruct it


description: Get the plain text string without rich-text formatting


description: Get the total number of search results (0 if none)

code: int32 GetNumSearchResults() const


description: Get the run currently under the cursor, or null if there is no run currently under the cursor

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [IRun](API\Runtime\Slate\Framework\Text\IRun) > GetRunUnderCursor() const


description: Get the absolute scroll offset value


description: Get the index of the search result (0 if none)

code: int32 GetSearchResultIndex() const


description: Get the runs currently that are current selected, some of which may be only partially selected

code: [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [IRun](API\Runtime\Slate\Framework\Text\IRun) > > GetSelectedRuns() const


description: Get the currently selected text


description: Get the current selection


description: Get the IME context for this text layout


description: Fill OutTextLine with the text line at the specified index

code: void GetTextLine ( const int32 InLineIndex, [FString](API\Runtime\Core\Containers\FString) & OutTextLine ) const


description: Get the number of Text Lines

code: int32 GetTextLineCount()


description: Move the cursor specified location

code: void GoTo ( const ETextLocation NewLocation )


code: const [FTextBlockStyle](API\Runtime\SlateCore\Styling\FTextBlockStyle) & GetTextStyle() const


description: Get the virtual keyboard handler for this text layout


description: Called to handle a backspace action acting on the current selection or at the cursor position

code: bool HandleBackspace()


description: Move the cursor to the given location in the document (will also scroll to this point)

code: void GoTo ( const [FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) & NewLocation )


description: Called when our parent widget loses focus

code: bool HandleFocusLost ( const [FFocusEvent](API\Runtime\SlateCore\Input\FFocusEvent) & InFocusEvent )


description: Called to handle a carriage return action acting on the current selection or at the cursor position

code: bool HandleCarriageReturn ( bool isRepeat )


description: Called to handle an escape action acting on the current selection

code: bool HandleEscape()


description: Called to handle a delete action acting on the current selection or at the cursor position

code: bool HandleDelete()


description: Called to handle an OnKeyChar event from our parent widget

code: [FReply](API\Runtime\SlateCore\Input\FReply) HandleKeyChar ( const [FCharacterEvent](API\Runtime\SlateCore\Input\FCharacterEvent) & InCharacterEvent )


description: Called to handle an OnKeyDown event from our parent widget

code: [FReply](API\Runtime\SlateCore\Input\FReply) HandleKeyDown ( const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & InKeyEvent )


description: Called when our parent widget receives focus

code: bool HandleFocusReceived ( const [FFocusEvent](API\Runtime\SlateCore\Input\FFocusEvent) & InFocusEvent )


description: Called to handle an OnKeyUp event from our parent widget

code: [FReply](API\Runtime\SlateCore\Input\FReply) HandleKeyUp ( const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & InKeyEvent )


description: Called to handle an OnMouseButtonDoubleClick event from our parent widget

code: [FReply](API\Runtime\SlateCore\Input\FReply) HandleMouseButtonDoubleClick ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & InMyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & InMouseEvent )


description: Called to handle an OnMouseButtonUp event from our parent widget

code: [FReply](API\Runtime\SlateCore\Input\FReply) HandleMouseButtonUp ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & InMouseEvent )


description: Called to handle an OnMouseMove event from our parent widget

code: [FReply](API\Runtime\SlateCore\Input\FReply) HandleMouseMove ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & InMyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & InMouseEvent )


description: Called to handle a typing a character on the current selection or at the cursor position

code: bool HandleTypeChar ( const TCHAR InChar )


description: Called to handle an OnMouseButtonDown event from our parent widget

code: [FReply](API\Runtime\SlateCore\Input\FReply) HandleMouseButtonDown ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & InMouseEvent )


description: Returns whether the current text varies from the original

code: bool HasTextChangedFromOriginal() const


description: Insert the given run at the current cursor position

code: void InsertRunAtCursor ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IRun](API\Runtime\Slate\Framework\Text\IRun) > InRun )


description: Are we at the beginning of all the text.

code: bool IsAtBeginningOfDocument ( const [FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) & Location ) const


description: Insert the given text at the current cursor position, correctly taking into account new line characters

code: void InsertTextAtCursor ( const [FString](API\Runtime\Core\Containers\FString) & InString )


description: Is this location the beginning of a line

code: bool IsAtBeginningOfLine ( const [FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) & Location ) const


description: Is this location the end of a line.

code: bool IsAtEndOfLine ( const [FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) & Location ) const


description: Are we at the end of all the text.

code: bool IsAtEndOfDocument ( const [FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) & Location ) const


description: Query to see if the text under the given position is currently selected (the position is local to the text layout space)

code: bool IsTextSelectedAt ( const [UE::Slate::FDeprecateVector2DParameter](API\Runtime\SlateCore\Types\FDeprecateVector2DParameter) & InLocalPosition ) const


description: Are we currently at the beginning of a word

code: bool IsAtWordStart ( const [FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) & Location ) const


description: Query to see if the text under the given position is currently selected

code: bool IsTextSelectedAt ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [UE::Slate::FDeprecateVector2DParameter](API\Runtime\SlateCore\Types\FDeprecateVector2DParameter) & ScreenSpacePosition ) const


description: Jump the cursor to the given location in the document

code: void JumpTo ( ETextLocation JumpLocation, ECursorAction Action )


description: Move the cursor in the document using the specified move method

code: bool MoveCursor ( const [FMoveCursor](API\Runtime\Slate\Widgets\Text\FMoveCursor) & InArgs )


description: Create an undo state that reflects the current state of the document

code: void MakeUndoState ( [SlateEditableTextTypes::FUndoState](API\Runtime\Slate\Widgets\Text\FUndoState) & OutUndoState )


code: void OnArrangeChildren ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, [FArrangedChildren](API\Runtime\SlateCore\Layout\FArrangedChildren) & ArrangedChildren ) const


description: Execute a redo action

code: void Redo()


description: Push the given undo state onto the undo stack

code: void PushUndoState ( const [SlateEditableTextTypes::FUndoState](API\Runtime\Slate\Widgets\Text\FUndoState) & InUndoState )


description: Paste the text from the clipboard into this document

code: void PasteTextFromClipboard()


description: Refresh this editable text immediately, rather than wait for the usual caching mechanisms to take affect on the text Tick

code: bool Refresh()


code: int32 OnPaint ( const [FPaintArgs](API\Runtime\SlateCore\Types\FPaintArgs) & Args, const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, const [FSlateRect](API\Runtime\SlateCore\Layout\FSlateRect) & MyCullingRect, [FSlateWindowElementList](API\Runtime\SlateCore\Rendering\FSlateWindowElementList) & OutDrawElements, int32 LayerId, const [FWidgetStyle](API\Runtime\SlateCore\Styling\FWidgetStyle) & InWidgetStyle, bool bParentEnabled )


description: Remove any active cursor highlights

code: void RemoveCursorHighlight()


description: Restores the text to the original state

code: void RestoreOriginalText()


code: void SaveText ( const [FText](API\Runtime\Core\Internationalization\FText) & TextToSave )


description: Find the closest word boundary

code: [FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) ScanForWordBoundary ( const [FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) & Location, int8 Direction ) const


description: Scroll to the given location in the document (without moving the cursor)

code: void ScrollTo ( const [FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) & NewLocation )


code: void ScrollTo ( const ETextLocation NewLocation )


description: Select all the text in the document

code: void SelectAllText()


description: Select a block of text

code: void SelectText ( const [FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) & InSelectionStart, const [FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) & InCursorLocation )


description: Select the word under the given position

code: void SelectWordAt ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [UE::Slate::FDeprecateVector2DParameter](API\Runtime\SlateCore\Types\FDeprecateVector2DParameter) & ScreenSpacePosition )


description: Select the word under the given position (the position is local to the text layout space)

code: void SelectWordAt ( const [UE::Slate::FDeprecateVector2DParameter](API\Runtime\SlateCore\Types\FDeprecateVector2DParameter) & InLocalPosition )


description: Set whether to wrap text automatically based on the widget's computed horizontal space

code: void SetAutoWrapText ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< bool > & InAutoWrapText )


description: Set the brush to use when drawing the composition highlight

code: void SetCompositionBrush ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * > & InCompositionBrush )


description: Set the brush to use when drawing the cursor

code: void SetCursorBrush ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * > & InCursorBrush )


description: Set the information used to help identify who owns this text layout in the case of an error

code: void SetDebugSourceInfo ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FString](API\Runtime\Core\Containers\FString) > & InDebugSourceInfo )


description:
Sets the current editable text for this text block Note: Doesn't update the value of BoundText, nor does it call OnTextChanged
true if the text was updated, false if the text wasn't update (because it was already up-to-date)

code: bool SetEditableText ( const [FText](API\Runtime\Core\Internationalization\FText) & TextToSet, const bool bForce )


description: Update the horizontal scroll amount from the given fraction

code: [UE::Slate::FDeprecateVector2DResult](API\Runtime\SlateCore\Types\FDeprecateVector2DResult) SetHorizontalScrollFraction ( const float InScrollOffsetFraction )


code: void SetHintText ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InHintText )


description: Set how the text should be aligned with the margin

code: void SetJustification ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [ETextJustify::Type](API\Runtime\Slate\Framework\Text\ETextJustify__Type) > & InJustification )


description: Set the text overflow policy that should be used to determine what happens to clipped text

code: void SetOverflowPolicy ( [TOptional](API\Runtime\Core\IO\TOptional)< ETextOverflowPolicy > InOverflowPolicy )


description: Set the amount to scale each lines height by

code: void SetLineHeightPercentage ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< float > & InLineHeightPercentage )


description: Set the amount of blank space left around the edges of text area

code: void SetMargin ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FMargin](API\Runtime\SlateCore\Layout\FMargin) > & InMargin )


description: Set the absolute scroll offset value

code: [UE::Slate::FDeprecateVector2DResult](API\Runtime\SlateCore\Types\FDeprecateVector2DResult) SetScrollOffset ( const [UE::Slate::FDeprecateVector2DParameter](API\Runtime\SlateCore\Types\FDeprecateVector2DParameter) & InScrollOffset, const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & InGeometry )


code: void SetText ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InText )


code: void SetSearchText ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InSearchText )


description: Set the text flow direction that the internal text layout should use

code: void SetTextFlowDirection ( const [TOptional](API\Runtime\Core\IO\TOptional)< ETextFlowDirection > & InTextFlowDirection )


description: Set the text shaping method that the internal text layout should use

code: void SetTextShapingMethod ( const [TOptional](API\Runtime\Core\IO\TOptional)< ETextShapingMethod > & InTextShapingMethod )


code: void SetTextStyle ( const [FTextBlockStyle](API\Runtime\SlateCore\Styling\FTextBlockStyle) & InTextStyle )


description: Set the wrapping to use for this document

code: void SetTextWrapping ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< float > & InWrapTextAt, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< bool > & InAutoWrapText, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< ETextWrappingPolicy > & InWrappingPolicy )


description: Update the vertical scroll amount from the given fraction

code: [UE::Slate::FDeprecateVector2DResult](API\Runtime\SlateCore\Types\FDeprecateVector2DResult) SetVerticalScrollFraction ( const float InScrollOffsetFraction )


description: Set the wrapping policy to use

code: void SetWrappingPolicy ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< ETextWrappingPolicy > & InWrappingPolicy )


code: void Tick ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, const double InCurrentTime, const float InDeltaTime )


description: Set whether text wraps onto a new line when it's length exceeds this width; if this value is zero or negative, no wrapping occurs

code: void SetWrapTextAt ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< float > & InWrapTextAt )


description: Given a location and a Direction to offset, return a new location.

code: [FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) TranslatedLocation ( const [FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) & CurrentLocation, int8 Direction ) const


description: Execute an undo action

code: void Undo()


description: Update the active cursor highlight based on the state of the text layout

code: void UpdateCursorHighlight()


description: Update the preferred offset of the cursor, based on the current state of the text layout


code: void TranslateLocationVertical ( const [FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) & Location, int32 NumLinesToMove, float GeometryScale, [FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) & OutCursorPosition, [TOptional](API\Runtime\Core\IO\TOptional)< [SlateEditableTextTypes::ECursorAlignment](API\Runtime\Slate\Widgets\Text\SlateEditableTextTypes__ECursorA-) > & OutCursorAlignment ) const


code: FSlateEditableTextLayout ( [ISlateEditableTextWidget](API\Runtime\Slate\Widgets\Text\ISlateEditableTextWidget) & InOwnerWidget, const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InInitialText, [FTextBlockStyle](API\Runtime\SlateCore\Styling\FTextBlockStyle) InTextStyle, const [TOptional](API\Runtime\Core\IO\TOptional)< ETextShapingMethod > InTextShapingMethod, const [TOptional](API\Runtime\Core\IO\TOptional)< ETextFlowDirection > InTextFlowDirection, const FCreateSlateTextLayout & InCreateSlateTextLayout, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ITextLayoutMarshaller](API\Runtime\Slate\Framework\Text\ITextLayoutMarshaller) > InTextMarshaller, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ITextLayoutMarshaller](API\Runtime\Slate\Framework\Text\ITextLayoutMarshaller) > InHintTextMarshaller )


className: FSlateEditableTextLayout

description: Class to handle the cached layout of SEditableText/SMultiLineEditableText by proxying around aFTextLayout

code: class FSlateEditableTextLayout


description: Get the computed desired size for this layout, updating the internal cache as required

code: FVector2D ComputeDesiredSize ( const [FWidgetDesiredSizeArgs](API\Runtime\Slate\Widgets\Text\FSlateTextBlockLayout\FWidgetDesiredSizeArgs) & InWidgetArgs, const float InScale )


description: Arrange any child widgets in this layout

code: void ArrangeChildren ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, [FArrangedChildren](API\Runtime\SlateCore\Layout\FArrangedChildren) & ArrangedChildren ) const


code: FVector2D ComputeDesiredSize ( const [FWidgetDesiredSizeArgs](API\Runtime\Slate\Widgets\Text\FSlateTextBlockLayout\FWidgetDesiredSizeArgs) & InWidgetArgs, const float InScale, const [FTextBlockStyle](API\Runtime\SlateCore\Styling\FTextBlockStyle) & InTextStyle )


code: PRAGMA_DISABLE_DEPRECATION_WARNINGSFVector2D ComputeDesiredSize ( const [FWidgetArgs](API\Runtime\Slate\Widgets\Text\FSlateTextBlockLayout\FWidgetArgs) & InWidgetArgs, const float InScale, const [FTextBlockStyle](API\Runtime\SlateCore\Styling\FTextBlockStyle) & InTextStyle )


description: Conditionally update the text style if needed

code: void ConditionallyUpdateTextStyle ( const [FTextBlockStyle](API\Runtime\SlateCore\Styling\FTextBlockStyle) & InTextStyle )


description: Force dirty the content due to an external change that can't be picked up automatically by this cache. Also force dirties the layout. Will cause the contained text to be re-parsed by the marshaller next frame.

code: void DirtyContent()


code: void ConditionallyUpdateTextStyle ( const [FTextBlockStyle::CompareParams](API\Runtime\SlateCore\Styling\FTextBlockStyle\CompareParams) & InNewStyleParams )


description: Force dirty the layout due to an external change that can't be picked up automatically by this cache

code: void DirtyLayout()


code: FWidgetArgs &40; const TAttribute< FText > & InText, const TAttribute< FText > & InHighlightText, const TAttribute< float > & InWrapTextAt, const TAttribute< bool > & InAutoWrapText, const TAttribute< ETextWrappingPolicy > & InWrappingPolicy, const TAttribute< ETextTransformPolicy > & InTransformPolicy, const TAttribute< FMargin > & InMargin, const TAttribute< float > & InLineHeightPercentage, const TAttribute< ETextJustify::Type > & InJustification &41;


className: FWidgetArgs

code: struct FWidgetArgs

AutoWrapText

type: constTAttribut...


className: FWidgetDesiredSizeArgs

code: struct FWidgetDesiredSizeArgs

type: const bool

HighlightText

type: constFText

Justification

type: constETextJust...

LineHeightPercentage

type: const float

Margin

type: constFMargin

TransformPolicy

type: const ETextTran...

WrappingPolicy

type: const ETextWrap...


code: FWidgetDesiredSizeArgs &40; const FText & InText, const FText & InHighlightText, const float InWrapTextAt, const bool InAutoWrapText, const ETextWrappingPolicy InWrappingPolicy, const ETextTransformPolicy InTransformPolicy, const FMargin & InMargin, const float InLineHeightPercentage, const ETextJustify::Type InJustification &41;


description: Get the TextLayout scale.

code: float GetLayoutScale() const


description: Gets the last computed desired size.

code: FVector2D GetDesiredSize() const


description: Get the child widgets of this layout


description: Paint this layout, updating the internal cache as required

code: int32 OnPaint ( const [FPaintArgs](API\Runtime\SlateCore\Types\FPaintArgs) & InPaintArgs, const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & InAllottedGeometry, const [FSlateRect](API\Runtime\SlateCore\Layout\FSlateRect) & InClippingRect, [FSlateWindowElementList](API\Runtime\SlateCore\Rendering\FSlateWindowElementList) & OutDrawElements, int32 LayerId, const [FWidgetStyle](API\Runtime\SlateCore\Styling\FWidgetStyle) & InWidgetStyle, bool bParentEnabled )


description: Override the text style used and immediately update the text layout (if required). This can be used to override the text style after calling ComputeDesiredSize (eg, if you can only compute your text style in OnPaint) Please note that changing the size or font used by the text may causing clipping issues until the next call to ComputeDesiredSize

code: void OverrideTextStyle ( const [FTextBlockStyle](API\Runtime\SlateCore\Styling\FTextBlockStyle) & InTextStyle )


description: Set the information used to help identify who owns this text layout in the case of an error

code: void SetDebugSourceInfo ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FString](API\Runtime\Core\Containers\FString) > & InDebugSourceInfo )


description: Set the text flow direction that the internal text layout should use

code: void SetTextFlowDirection ( const [TOptional](API\Runtime\Core\IO\TOptional)< ETextFlowDirection > & InTextFlowDirection )


description: Set the text overflow policy that the internal text layout should use

code: void SetTextOverflowPolicy ( const [TOptional](API\Runtime\Core\IO\TOptional)< ETextOverflowPolicy > InTextOverflowPolicy )


description: Set the text shaping method that the internal text layout should use

code: void SetTextShapingMethod ( const [TOptional](API\Runtime\Core\IO\TOptional)< ETextShapingMethod > & InTextShapingMethod )


description: Constructor

code: FSlateTextBlockLayout ( [SWidget](API\Runtime\SlateCore\Widgets\SWidget) * InOwner, [FTextBlockStyle](API\Runtime\SlateCore\Styling\FTextBlockStyle) InDefaultTextStyle, const [TOptional](API\Runtime\Core\IO\TOptional)< ETextShapingMethod > InTextShapingMethod, const [TOptional](API\Runtime\Core\IO\TOptional)< ETextFlowDirection > InTextFlowDirection, const FCreateSlateTextLayout & InCreateSlateTextLayout, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ITextLayoutMarshaller](API\Runtime\Slate\Framework\Text\ITextLayoutMarshaller) > InMarshaller, [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [IBreakIterator](API\Runtime\Core\Internationalization\IBreakIterator) > InLineBreakPolicy )


className: FSlateTextBlockLayout

description: Class to handle the cached layout of STextBlock/SRichTextBlock by proxying around aFTextLayout

code: class FSlateTextBlockLayout


code: virtual int32 OnPaint ( const [FPaintArgs](API\Runtime\SlateCore\Types\FPaintArgs) & Args, const [FTextLayout::FLineView](API\Runtime\Slate\Framework\Text\FTextLayout\FLineView) & Line, const float OffsetX, const float Width, const [FTextBlockStyle](API\Runtime\SlateCore\Styling\FTextBlockStyle) & DefaultStyle, const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, const [FSlateRect](API\Runtime\SlateCore\Layout\FSlateRect) & MyCullingRect, [FSlateWindowElementList](API\Runtime\SlateCore\Rendering\FSlateWindowElementList) & OutDrawElements, int32 LayerId, const [FWidgetStyle](API\Runtime\SlateCore\Styling\FWidgetStyle) & InWidgetStyle, bool bParentEnabled ) const


code: static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FTextCompositionHighlighter](API\Runtime\Slate\Widgets\Text\FTextCompositionHighlighter) > Create()


code: void SetCompositionBrush ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< const [FSlateBrush](API\Runtime\SlateCore\Styling\FSlateBrush) * > & InCompositionBrush )


className: FTextCompositionHighlighter

description: Run highlighter used to draw the composition range

code: class FTextCompositionHighlighter : public [ISlateLineHighlighter](API\Runtime\Slate\Framework\Text\ISlateLineHighlighter)

CompositionBrush

description: Brush used to draw the composition highlight


code: static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FTextSearchHighlighter](API\Runtime\Slate\Widgets\Text\FTextSearchHighlighter) > Create()


code: void SetHasKeyboardFocus ( const bool bInHasKeyboardFocus )


className: FTextSearchHighlighter

description: Run highlighter used to draw search ranges

code: class FTextSearchHighlighter : public [ISlateLineHighlighter](API\Runtime\Slate\Framework\Text\ISlateLineHighlighter)

bHasKeyboardFocus

type: bool

description: True if the parent widget has keyboard focus, false otherwise


code: static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FTextSelectionHighlighter](API\Runtime\Slate\Widgets\Text\FTextSelectionHighlighter) > Create()


className: FTextScrollerOptions

code: struct FTextScrollerOptions

EndDelay

type: float

description: Delay (in seconds) to pause after scrolling the text

FadeInDelay

description: Duration (in seconds) to fade in before scrolling the text

FadeOutDelay

description: Duration (in seconds) to fade out after scrolling the text

Speed

description: Speed (in Slate units) to scroll per-second

StartDelay

description: Delay (in seconds) to pause before scrolling the text


className: FTextSelectionHighlighter

description: Run highlighter used to draw selection ranges

code: class FTextSelectionHighlighter : public [ISlateLineHighlighter](API\Runtime\Slate\Framework\Text\ISlateLineHighlighter)


className: FUndoState

description: Stores a single undo level for editable text

code: struct FUndoState

CursorInfo

type: FCursorInfo

description: Cursor data

SelectionStart

type: TOptional<FTex...

description: Selection state

Text

type: FText

description: Text


description: Build the context menu content to use for this widget (if any)

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > BuildContextMenuContent() const


description: Are we currently able to insert a carriage return? (some widgets have modifier keys that need to be pressed)

code: bool CanInsertCarriageReturn() const


description: Are we able to insert the given character into our text?

code: bool CanTypeCharacter ( const TCHAR InChar ) const


description: Get the Slate widget this interface is representing (may not be called during destruction)

code: [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GetSlateWidget()


description: 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

code: void EnsureActiveTick()


description: Get the Slate widget this interface is representing (may be null during destruction)


description: Get the message action to take when the virtual keyboard is dismissed by the user


description: Get the options for the virtual keyboard used for this widget


description: Get the type of event that will trigger the display of the virtual keyboard


description: Get the type of virtual keyboard to use for this widget


description: Is the text edit multi-line aware?

code: bool IsMultiLineTextEdit() const


description: Is the text displaying a password and should be obscured?

code: bool IsTextPassword() const


description: Is the text currently read-only?

code: bool IsTextReadOnly() const


description: Called when the cursor is moved within the text area

code: void OnCursorMoved ( const [FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) & InLocation )


description: Called when the text has been changed by an edit operation

code: void OnTextChanged ( const [FText](API\Runtime\Core\Internationalization\FText) & InText )


description: Called when the text control has committed its current edit changes

code: void OnTextCommitted ( const [FText](API\Runtime\Core\Internationalization\FText) & InText, const [ETextCommit::Type](API\Runtime\SlateCore\Types\ETextCommit__Type) InTextAction )


description: Should we clear the keyboard focus when the user commits text to this widget?


description: Should the text clear its selection the widget loses focus?


description: Should the cursor be jumped to the end of the document when the widget gains focus?


description: Should we revert the text back to its original state when the user presses escape?

code: bool ShouldRevertTextOnEscape() const


description: Should we select all text when the user commits text to this widget?


description: Should the text be selected when the widget gains focus?


description: Should we select word on mouse double click?


description: Called when the fraction and offset of the horizontal scroll area has been recalculated. This function should apply the new values to any scrollbars, and return a clamped horizontal scroll value

code: float UpdateAndClampHorizontalScrollBar ( const float InViewOffset, const float InViewFraction, const [EVisibility](API\Runtime\SlateCore\Layout\EVisibility) InVisiblityOverride )


description: Called when the fraction and offset of the vertical scroll area has been recalculated. This function should apply the new values to any scrollbars, and return a clamped vertical scroll value

code: float UpdateAndClampVerticalScrollBar ( const float InViewOffset, const float InViewFraction, const [EVisibility](API\Runtime\SlateCore\Layout\EVisibility) InVisiblityOverride )


className: ISlateEditableTextWidget

description: Interface to allowFSlateEditableTextLayoutto notify its parent SEditableText/SMultiLineEditableText of changes, as well as query some widget specific state

code: class ISlateEditableTextWidget


description: Cancels the edit mode and switches back to label mode

code: void CancelEditMode()


description: Construct this widget. Called by the SNew()Slate macro.

code: void Construct ( const [FArguments](API\Runtime\Slate\Widgets\Text\SInlineEditableTextBlock\FArguments) & InArgs )


description: Switches the widget to editing mode

code: void EnterEditingMode()


description: Switches the widget to label mode.

code: void ExitEditingMode()


description: Whether the multiline text should wrap automatically when in edit mode

code: WidgetArgsType & AutoWrapMultilineEditText &40; const TAttribute< bool > & InAttribute &41;


description: Whether the text should wrap automatically when in non-edit mode

code: WidgetArgsType & AutoWrapNonEditText &40; const TAttribute< bool > & InAttribute &41;


description: Text color and opacity (overrides style)

code: WidgetArgsType & ColorAndOpacity &40; const TAttribute< FSlateColor > & InAttribute &41;


description: Sets the font used to draw the text (overrides style)

code: WidgetArgsType & Font &40; const TAttribute< FSlateFontInfo > & InAttribute &41;


description: True if the editable text block is read-only. It will not be able to enter edit mode if read-only

code: WidgetArgsType & IsReadOnly &40; const TAttribute< bool > & InAttribute &41;


description: Highlight this text in the text block

code: WidgetArgsType & HighlightText &40; const TAttribute< FText > & InAttribute &41;


description: Callback to check if the widget is selected, should only be hooked up if parent widget is handling selection or focus.

code: WidgetArgsType & IsSelected &40; const FIsSelected & InDelegate &41;


description: The iterator to use to detect appropriate soft-wrapping points for lines (or null to use the default)

code: WidgetArgsType & LineBreakPolicy &40; TSharedPtr< IBreakIterator > InArg &41;


description: How the text should be aligned with the margin.

code: WidgetArgsType & Justification &40; const TAttribute< ETextJustify::Type > & InAttribute &41;


description: True if the editable text block is multi-line

code: WidgetArgsType & MultiLine &40; bool InArg &41;


description: The optional modifier key necessary to create a newline when typing into the editor.

code: WidgetArgsType & ModiferKeyForNewLine &40; EModifierKey::Type InArg &41;


description: Callback when the text starts to be edited

code: WidgetArgsType & OnBeginTextEdit &40; const FOnBeginTextEdit & InDelegate &41;


description: Callback when the text editing begins.

code: WidgetArgsType & OnEnterEditingMode &40; const FSimpleDelegate & InDelegate &41;


description: Callback when the text editing ends.

code: WidgetArgsType & OnExitEditingMode &40; const FSimpleDelegate & InDelegate &41;


description: Callback when the text is committed.

code: WidgetArgsType & OnTextCommitted &40; const FOnTextCommitted & InDelegate &41;


description: Called whenever the text is changed programmatically or interactively by the user

code: WidgetArgsType & OnVerifyTextChanged &40; const FOnVerifyTextChanged & InDelegate &41;


description: Determines what happens to text that is clipped and doesn't fit within the clip rect for this widget

code: WidgetArgsType & OverflowPolicy &40; TOptional< ETextOverflowPolicy > InArg &41;


description: Shadow color and opacity (overrides style)

code: WidgetArgsType & ShadowColorAndOpacity &40; const TAttribute< FLinearColor > & InAttribute &41;


description: Drop shadow offset in pixels (overrides style)

code: WidgetArgsType & ShadowOffset &40; const TAttribute< FVector2D > & InAttribute &41;


description: Pointer to a style of the inline editable text block, which dictates the font, color, and shadow options.

code: WidgetArgsType & Style &40; const FInlineEditableTextBlockStyle &42; InArg &41;


description: The text displayed in this text block

code: WidgetArgsType & Text &40; const TAttribute< FText > & InAttribute &41;


className: WidgetArgsType

code: typedef FArguments WidgetArgsType


description: Whether text wraps onto a new line when it's length exceeds this width; if this value is zero or negative, no wrapping occurs.

code: WidgetArgsType & WrapTextAt &40; const TAttribute< float > & InAttribute &41;


className: FArguments

code: struct FArguments : public [TSlateBaseNamedArgs< SInlineEditableTextBlock >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


description:
Called during drag and drop when the the mouse is being dragged over a widget.
A reply that indicated whether this event was handled.

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnDragOver ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FDragDropEvent](API\Runtime\SlateCore\Input\FDragDropEvent) & DragDropEvent )


description: Checks if the widget is in edit mode

code: bool IsInEditMode() const


description:
Called after a key is pressed when this widget has focus (this event bubbles if not handled)
Returns whether the event was handled, along with other possible actions

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnKeyDown ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & InKeyEvent )


description:
MOUSE INPUT The system calls this method to notify the widget that a mouse button was pressed within it. This event is bubbled.
Whether the event was handled along with possible requests for the system to take action.

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonDown ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


description:
Called when a mouse button is double clicked. Override this in derived classes.
Returns whether the event was handled, along with other possible actions

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonDoubleClick ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & InMyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & InMouseEvent )


description: Callback when the text box is committed, switches back to label mode.

code: void OnTextBoxCommitted ( const [FText](API\Runtime\Core\Internationalization\FText) & InText, [ETextCommit::Type](API\Runtime\SlateCore\Types\ETextCommit__Type) InCommitType )


description: Callback for the text box's OnTextChanged event

code: void OnTextChanged ( const [FText](API\Runtime\Core\Internationalization\FText) & InText )


code: void SetText ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InText )


code: void SetReadOnly ( bool bInIsReadOnly )


code: void SetText ( const [FString](API\Runtime\Core\Containers\FString) & InText )


description: Sets the overflow policy for this text block

code: void SetOverflowPolicy ( [TOptional](API\Runtime\Core\IO\TOptional)< ETextOverflowPolicy > InOverflowPolicy )


description:
SeeSWidget::SupportsKeyboardFocus().
This widget can gain focus if IsSelected is not bound.

code: virtual bool SupportsKeyboardFocus() const


description: Sets the wrap text at attribute. See WrapTextAt attribute

code: void SetWrapTextAt ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< float > & InWrapTextAt )


className: SInlineEditableTextBlock

description: Slate's InlineEditableTextBlock's are double selectable to go from aSTextBlockto becomeSEditableTextBox.

code: class SInlineEditableTextBlock : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)

bIsMultiLine

type: uint8: 1

description: Attribute to look up if the widget is multiline

bIsReadOnly

type: TAttribute< boo...

description: Attribute to look up if the widget is read-only

DoubleSelectDelay

description: When selection of widget is managed by another widget, this delays the "double select" from occurring immediately, offering a chance for double clicking to take action.

HorizontalBox

type: TSharedPtr<SHo...

description: Main horizontal box, used to dynamically add and remove the editable slot.

IsSelected

type: FIsSelected

description: Delegate to execute to check the status of if the widget is selected or not Only needs to be hooked up if an external widget is managing selection, such as aSListVieworSTreeView.

MultiLineTextBox

type: TSharedPtr<SMu...

description: The widget used when in editing mode

OnBeginTextEditDelegate

type: FOnBeginTextEdi...

description: Delegate to execute when the text starts to be edited

OnEnterEditingMode

type: FSimpleDelegate

OnTextCommittedDelegate

type: FOnTextCommitte...

description: Delegate to execute when editing mode text is committed.

OnVerifyTextChanged

type: FOnVerifyTextCh...

description: Callback to verify text when changed. Will return an error message to denote problems.

type: TAttribute<FTe...

description: Attribute for the text to use for the widget

TextBlock

type: TSharedPtr<STe...

description: The widget used when in label mode

TextBox

type: TSharedPtr<SEd...

description: The widget used when in editing mode

WidgetToFocus

type: TWeakPtr<SWidg...

description: Widget to focus when we finish editing


code: namespace SlateEditableTextTypes { enum ECursorAlignment { Left, Right, } }


description: Advance the current search to the next match (does nothing if not currently searching)

code: void AdvanceSearch ( const bool InReverse )


description: Query to see if any text is selected within the document

code: bool AnyTextSelected() const


description: Called to begin an undoable editable text transaction, marked as protected for use withFScopedEditableTextTransactiononly

code: void BeginEditTransaction()


description: Apply the given style to the currently selected text (or insert a new run at the current cursor position if no text is selected)

code: void ApplyToSelection ( const [FRunInfo](API\Runtime\Slate\Framework\Text\FRunInfo) & InRunInfo, const [FTextBlockStyle](API\Runtime\SlateCore\Styling\FTextBlockStyle) & InStyle )


description: Begin a new text search (this is called automatically when the bound search text changes)

code: void BeginSearch ( const [FText](API\Runtime\Core\Internationalization\FText) & InSearchText, const [ESearchCase::Type](API\Runtime\Core\Misc\ESearchCase__Type) InSearchCase, const bool InReverse )


description: Build the context menu content to use for this widget (if any)

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > BuildContextMenuContent() const


description: Are we currently able to insert a carriage return? (some widgets have modifier keys that need to be pressed)

code: virtual bool CanInsertCarriageReturn() const


description: The system calls this method. It performs a breadth-first traversal of every visible widget and asks each widget to cache how big it needs to be in order to present all of its content.

code: virtual void CacheDesiredSize ( float InLayoutScaleMultiplier )


description: Are we able to insert the given character into our text?

code: virtual bool CanTypeCharacter ( const TCHAR InChar ) const


description: Clear the active text selection

code: void ClearSelection()


description:
Note thatComputeDesiredSize()is meant as an aide to the developer. It is NOT meant to be very robust in many cases. If your widget is simulating a bouncing ball, you should just return a reasonable size; e.g. 160x160. Let the programmer set up a reasonable rule of resizing the bouncy ball simulation.
The desired size.

code: virtual FVector2D ComputeDesiredSize ( float LayoutScaleMultiplier ) const


description: Recomputes the volatility of the widget. If you have additional state you automatically want to make the widget volatile, you should sample that information here.

code: virtual bool ComputeVolatility() const


code: void Construct ( const [FArguments](API\Runtime\Slate\Widgets\Text\SMultiLineEditableText\FArguments) & InArgs )


description: Delete any currently selected text

code: void DeleteSelectedText()


description: Called to end an undoable editable text transaction, marked as protected for use withFScopedEditableTextTransactiononly

code: void EndEditTransaction()


description: Whether to prevent the context menu from being displayed

code: WidgetArgsType & AllowContextMenu &40; const TAttribute< bool > & InAttribute &41;


description: Ensure that we will get aTick()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

code: virtual void EnsureActiveTick()


description: Whether to allow multi-line text

code: WidgetArgsType & AllowMultiLine &40; const TAttribute< bool > & InAttribute &41;


description: Whether to clear keyboard focus when pressing enter to commit changes

code: WidgetArgsType & ClearKeyboardFocusOnCommit &40; const TAttribute< bool > & InAttribute &41;


description: Whether to wrap text automatically based on the widget's computed horizontal space. IMPORTANT: Using automatic wrapping can result in visual artifacts, as the the wrapped size will computed be at least one frame late! Consider using WrapTextAt instead. The initial desired size will not be clamped. This works best in cases where the text block's size is not affecting other widget's layout.

code: WidgetArgsType & AutoWrapText &40; const TAttribute< bool > & InAttribute &41;


description: Menu extender for the right-click context menu

code: WidgetArgsType & ContextMenuExtender &40; const FMenuExtensionDelegate & InDelegate &41;


description: Whether to clear text selection when focus is lost

code: WidgetArgsType & ClearTextSelectionOnFocusLoss &40; const TAttribute< bool > & InAttribute &41;


description: Font color and opacity (overrides Style)

code: WidgetArgsType & Font &40; const TAttribute< FSlateFontInfo > & InAttribute &41;


description: Hint text that appears when there is no text in the text box

code: WidgetArgsType & HintText &40; const TAttribute< FText > & InAttribute &41;


description: Delegate used to create text layouts for this widget. If none is provided thenFSlateTextLayoutwill be used.

code: WidgetArgsType & CreateSlateTextLayout &40; const FCreateSlateTextLayout & InDelegate &41;


description: The horizontal scroll bar widget

code: WidgetArgsType & HScrollBar &40; TSharedPtr< SScrollBar > InArg &41;


description: How the text should be aligned with the margin.

code: WidgetArgsType & Justification &40; const TAttribute< ETextJustify::Type > & InAttribute &41;


description: Sets whether this text box can actually be modified interactively by the user

code: WidgetArgsType & IsReadOnly &40; const TAttribute< bool > & InAttribute &41;


description: The amount of blank space left around the edges of text area.

code: WidgetArgsType & Margin &40; const TAttribute< FMargin > & InAttribute &41;


description: The amount to scale each lines height by.

code: WidgetArgsType & LineHeightPercentage &40; const TAttribute< float > & InAttribute &41;


description: Delegate to call before a context menu is opened. User returns the menu content or null to the disable context menu

code: WidgetArgsType & OnContextMenuOpening &40; const FOnContextMenuOpening & InDelegate &41;


description: The marshaller used to get/set the raw text to/from the text layout.

code: WidgetArgsType & Marshaller &40; TSharedPtr< ITextLayoutMarshaller > InArg &41;


description: The optional modifier key necessary to create a newline when typing into the editor.

code: WidgetArgsType & ModiferKeyForNewLine &40; EModifierKey::Type InArg &41;


description: Called when the cursor is moved within the text area

code: WidgetArgsType & OnCursorMoved &40; const FOnCursorMoved & InDelegate &41;


description: Called whenever the horizontal scrollbar is moved by the user

code: WidgetArgsType & OnHScrollBarUserScrolled &40; const FOnUserScrolled & InDelegate &41;


description: Called whenever a character is typed. Not called for copy, paste, or any other text changes!

code: WidgetArgsType & OnIsTypedCharValid &40; const FOnIsTypedCharValid & InDelegate &41;


description: Callback delegate to have first chance handling of the OnKeyChar event

code: WidgetArgsType & OnKeyCharHandler &40; const FOnKeyChar & InDelegate &41;


description: Callback delegate to have first chance handling of the OnKeyDown event

code: WidgetArgsType & OnKeyDownHandler &40; const FOnKeyDown & InDelegate &41;


description: Called whenever the vertical scrollbar is moved by the user

code: WidgetArgsType & OnVScrollBarUserScrolled &40; const FOnUserScrolled & InDelegate &41;


description: Called whenever the text is committed. This happens when the user presses enter or the text box loses focus.

code: WidgetArgsType & OnTextCommitted &40; const FOnTextCommitted & InDelegate &41;


description: Determines what happens to text that is clipped and doesnt fit within the clip rect for this widget

code: WidgetArgsType & OverflowPolicy &40; TOptional< ETextOverflowPolicy > InArg &41;


description: Called whenever the text is changed programmatically or interactively by the user

code: WidgetArgsType & OnTextChanged &40; const FOnTextChanged & InDelegate &41;


description: Text to search for (a new search is triggered whenever this text changes)

code: WidgetArgsType & SearchText &40; const TAttribute< FText > & InAttribute &41;


description: Whether to select all text when the user clicks to give focus on the widget

code: WidgetArgsType & SelectAllTextWhenFocused &40; const TAttribute< bool > & InAttribute &41;


description: Whether to select word on mouse double click on the widget

code: WidgetArgsType & SelectWordOnMouseDoubleClick &40; const TAttribute< bool > & InAttribute &41;


description: The initial text that will appear in the widget.

code: WidgetArgsType & Text &40; const TAttribute< FText > & InAttribute &41;


description: Which text flow direction should we use? (unset to use the default returned by GetDefaultTextFlowDirection)

code: WidgetArgsType & TextFlowDirection &40; TOptional< ETextFlowDirection > InArg &41;


description: Which text shaping method should we use? (unset to use the default returned by GetDefaultTextShapingMethod)

code: WidgetArgsType & TextShapingMethod &40; TOptional< ETextShapingMethod > InArg &41;


description: Pointer to a style of the text block, which dictates the font, color, and shadow options.

code: WidgetArgsType & TextStyle &40; const FTextBlockStyle &42; InArg &41;


description: Whether to allow the user to back out of changes when they press the escape key

code: WidgetArgsType & RevertTextOnEscape &40; const TAttribute< bool > & InAttribute &41;


description: The message action to take when the virtual keyboard is dismissed by the user

code: WidgetArgsType & VirtualKeyboardDismissAction &40; const TAttribute< EVirtualKeyboardDismissAction > & InAttribute &41;


description: Additional options for the virtual keyboard used by this widget

code: WidgetArgsType & VirtualKeyboardOptions &40; FVirtualKeyboardOptions InArg &41;


description: The type of event that will trigger the display of the virtual keyboard

code: WidgetArgsType & VirtualKeyboardTrigger &40; const TAttribute< EVirtualKeyboardTrigger > & InAttribute &41;


description: The vertical scroll bar widget

code: WidgetArgsType & VScrollBar &40; TSharedPtr< SScrollBar > InArg &41;


code: typedef FArguments WidgetArgsType


description: The wrapping policy to use

code: WidgetArgsType & WrappingPolicy &40; const TAttribute< ETextWrappingPolicy > & InAttribute &41;


className: FOnCursorMoved

description: Called when the cursor is moved within the text area

code: typedef TBaseDelegate_OneParam< void, const [FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) & > FOnCursorMoved


code: struct FArguments : public [TSlateBaseNamedArgs< SMultiLineEditableText >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)


description: Whether text wraps onto a new line when it's length exceeds this width; if this value is zero or negative, no wrapping occurs.

code: WidgetArgsType & WrapTextAt &40; const TAttribute< float > & InAttribute &41;


description: Force a single scroll operation.

code: void ForceScroll ( int32 UserIndex, float ScrollAxisMagnitude )


code: FScopedEditableTextTransaction &40; TSharedPtr< SMultiLineEditableText > InText &41;


className: FScopedEditableTextTransaction

description: Used to merge multiple text edit transactions within a scope

code: struct FScopedEditableTextTransaction


description: Get the character at Location

code: TCHAR GetCharacterAt ( const [FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) & Location ) const


description: Fill OutTextLine with the text line where the current cursor location is at

code: void GetCurrentTextLine ( [FString](API\Runtime\Core\Containers\FString) & OutTextLine ) const


description: Get the interaction position of the cursor (where to insert, delete, etc, text from/to)


description: Should be renamed to GetVisibleChildren (not ALL children will be returned in all cases).

code: virtual [FChildren](API\Runtime\SlateCore\Layout\FChildren) * GetChildren()


description: Get the text that appears when there is no text in the text box


description: Get the horizontal scroll bar widget

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [SScrollBar](API\Runtime\Slate\Widgets\Layout\SScrollBar) > GetHScrollBar() const


description: Get the total number of search results (0 if none)

code: int32 GetNumSearchResults() const


description: Get the run currently under the cursor, or null if there is no run currently under the cursor

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [IRun](API\Runtime\Slate\Framework\Text\IRun) > GetRunUnderCursor() const


description:
Returns the plain text string without richtext formatting
Text string


description: Get the index of the search result (0 if none)

code: int32 GetSearchResultIndex() const


description: Get the text that is currently being searched for (if any)


description: Get the runs currently that are current selected, some of which may be only partially selected

code: [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< const [IRun](API\Runtime\Slate\Framework\Text\IRun) > > GetSelectedRuns() const


description: Get the currently selected text


description: Get the Slate widget this interface is representing (may not be called during destruction)

code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GetSlateWidget()


description: Get the current selection


description:
Returns the text string
Text string


description: Get the Slate widget this interface is representing (may be null during destruction)

code: virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > GetSlateWidgetPtr()


description: Fill OutTextLine with the text line at the specified index

code: void GetTextLine ( const int32 InLineIndex, [FString](API\Runtime\Core\Containers\FString) & OutTextLine ) const


description: Get the number of Text Lines

code: int32 GetTextLineCount()


description: Get the options for the virtual keyboard used for this widget


description: Get the message action to take when the virtual keyboard is dismissed by the user

code: virtual EVirtualKeyboardDismissAction GetVirtualKeyboardDismissAction() const


description: Get the type of event that will trigger the display of the virtual keyboard

code: virtual EVirtualKeyboardTrigger GetVirtualKeyboardTrigger() const


description: Get the type of virtual keyboard to use for this widget

code: virtual EKeyboardType GetVirtualKeyboardType() const


description: Get the vertical scroll bar widget

code: [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< const [SScrollBar](API\Runtime\Slate\Widgets\Layout\SScrollBar) > GetVScrollBar() const


description: Move the cursor to the given location in the document (will also scroll to this point)

code: void GoTo ( const [FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) & NewLocation )


description: Move the cursor specified location

code: void GoTo ( const ETextLocation NewLocation )


description: Insert the given run at the current cursor position

code: void InsertRunAtCursor ( [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [IRun](API\Runtime\Slate\Framework\Text\IRun) > InRun )


description: Insert the given text at the current cursor position, correctly taking into account new line characters

code: void InsertTextAtCursor ( const [FText](API\Runtime\Core\Internationalization\FText) & InText )


code: void InsertTextAtCursor ( const [FString](API\Runtime\Core\Containers\FString) & InString )


description: Is this widget interactive or not? Defaults to false

code: virtual bool IsInteractable() const


description: Is the text displaying a password and should be obscured?

code: virtual bool IsTextPassword() const


description: Return whether a RMB+Drag scroll operation is taking place

code: bool IsRightClickScrolling() const


description: Is the text currently read-only?

code: virtual bool IsTextReadOnly() const


description: Is the text edit multi-line aware?

code: virtual bool IsMultiLineTextEdit() const


description: Compute the Geometry of all the children and add populate the ArrangedChildren list with their values. Each type of Layout panel should arrange children based on desired behavior.

code: virtual void OnArrangeChildren ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, [FArrangedChildren](API\Runtime\SlateCore\Layout\FArrangedChildren) & ArrangedChildren ) const


description: The system asks each widget under the mouse to provide a cursor. This event is bubbled.FCursorReply::Unhandled()if the event is not handled; returnFCursorReply::Cursor()otherwise.

code: virtual [FCursorReply](API\Runtime\SlateCore\Input\FCursorReply) OnCursorQuery ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & CursorEvent ) const


description: Called when the cursor is moved within the text area

code: virtual void OnCursorMoved ( const [FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) & InLocation )


description: Called when this widget loses focus. This event does not bubble.

code: virtual void OnFocusLost ( const [FFocusEvent](API\Runtime\SlateCore\Input\FFocusEvent) & InFocusEvent )


code: void OnHScrollBarMoved ( const float InScrollOffsetFraction )


description:
KEY INPUT Called when focus is given to this widget. This event does not bubble.
Returns whether the event was handled, along with other possible actions

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnFocusReceived ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FFocusEvent](API\Runtime\SlateCore\Input\FFocusEvent) & InFocusEvent )


description:
Called after a character is entered while this widget has keyboard focus
Returns whether the event was handled, along with other possible actions

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnKeyChar ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FCharacterEvent](API\Runtime\SlateCore\Input\FCharacterEvent) & InCharacterEvent )


description:
Called after a key is pressed when this widget has focus (this event bubbles if not handled)
Returns whether the event was handled, along with other possible actions

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnKeyDown ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & InKeyEvent )


description:
Called after a key is released when this widget has focus
Returns whether the event was handled, along with other possible actions

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnKeyUp ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FKeyEvent](API\Runtime\SlateCore\Input\FKeyEvent) & InKeyEvent )


description:
MOUSE INPUT The system calls this method to notify the widget that a mouse button was pressed within it. This event is bubbled.
Whether the event was handled along with possible requests for the system to take action.

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonDown ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


description:
Called when a mouse button is double clicked. Override this in derived classes.
Returns whether the event was handled, along with other possible actions

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonDoubleClick ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & InMyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & InMouseEvent )


description:
The system calls this method to notify the widget that a mouse button was release within it. This event is bubbled.
Whether the event was handled along with possible requests for the system to take action.

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonUp ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


description:
Called when the mouse wheel is spun. This event is bubbled.
Returns whether the event was handled, along with other possible actions

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseWheel ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


description:
The system calls this method to notify the widget that a mouse moved within it. This event is bubbled.
Whether the event was handled along with possible requests for the system to take action.

code: virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseMove ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )


description:
The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children. Called by the non-virtual OnPaint to enforce pre/post conditions during OnPaint.
The maximum layer ID attained by this widget or any of its children.

code: virtual int32 OnPaint ( const [FPaintArgs](API\Runtime\SlateCore\Types\FPaintArgs) & Args, const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, const [FSlateRect](API\Runtime\SlateCore\Layout\FSlateRect) & MyCullingRect, [FSlateWindowElementList](API\Runtime\SlateCore\Rendering\FSlateWindowElementList) & OutDrawElements, int32 LayerId, const [FWidgetStyle](API\Runtime\SlateCore\Styling\FWidgetStyle) & InWidgetStyle, bool bParentEnabled ) const


code: void OnVScrollBarMoved ( const float InScrollOffsetFraction )


description: Called when the text control has committed its current edit changes

code: virtual void OnTextCommitted ( const [FText](API\Runtime\Core\Internationalization\FText) & InText, const [ETextCommit::Type](API\Runtime\SlateCore\Types\ETextCommit__Type) InTextAction )


description: Called when the text has been changed by an edit operation

code: virtual void OnTextChanged ( const [FText](API\Runtime\Core\Internationalization\FText) & InText )


description: Refresh this editable text immediately, rather than wait for the usual caching mechanisms to take affect on the text Tick

code: void Refresh()


description: Scroll to the given location in the document (without moving the cursor)

code: void ScrollTo ( const [FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) & NewLocation )


code: void ScrollTo ( const ETextLocation NewLocation )


description: Select a block of text

code: void SelectText ( const [FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) & InSelectionStart, const [FTextLocation](API\Runtime\Slate\Framework\Text\FTextLocation) & InCursorLocation )


description: Select all the text in the document

code: void SelectAllText()


description: See the AllowContextMenu attribute

code: void SetAllowContextMenu ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< bool > & InAllowContextMenu )


description: See AutoWrapText attribute

code: void SetAutoWrapText ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< bool > & InAutoWrapText )


description: Sets whether to clear keyboard focus when pressing enter to commit changes

code: void SetClearKeyboardFocusOnCommit ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< bool > & InClearKeyboardFocusOnCommit )


description: Sets whether to clear text selection when focus is lost

code: void SetClearTextSelectionOnFocusLoss ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< bool > & InClearTextSelectionOnFocusLoss )


description: Sets the text that appears when there is no text in the text box

code: void SetHintText ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InHintText )


description: See attribute Font

code: void SetFont ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FSlateFontInfo](API\Runtime\SlateCore\Fonts\FSlateFontInfo) > & InNewFont )


description: Sets the ReadOnly attribute

code: void SetIsReadOnly ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< bool > & InIsReadOnly )


description: See Justification attribute

code: void SetJustification ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [ETextJustify::Type](API\Runtime\Slate\Framework\Text\ETextJustify__Type) > & InJustification )


description: See LineHeightPercentage attribute

code: void SetLineHeightPercentage ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< float > & InLineHeightPercentage )


description: Sets the OnKeyCharHandler to provide first chance handling of the OnKeyChar event

code: void SetOnKeyCharHandler ( FOnKeyChar InOnKeyCharHandler )


description: Sets the OnKeyDownHandler to provide first chance handling of the OnKeyDown event

code: void SetOnKeyDownHandler ( FOnKeyDown InOnKeyDownHandler )


description: See Margin attribute

code: void SetMargin ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FMargin](API\Runtime\SlateCore\Layout\FMargin) > & InMargin )


description: Sets whether to allow the user to back out of changes when they press the escape key

code: void SetRevertTextOnEscape ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< bool > & InRevertTextOnEscape )


description: Sets whether to select all text when the user clicks to give focus on the widget

code: void SetSelectAllTextWhenFocused ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< bool > & InSelectAllTextWhenFocused )


description: Sets the overflow policy for this text block

code: void SetOverflowPolicy ( [TOptional](API\Runtime\Core\IO\TOptional)< ETextOverflowPolicy > InOverflowPolicy )


description: Set the text that is currently being searched for (if any)

code: void SetSearchText ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InSearchText )


description: Sets whether to select word on the mouse double click

code: void SetSelectWordOnMouseDoubleClick ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< bool > & InSelectWordOnMouseDoubleClick )


description: Sets the text for this text block

code: void SetText ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InText )


description: See TextFlowDirection attribute

code: void SetTextFlowDirection ( const [TOptional](API\Runtime\Core\IO\TOptional)< ETextFlowDirection > & InTextFlowDirection )


description: Set the VirtualKeyboardDismissAction attribute

code: void SetVirtualKeyboardDismissAction ( [TAttribute](API\Runtime\Core\Misc\TAttribute)< EVirtualKeyboardDismissAction > InVirtualKeyboardDismissAction )


description: See attribute TextStyle

code: void SetTextStyle ( const [FTextBlockStyle](API\Runtime\SlateCore\Styling\FTextBlockStyle) * InTextStyle )


description: See TextShapingMethod attribute

code: void SetTextShapingMethod ( const [TOptional](API\Runtime\Core\IO\TOptional)< ETextShapingMethod > & InTextShapingMethod )


description: See WrapTextAt attribute

code: void SetWrapTextAt ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< float > & InWrapTextAt )


description: Should we clear the keyboard focus when the user commits text to this widget?

code: virtual bool ShouldClearKeyboardFocusOnCommit() const


description: Set WrappingPolicy attribute

code: void SetWrappingPolicy ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< ETextWrappingPolicy > & InWrappingPolicy )


description: Should the text clear its selection the widget loses focus?

code: virtual bool ShouldClearTextSelectionOnFocusLoss() const


description: Should the cursor be jumped to the end of the document when the widget gains focus?

code: virtual bool ShouldJumpCursorToEndWhenFocused() const


description: Should we revert the text back to its original state when the user presses escape?

code: virtual bool ShouldRevertTextOnEscape() const


description: Should the text be selected when the widget gains focus?

code: virtual bool ShouldSelectAllTextWhenFocused() const


description: Should we select all text when the user commits text to this widget?

code: virtual bool ShouldSelectAllTextOnCommit() const


description: Should we select word on mouse double click?

code: virtual bool ShouldSelectWordOnMouseDoubleClick() const


description:
Checks to see if this widget supports keyboard focus. Override this in derived classes.
True if this widget can take keyboard focus

code: virtual bool SupportsKeyboardFocus() const


description: Ticks this widget with Geometry. Override in derived classes, but always call the parent implementation.

code: virtual void Tick ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, const double InCurrentTime, const float InDeltaTime )


description: Called when the fraction and offset of the horizontal scroll area has been recalculated. This function should apply the new values to any scrollbars, and return a clamped horizontal scroll value

code: virtual float UpdateAndClampHorizontalScrollBar ( const float InViewOffset, const float InViewFraction, const [EVisibility](API\Runtime\SlateCore\Layout\EVisibility) InVisiblityOverride )


description: Called when the fraction and offset of the vertical scroll area has been recalculated. This function should apply the new values to any scrollbars, and return a clamped vertical scroll value

code: virtual float UpdateAndClampVerticalScrollBar ( const float InViewOffset, const float InViewFraction, const [EVisibility](API\Runtime\SlateCore\Layout\EVisibility) InVisiblityOverride )


description:
Note thatComputeDesiredSize()is meant as an aide to the developer. It is NOT meant to be very robust in many cases. If your widget is simulating a bouncing ball, you should just return a reasonable size; e.g. 160x160. Let the programmer set up a reasonable rule of resizing the bouncy ball simulation.
The desired size.

code: virtual FVector2D ComputeDesiredSize ( float LayoutScaleMultiplier ) const


className: SMultiLineEditableText

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

code: class SMultiLineEditableText : public [SWidget](API\Runtime\SlateCore\Widgets\SWidget), public [ISlateEditableTextWidget](API\Runtime\Slate\Widgets\Text\ISlateEditableTextWidget)

ActiveTickTimer

type: TWeakPtr< FActi...

description: The timer that is actively driving this widget toTick()even when Slate is idle

AmountScrolledWhileRightMouseDown

type: float

description: How much we scrolled while RMB was being held

bAllowContextMenu

description: Whether the context menu can be opened

bAllowMultiLine

description: Whether to allow multi-line text

bClearKeyboardFocusOnCommit

description: True if we want the text control to lose focus on an text commit/revert events

bClearTextSelectionOnFocusLoss

description: Whether to clear text selection when focus is lost

bIsReadOnly

description: Sets whether this text box can actually be modified interactively by the user

bIsSoftwareCursor

type: bool

description: Whether a software cursor is currently active

bRevertTextOnEscape

description: True if any changes should be reverted if we receive an escape key

bSelectAllTextWhenFocused

description: Whether to select all text when the user clicks to give focus on the widget

bSelectWordOnMouseDoubleClick

description: Whether to select work on mouse double click

EditableTextLayout

type: TUniquePtr<FSl...

description: The text layout that deals with the editable text

HScrollBar

type: TSharedPtr<SSc...

description: The horizontal scroll bar widget

MenuExtender

type: TSharedPtr<FEx...

description: Menu extender for right-click context menu

ModiferKeyForNewLine

description: The optional modifier key necessary to create a newline when typing into the editor.

OnContextMenuOpening

type: FOnContextMenuO...

description: Delegate to call before a context menu is opened

OnCursorMovedCallback

type: FOnCursorMoved

description: Called when the cursor is moved within the text area

OnHScrollBarUserScrolled

type: FOnUserScrolled

description: Called whenever the horizontal scrollbar is moved by the user

OnIsTypedCharValid

type: FOnIsTypedCharV...

description: Called when a character is typed and we want to know if the text field supports typing this character.

OnKeyCharHandler

type: FOnKeyChar

description: Callback delegate to have first chance handling of the OnKeyChar event

OnKeyDownHandler

type: FOnKeyDown

description: Callback delegate to have first chance handling of the OnKeyDown event

OnTextChangedCallback

type: FOnTextChanged

description: Called whenever the text is changed programmatically or interactively by the user

OnTextCommittedCallback

description: Called whenever the text is committed.

OnVScrollBarUserScrolled

description: Called whenever the vertical scrollbar is moved by the user

SoftwareCursorPosition

description: The current position of the software cursor

VirtualKeyboardDismissAction

type: TAttribute< EVi...

description: The message action to take when the virtual keyboard is dismissed by the user

VirtualKeyboardOptions

type: FVirtualKeyboar...

description: Options to use for the virtual keyboard summoned by this widget

VirtualKeyboardTrigger

description: The type of event that will trigger the display of the virtual keyboard

VScrollBar

description: The vertical scroll bar widget


description: Recomputes the volatility of the widget. If you have additional state you automatically want to make the widget volatile, you should sample that information here.

code: virtual bool ComputeVolatility() const


code: void Construct ( const [FArguments](API\Runtime\Slate\Widgets\Text\SRichTextBlock\FArguments) & InArgs )


code: static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ITextDecorator](API\Runtime\Slate\Framework\Text\ITextDecorator) > Decorator ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ITextDecorator](API\Runtime\Slate\Framework\Text\ITextDecorator) > & Decorator )


description: Whether to wrap text automatically based on the widget's computed horizontal space. IMPORTANT: Using automatic wrapping can result in visual artifacts, as the the wrapped size will computed be at least one frame late! Consider using WrapTextAt instead. The initial desired size will not be clamped. This works best in cases where the text block's size is not affecting other widget's layout.

code: WidgetArgsType & AutoWrapText &40; const TAttribute< bool > & InAttribute &41;


description: How the text should be aligned with the margin.

code: WidgetArgsType & Justification &40; const TAttribute< ETextJustify::Type > & InAttribute &41;


description: Highlight this text in the text block

code: WidgetArgsType & HighlightText &40; const TAttribute< FText > & InAttribute &41;


description: Delegate used to create text layouts for this widget. If none is provided thenFSlateTextLayoutwill be used.

code: WidgetArgsType & CreateSlateTextLayout &40; const FCreateSlateTextLayout & InDelegate &41;


description: Any decorators that should be used while parsing the text.

code: WidgetArgsType & Decorators &40; TArray< TSharedRef< class ITextDecorator > > InArg &41;


description: The style set used for looking up styles used by decorators

code: WidgetArgsType & DecoratorStyleSet &40; const ISlateStyle &42; InArg &41;


description: The amount to scale each lines height by.

code: WidgetArgsType & LineHeightPercentage &40; const TAttribute< float > & InAttribute &41;


description: The marshaller used to get/set the raw text to/from the text layout.

code: WidgetArgsType & Marshaller &40; TSharedPtr< class FRichTextLayoutMarshaller > InArg &41;


description: The amount of blank space left around the edges of text area.

code: WidgetArgsType & Margin &40; const TAttribute< FMargin > & InAttribute &41;


description: Minimum width that this text block should be

code: WidgetArgsType & MinDesiredWidth &40; const TAttribute< float > & InAttribute &41;


code: SRichTextBlock::FArguments & operator&43; &40; const TSharedRef< ITextDecorator > & DecoratorToAdd &41;


description: Determines what happens to text that is clipped and doesn't fit within the clip rect for this widget

code: WidgetArgsType & OverflowPolicy &40; TOptional< ETextOverflowPolicy > InArg &41;


description: The parser used to resolve any markup used in the provided string.

code: WidgetArgsType & Parser &40; TSharedPtr< class IRichTextMarkupParser > InArg &41;


description: The text displayed in this text block

code: WidgetArgsType & Text &40; const TAttribute< FText > & InAttribute &41;


description: Which text flow direction should we use? (unset to use the default returned by GetDefaultTextFlowDirection)

code: WidgetArgsType & TextFlowDirection &40; TOptional< ETextFlowDirection > InArg &41;


description: Which text shaping method should we use? (unset to use the default returned by GetDefaultTextShapingMethod)

code: WidgetArgsType & TextShapingMethod &40; TOptional< ETextShapingMethod > InArg &41;


description: The style of the text block, which dictates the default font, color, and shadow options.

code: WidgetArgsType & TextStyle &40; const FTextBlockStyle &42; InArg &41;


description: The transform policy to use

code: WidgetArgsType & TransformPolicy &40; const TAttribute< ETextTransformPolicy > & InAttribute &41;


code: typedef FArguments WidgetArgsType


description: The wrapping policy to use

code: WidgetArgsType & WrappingPolicy &40; const TAttribute< ETextWrappingPolicy > & InAttribute &41;


description: Whether text wraps onto a new line when it's length exceeds this width; if this value is zero or negative, no wrapping occurs.

code: WidgetArgsType & WrapTextAt &40; const TAttribute< float > & InAttribute &41;


code: struct FArguments : public [TSlateBaseNamedArgs< SRichTextBlock >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)

InlineDecorators

type: TArray<TShared...

description: Additional decorators can be append to the widget inline.


description: Should be renamed to GetVisibleChildren (not ALL children will be returned in all cases).

code: virtual [FChildren](API\Runtime\SlateCore\Layout\FChildren) * GetChildren()


description: Gets the text assigned to this text block

code: const [FText](API\Runtime\Core\Internationalization\FText) & GetText() const


code: static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ITextDecorator](API\Runtime\Slate\Framework\Text\ITextDecorator) > HyperlinkDecorator ( const [FString](API\Runtime\Core\Containers\FString) Id, const [FSlateHyperlinkRun::FOnClick](API\Runtime\Slate\Framework\Text\FSlateHyperlinkRun\FOnClick) & NavigateDelegate )


code: template<class UserClass> static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ITextDecorator](API\Runtime\Slate\Framework\Text\ITextDecorator) > HyperlinkDecorator ( const [FString](API\Runtime\Core\Containers\FString) Id, UserClass * InUserObjectPtr, typename FSlateHyperlinkRun::FOnClick::TMethodPtr< UserClass > NavigateFunc )


description: Compute the Geometry of all the children and add populate the ArrangedChildren list with their values. Each type of Layout panel should arrange children based on desired behavior.

code: virtual void OnArrangeChildren ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, [FArrangedChildren](API\Runtime\SlateCore\Layout\FArrangedChildren) & ArrangedChildren ) const


description:
The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children. Called by the non-virtual OnPaint to enforce pre/post conditions during OnPaint.
The maximum layer ID attained by this widget or any of its children.

code: virtual int32 OnPaint ( const [FPaintArgs](API\Runtime\SlateCore\Types\FPaintArgs) & Args, const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, const [FSlateRect](API\Runtime\SlateCore\Layout\FSlateRect) & MyCullingRect, [FSlateWindowElementList](API\Runtime\SlateCore\Rendering\FSlateWindowElementList) & OutDrawElements, int32 LayerId, const [FWidgetStyle](API\Runtime\SlateCore\Styling\FWidgetStyle) & InWidgetStyle, bool bParentEnabled ) const


code: static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ITextDecorator](API\Runtime\Slate\Framework\Text\ITextDecorator) > ImageDecorator ( [FString](API\Runtime\Core\Containers\FString) RunName, const [ISlateStyle](API\Runtime\SlateCore\Styling\ISlateStyle) *const OverrideStyle )


description: Causes the text to reflow it's layout

code: void Refresh()


description: See AutoWrapText attribute

code: void SetAutoWrapText ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< bool > & InAutoWrapText )


description: Replaces the decorators for this text block

code: void SetDecorators ( [TArrayView](API\Runtime\Core\Containers\TArrayView)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ITextDecorator](API\Runtime\Slate\Framework\Text\ITextDecorator) >> InDecorators )


code: void SetDecoratorStyleSet ( const [ISlateStyle](API\Runtime\SlateCore\Styling\ISlateStyle) * NewDecoratorStyleSet )


description: See HighlightText attribute

code: void SetHighlightText ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InHighlightText )


description: See Justification attribute

code: void SetJustification ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [ETextJustify::Type](API\Runtime\Slate\Framework\Text\ETextJustify__Type) > & InJustification )


description: See Margin attribute

code: void SetMargin ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FMargin](API\Runtime\SlateCore\Layout\FMargin) > & InMargin )


description: See LineHeightPercentage attribute

code: void SetLineHeightPercentage ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< float > & InLineHeightPercentage )


description: See MinDesiredWidth attribute

code: void SetMinDesiredWidth ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< float > & InMinDesiredWidth )


description: Sets the overflow policy for this text block

code: void SetOverflowPolicy ( [TOptional](API\Runtime\Core\IO\TOptional)< ETextOverflowPolicy > InOverflowPolicy )


description: See TextFlowDirection attribute

code: void SetTextFlowDirection ( const [TOptional](API\Runtime\Core\IO\TOptional)< ETextFlowDirection > & InTextFlowDirection )


description: Set the scale value at the TextLayout

code: void SetTextBlockScale ( const float NewTextBlockScale )


description: Sets the text for this text block

code: void SetText ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< [FText](API\Runtime\Core\Internationalization\FText) > & InTextAttr )


description: See TextShapingMethod attribute

code: void SetTextShapingMethod ( const [TOptional](API\Runtime\Core\IO\TOptional)< ETextShapingMethod > & InTextShapingMethod )


description: Set TransformPolicy attribute

code: void SetTransformPolicy ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< ETextTransformPolicy > & InTransformPolicy )


description: See TextStyle argument

code: void SetTextStyle ( const [FTextBlockStyle](API\Runtime\SlateCore\Styling\FTextBlockStyle) & InTextStyle )


description: Set WrappingPolicy attribute

code: void SetWrappingPolicy ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< ETextWrappingPolicy > & InWrappingPolicy )


description: See WrapTextAt attribute

code: void SetWrapTextAt ( const [TAttribute](API\Runtime\Core\Misc\TAttribute)< float > & InWrapTextAt )


code: static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ITextDecorator](API\Runtime\Slate\Framework\Text\ITextDecorator) > WidgetDecorator ( const [FString](API\Runtime\Core\Containers\FString) RunName, const [FWidgetDecorator::FCreateWidget](API\Runtime\Slate\Framework\Text\FWidgetDecorator\FCreateWidget) & FactoryDelegate )


code: template<class UserClass> static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [ITextDecorator](API\Runtime\Slate\Framework\Text\ITextDecorator) > WidgetDecorator ( const [FString](API\Runtime\Core\Containers\FString) RunName, UserClass * InUserObjectPtr, typename FWidgetDecorator::FCreateWidget::TConstMethodPtr< UserClass > InFunc )


description: Constructor

code: SRichTextBlock()


className: SRichTextBlock

description: A rich static text widget. Through the use of markup and text decorators, text with different styles, embedded image and widgets can be achieved.

code: class SRichTextBlock : public [SWidget](API\Runtime\SlateCore\Widgets\SWidget)


description: LeafWidgets should compute their DesiredSize based solely on their visual representation. There is no need to take child widgets into account as LeafWidgets have none by definition. For example, the TextBlock widget simply measures the area necessary to display its text with the given font and font size.

code: virtual FVector2D ComputeDesiredSize ( float ) const


description: Destructor

code: ~SRichTextBlock()


description: Construct this widget

code: void Construct ( const [FArguments](API\Runtime\Slate\Widgets\Text\STextBlock\FArguments) & InArgs )


code: virtual [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< FSlateAccessibleWidget > CreateAccessibleWidget()


description: Text color and opacity

code: WidgetArgsType & ColorAndOpacity &40; const TAttribute< FSlateColor > & InAttribute &41;


description: Whether to wrap text automatically based on the widget's computed horizontal space. IMPORTANT: Using automatic wrapping can result in visual artifacts, as the the wrapped size will computed be at least one frame late! Consider using WrapTextAt instead. The initial desired size will not be clamped. This works best in cases where the text block's size is not affecting other widget's layout.

code: WidgetArgsType & AutoWrapText &40; const TAttribute< bool > & InAttribute &41;


description: The color used to highlight the specified text

code: WidgetArgsType & HighlightColor &40; const TAttribute< FLinearColor > & InAttribute &41;


description: Sets the font used to draw the text

code: WidgetArgsType & Font &40; const TAttribute< FSlateFontInfo > & InAttribute &41;


description: The brush used to highlight the specified text

code: WidgetArgsType & HighlightShape &40; const TAttribute< const FSlateBrush &42; > & InAttribute &41;


description: Highlight this text in the text block

code: WidgetArgsType & HighlightText &40; const TAttribute< FText > & InAttribute &41;


description: How the text should be aligned with the margin.

code: WidgetArgsType & Justification &40; const TAttribute< ETextJustify::Type > & InAttribute &41;


description: The iterator to use to detect appropriate soft-wrapping points for lines (or null to use the default)

code: WidgetArgsType & LineBreakPolicy &40; TSharedPtr< IBreakIterator > InArg &41;


description: The amount of blank space left around the edges of text area.

code: WidgetArgsType & Margin &40; const TAttribute< FMargin > & InAttribute &41;


description: The amount to scale each lines height by.

code: WidgetArgsType & LineHeightPercentage &40; const TAttribute< float > & InAttribute &41;


description: Minimum width that a text block should be

code: WidgetArgsType & MinDesiredWidth &40; const TAttribute< float > & InAttribute &41;


description: Called when this text is double clicked

code: WidgetArgsType & OnDoubleClicked &40; const FPointerEventHandler & InDelegate &41;


description: Drop shadow offset in pixels

code: WidgetArgsType & ShadowOffset &40; const TAttribute< FVector2D > & InAttribute &41;


description: Determines what happens to text that is clipped and doesn't fit within the clip rect for this widget

code: WidgetArgsType & OverflowPolicy &40; TOptional< ETextOverflowPolicy > InArg &41;


description: Shadow color and opacity

code: WidgetArgsType & ShadowColorAndOpacity &40; const TAttribute< FLinearColor > & InAttribute &41;


description: Sets the brush used to strike through the text

code: WidgetArgsType & StrikeBrush &40; const TAttribute< const FSlateBrush &42; > & InAttribute &41;


description: If this is enabled, text shaping, wrapping, justification are disabled in favor of much faster text layout and measurement. This feature is suitable for numbers and text that changes often and impact performance. Enabling this setting may cause certain languages (such as Right to left languages) to not display properly.

code: WidgetArgsType & SimpleTextMode &40; bool InArg &41;


description: Which text flow direction should we use? (unset to use the default returned by GetDefaultTextFlowDirection)

code: WidgetArgsType & TextFlowDirection &40; TOptional< ETextFlowDirection > InArg &41;


description: Which text shaping method should we use? (unset to use the default returned by GetDefaultTextShapingMethod)

code: WidgetArgsType & TextShapingMethod &40; TOptional< ETextShapingMethod > InArg &41;


description: The text displayed in this text block

code: WidgetArgsType & Text &40; const TAttribute< FText > & InAttribute &41;


description: Pointer to a style of the text block, which dictates the font, color, and shadow options.

code: WidgetArgsType & TextStyle &40; const FTextBlockStyle &42; InArg &41;


description: The transform policy to use

code: WidgetArgsType & TransformPolicy &40; const TAttribute< ETextTransformPolicy > & InAttribute &41;


code: typedef FArguments WidgetArgsType


description: The wrapping policy to use

code: WidgetArgsType & WrappingPolicy &40; const TAttribute< ETextWrappingPolicy > & InAttribute &41;