1. Epic GamesDeveloper
  3. FSlateEditableTextLayout

FSlateEditableTextLayout

Class to handle the cached layout of SEditableText/SMultiLineEditableText by proxying around a [FTextLayout](API\Runtime\Slate\FTextLayout)

API > API/Runtime > API/Runtime/Slate

Class to handle the cached layout of SEditableText/SMultiLineEditableText by proxying around a FTextLayout

   
Name FSlateEditableTextLayout
Type class
Header File /Engine/Source/Runtime/Slate/Public/Widgets/Text/SlateEditableTextLayout.h
Include Path #include "Widgets/Text/SlateEditableTextLayout.h"

Syntax

class FSlateEditableTextLayout

Constructors

Name Remarks Include Path Unreal Specifiers

FSlateEditableTextLayout ( ISlateEditableTextWidget& InOwnerWidget,
const TAttribute< FText >& InInitialText,
FTextBlockStyle InTextStyle,
const TOptional< ETextShapingMethod > InTextShapingMethod,
const TOptional< ETextFlowDirection > InTextFlowDirection,
const FCreateSlateTextLayout& InCreateSlateTextLayout,
TSharedRef< ITextLayoutMarshaller > InTextMarshaller,
TSharedRef< ITextLayoutMarshaller > InHintTextMarshaller
)

   Widgets/Text/SlateEditableTextLayout.h  

Destructors

Name Remarks Include Path Unreal Specifiers

~FSlateEditableTextLayout()

   Widgets/Text/SlateEditableTextLayout.h  

Classes

Name Remarks
FTextInputMethodContext  
FVirtualKeyboardEntry  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ActiveContextMenu FActiveTextEditContextMenu Information about any active context menu widgets Widgets/Text/SlateEditableTextLayout.h  
ActiveLineHighlights TArray< FTextLineHighlight > Line highlights that have been added from this editable text layout (used for cleanup without removing) Widgets/Text/SlateEditableTextLayout.h  
ApplyLineHeightToBottomLine TAttribute< bool > Whether to leave extra space below the last line due to line height Widgets/Text/SlateEditableTextLayout.h  
AutoWrapText TAttribute< bool > True if we're wrapping text automatically based on the computed horizontal space for this widget Widgets/Text/SlateEditableTextLayout.h  
bHasDragSelectedSinceFocused bool True if characters were selected by dragging since the last keyboard focus. Widgets/Text/SlateEditableTextLayout.h  
bHasRegisteredTextInputMethodContext bool True if the IME context for this text layout has been registered with the input method manager Widgets/Text/SlateEditableTextLayout.h  
bIsDragSelecting bool True if we're currently selecting text by dragging the mouse cursor with the left button held down Widgets/Text/SlateEditableTextLayout.h  
BoundSearchText TAttribute< FText > The text to be searched for Widgets/Text/SlateEditableTextLayout.h  
BoundSearchTextLastTick FTextSnapshot The state of BoundSearchText last Tick() (used to allow updates when the text is changed) Widgets/Text/SlateEditableTextLayout.h  
BoundText TAttribute< FText > The text displayed in this text block Widgets/Text/SlateEditableTextLayout.h  
BoundTextLastTick FTextSnapshot The state of BoundText last Tick() (used to allow updates when the text is changed) Widgets/Text/SlateEditableTextLayout.h  
bSelectionChangedExternally bool Whether the cursor position has been changed externally Widgets/Text/SlateEditableTextLayout.h  
bTextChangedByVirtualKeyboard bool Whether the text has been changed by a virtual keyboard Widgets/Text/SlateEditableTextLayout.h  
bTextCommittedByVirtualKeyboard bool Whether the text has been committed by a virtual keyboard Widgets/Text/SlateEditableTextLayout.h  
bWasFocusedByLastMouseDown bool True if the last mouse down caused us to receive keyboard focus Widgets/Text/SlateEditableTextLayout.h  
bWasPasswordLastTick bool Was the editable text showing a password last Tick() (allows a forcible text layout update when changing state) Widgets/Text/SlateEditableTextLayout.h  
CachedSize FVector2f The last known size of the widget from the previous OnPaint, used to recalculate wrapping Widgets/Text/SlateEditableTextLayout.h  
CreateSlateTextLayout FCreateSlateTextLayout Delegate used to create internal text layouts. Widgets/Text/SlateEditableTextLayout.h  
CurrentSearchResultIndex int32 The active search result index Widgets/Text/SlateEditableTextLayout.h  
CurrentUndoLevel int32 Current undo state level that we've rolled back to, or INDEX_NONE if we haven't undone. Widgets/Text/SlateEditableTextLayout.h  
CursorInfo SlateEditableTextTypes::FCursorInfo Current cursor data Widgets/Text/SlateEditableTextLayout.h  
CursorLineHighlighter TSharedPtr< SlateEditableTextTypes::FCursorLineHighlighter > Layout highlighter used to draw the cursor Widgets/Text/SlateEditableTextLayout.h  
DebugSourceInfo TAttribute< FString > The information used to help identify who owns this text layout in the case of an error Widgets/Text/SlateEditableTextLayout.h  
ExternalSelectionEnd int   Widgets/Text/SlateEditableTextLayout.h  
ExternalSelectionStart int The boundaries of the external selection Widgets/Text/SlateEditableTextLayout.h  
GraphemeBreakIterator TSharedPtr< IBreakIterator > The iterator to use to detect grapheme cluster boundaries Widgets/Text/SlateEditableTextLayout.h  
HintMarshaller TSharedPtr< ITextLayoutMarshaller > The marshaller used to get/set the HintText text to/from the text layout. Widgets/Text/SlateEditableTextLayout.h  
HintText TAttribute< FText > The text that appears when there is no text in the text box Widgets/Text/SlateEditableTextLayout.h  
HintTextLayout TUniquePtr< FSlateTextBlockLayout > In control of the layout and wrapping of the HintText Widgets/Text/SlateEditableTextLayout.h  
HintTextStyle FTextBlockStyle Style used to draw the hint text (only valid when HintTextLayout is set) Widgets/Text/SlateEditableTextLayout.h  
Justification TAttribute< ETextJustify::Type > How the text should be aligned with the margin Widgets/Text/SlateEditableTextLayout.h  
LineHeightPercentage TAttribute< float > The amount to scale each lines height by Widgets/Text/SlateEditableTextLayout.h  
Margin TAttribute< FMargin > The amount of blank space left around the edges of text area Widgets/Text/SlateEditableTextLayout.h  
Marshaller TSharedPtr< ITextLayoutMarshaller > The marshaller used to get/set the BoundText text to/from the text layout. Widgets/Text/SlateEditableTextLayout.h  
NumTransactionsOpened int32 Track the number transactions that are opened Widgets/Text/SlateEditableTextLayout.h  
OriginalText SlateEditableTextTypes::FUndoState Original text undo state Widgets/Text/SlateEditableTextLayout.h  
OverflowPolicyOverride TOptional< ETextOverflowPolicy > Override for the overflow policy. If this is not set the text style setting is used Widgets/Text/SlateEditableTextLayout.h  
OwnerWidget ISlateEditableTextWidget * Pointer to the interface for our owner widget Widgets/Text/SlateEditableTextLayout.h  
PositionToScrollIntoView TOptional< SlateEditableTextTypes::FScrollInfo > If set, the pending data containing a position that should be scrolled into view Widgets/Text/SlateEditableTextLayout.h  
PreferredCursorScreenOffsetInLine float The user probably wants the cursor where they last explicitly positioned it horizontally. Widgets/Text/SlateEditableTextLayout.h  
ScrollOffset FVector2f The scroll offset (in unscaled Slate units) for this text Widgets/Text/SlateEditableTextLayout.h  
SearchCase ESearchCase::Type The case-sensitivity of the active search (set from BeginSearch) Widgets/Text/SlateEditableTextLayout.h  
SearchResultToIndexMap TMap< FTextLocation, int32 > The map to look up the index of each search result (key is the starting location of each matched string) Widgets/Text/SlateEditableTextLayout.h  
SearchSelectionHighlighter TSharedPtr< SlateEditableTextTypes::FTextSearchHighlighter > Layout highlighter used to draw the active search selection Widgets/Text/SlateEditableTextLayout.h  
SearchText FText The active search text (set from BeginSearch) Widgets/Text/SlateEditableTextLayout.h  
SelectionStart TOptional< FTextLocation > That start of the selection when there is a selection. Widgets/Text/SlateEditableTextLayout.h  
StateBeforeChangingText TOptional< SlateEditableTextTypes::FUndoState > Undo state that will be pushed if text is actually changed between calls to BeginEditTransation() and EndEditTransaction() Widgets/Text/SlateEditableTextLayout.h  
TextCompositionHighlighter TSharedPtr< SlateEditableTextTypes::FTextCompositionHighlighter > Layout highlighter used to draw an active text composition Widgets/Text/SlateEditableTextLayout.h  
TextInputMethodChangeNotifier TSharedPtr< ITextInputMethodChangeNotifier > Notification interface object for IMEs Widgets/Text/SlateEditableTextLayout.h  
TextInputMethodContext TSharedPtr< FTextInputMethodContext > IME context for this text layout Widgets/Text/SlateEditableTextLayout.h  
TextLayout TSharedPtr< FSlateTextLayout > In control of the layout and wrapping of the BoundText Widgets/Text/SlateEditableTextLayout.h  
TextSelectionHighlighter TSharedPtr< SlateEditableTextTypes::FTextSelectionHighlighter > Layout highlighter used to draw the active text selection Widgets/Text/SlateEditableTextLayout.h  
TextStyle FTextBlockStyle Default style used by the TextLayout Widgets/Text/SlateEditableTextLayout.h  
UICommandList TSharedPtr< FUICommandList > A list commands to execute if a user presses the corresponding key-binding in the text box Widgets/Text/SlateEditableTextLayout.h  
UndoStates TArray< SlateEditableTextTypes::FUndoState > Undo states Widgets/Text/SlateEditableTextLayout.h  
VirtualKeyboardEntry TSharedPtr< FVirtualKeyboardEntry > Virtual keyboard handler for this text layout Widgets/Text/SlateEditableTextLayout.h  
VirtualKeyboardText FText What text was submitted by a virtual keyboard Widgets/Text/SlateEditableTextLayout.h  
VirtualKeyboardTextCommitType ETextCommit::Type How the text was committed by the virtual keyboard Widgets/Text/SlateEditableTextLayout.h  
WrappingPolicy TAttribute< ETextWrappingPolicy > The wrapping policy we're using Widgets/Text/SlateEditableTextLayout.h  
WrapTextAt TAttribute< float > Whether text wraps onto a new line when it's length exceeds this width; if this value is zero or negative, no wrapping occurs. Widgets/Text/SlateEditableTextLayout.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AdvanceSearch ( const bool InReverse
)

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

bool AnyTextSelected()

 Query to see if any text is selected within the document Widgets/Text/SlateEditableTextLayout.h  

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

 Apply the given style to the currently selected text (or insert a new run at the current cursor position if no text is selected) Widgets/Text/SlateEditableTextLayout.h  

void BeginEditTransation()

 Called to begin an undoable editable text transaction Widgets/Text/SlateEditableTextLayout.h  

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

 Begin a new text search (this is called automatically when BoundSearchText changes) Widgets/Text/SlateEditableTextLayout.h  

TSharedRef< SWidget > BuildDefaultContextMenu ( const TSharedPtr< FExtender >& InMenuExtender
) const

   Widgets/Text/SlateEditableTextLayout.h  

void CacheDesiredSize ( float LayoutScaleMultiplier
)

   Widgets/Text/SlateEditableTextLayout.h  

bool CanExecuteCopy()

 Are we able to copy the currently selected text? Widgets/Text/SlateEditableTextLayout.h  

bool CanExecuteCut()

 Are we able to cut the currently selected text? Widgets/Text/SlateEditableTextLayout.h  

bool CanExecuteDelete()

 Are we able to delete the currently selected text? Widgets/Text/SlateEditableTextLayout.h  

bool CanExecutePaste()

 Are we able to paste the text from the clipboard into this document? Widgets/Text/SlateEditableTextLayout.h  

bool CanExecuteRedo()

 Are we currently able to execute a redo action? Widgets/Text/SlateEditableTextLayout.h  

bool CanExecuteSelectAll()

 Are we able to execute the "Select All" command? Widgets/Text/SlateEditableTextLayout.h  

bool CanExecuteUndo()

 Are we currently able to execute an undo action? Widgets/Text/SlateEditableTextLayout.h  

void ClearSelection()

 Clear the active text selection Widgets/Text/SlateEditableTextLayout.h  

void ClearUndoStates()

 Clear the current undo stack Widgets/Text/SlateEditableTextLayout.h  

FVector2D ComputeDesiredSize ( float LayoutScaleMultiplier
) const

   Widgets/Text/SlateEditableTextLayout.h  

bool ComputeVolatility()

   Widgets/Text/SlateEditableTextLayout.h  

void CopySelectedTextToClipboard()

 Copy the currently selected text and place it on the clipboard Widgets/Text/SlateEditableTextLayout.h  

void CutSelectedTextToClipboard()

 Cut the currently selected text and place it on the clipboard Widgets/Text/SlateEditableTextLayout.h  

void DeleteSelectedText()

 Delete any currently selected text Widgets/Text/SlateEditableTextLayout.h  

void EnableTextInputMethodContext()

 Register and activate the IME context for this text layout Widgets/Text/SlateEditableTextLayout.h  

void EndEditTransaction()

 Called to end an undoable editable text transaction Widgets/Text/SlateEditableTextLayout.h  

void ForceRefreshTextLayout ( const FText& CurrentText
)

 Force the text layout to be updated from the marshaller Widgets/Text/SlateEditableTextLayout.h  

bool GetAutoWrapText()

 Returns whether or not we are auto wrapping text Widgets/Text/SlateEditableTextLayout.h  

TCHAR GetCharacterAt ( const FTextLocation& Location
) const

 Get the character at Location Widgets/Text/SlateEditableTextLayout.h  

FChildren * GetChildren()

   Widgets/Text/SlateEditableTextLayout.h  

float GetComputedWrappingWidth()

 Returns the computed wrap location for this layout Widgets/Text/SlateEditableTextLayout.h  

void GetCurrentTextLine ( FString& OutTextLine
) const

 Fill OutTextLine with the text line where the current cursor location is at Widgets/Text/SlateEditableTextLayout.h  

FTextLocation GetCursorLocation()

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

FText GetEditableText()

 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 Widgets/Text/SlateEditableTextLayout.h  

FText GetHintText()

   Widgets/Text/SlateEditableTextLayout.h  

int32 GetNumSearchResults()

 Get the total number of search results (0 if none) Widgets/Text/SlateEditableTextLayout.h  

FText GetPlainText()

 Get the plain text string without rich-text formatting Widgets/Text/SlateEditableTextLayout.h  

TSharedPtr< const IRun > GetRunUnderCursor()

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

UE::Slate::FDeprecateVector2DResult GetScrollOffset()

 Get the absolute scroll offset value Widgets/Text/SlateEditableTextLayout.h  

int32 GetSearchResultIndex()

 Get the index of the search result (0 if none) Widgets/Text/SlateEditableTextLayout.h  

FText GetSearchText()

   Widgets/Text/SlateEditableTextLayout.h  

TArray< TSharedRef< const IRun > > GetSelectedRuns()

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

FText GetSelectedText()

 Get the currently selected text Widgets/Text/SlateEditableTextLayout.h  

FTextSelection GetSelection()

 Get the current selection Widgets/Text/SlateEditableTextLayout.h  

UE::Slate::FDeprecateVector2DResult GetSize()

   Widgets/Text/SlateEditableTextLayout.h  

FText GetText()

   Widgets/Text/SlateEditableTextLayout.h  

TSharedRef< ITextInputMethodContext > GetTextInputMethodContext()

 Get the IME context for this text layout Widgets/Text/SlateEditableTextLayout.h  

void GetTextLine ( const int32 InLineIndex,
FString& OutTextLine
) const

 Fill OutTextLine with the text line at the specified index Widgets/Text/SlateEditableTextLayout.h  

int32 GetTextLineCount()

 Get the number of Text Lines Widgets/Text/SlateEditableTextLayout.h  

const FTextBlockStyle & GetTextStyle()

   Widgets/Text/SlateEditableTextLayout.h  

TSharedRef< IVirtualKeyboardEntry > GetVirtualKeyboardEntry()

 Get the virtual keyboard handler for this text layout Widgets/Text/SlateEditableTextLayout.h  

void GoTo ( const ETextLocation NewLocation
)

 Move the cursor specified location Widgets/Text/SlateEditableTextLayout.h  

void GoTo ( const FTextLocation& NewLocation
)

 Move the cursor to the given location in the document (will also scroll to this point) Widgets/Text/SlateEditableTextLayout.h  

bool HandleBackspace()

 Called to handle a backspace action acting on the current selection or at the cursor position Widgets/Text/SlateEditableTextLayout.h  

bool HandleCarriageReturn ( bool isRepeat
)

 Called to handle a carriage return action acting on the current selection or at the cursor position Widgets/Text/SlateEditableTextLayout.h  

bool HandleDelete()

 Called to handle a delete action acting on the current selection or at the cursor position Widgets/Text/SlateEditableTextLayout.h  

bool HandleEscape()

 Called to handle an escape action acting on the current selection Widgets/Text/SlateEditableTextLayout.h  

bool HandleFocusLost ( const FFocusEvent& InFocusEvent
)

 Called when our parent widget loses focus Widgets/Text/SlateEditableTextLayout.h  

bool HandleFocusReceived ( const FFocusEvent& InFocusEvent
)

 Called when our parent widget receives focus Widgets/Text/SlateEditableTextLayout.h  

FReply HandleKeyChar ( const FCharacterEvent& InCharacterEvent
)

 Called to handle an OnKeyChar event from our parent widget Widgets/Text/SlateEditableTextLayout.h  

FReply HandleKeyDown ( const FKeyEvent& InKeyEvent
)

 Called to handle an OnKeyDown event from our parent widget Widgets/Text/SlateEditableTextLayout.h  

FReply HandleKeyUp ( const FKeyEvent& InKeyEvent
)

 Called to handle an OnKeyUp event from our parent widget Widgets/Text/SlateEditableTextLayout.h  

FReply HandleMouseButtonDoubleClick ( const FGeometry& InMyGeometry,
const FPointerEvent& InMouseEvent
)

 Called to handle an OnMouseButtonDoubleClick event from our parent widget Widgets/Text/SlateEditableTextLayout.h  

FReply HandleMouseButtonDown ( const FGeometry& MyGeometry,
const FPointerEvent& InMouseEvent
)

 Called to handle an OnMouseButtonDown event from our parent widget Widgets/Text/SlateEditableTextLayout.h  

FReply HandleMouseButtonUp ( const FGeometry& MyGeometry,
const FPointerEvent& InMouseEvent
)

 Called to handle an OnMouseButtonUp event from our parent widget Widgets/Text/SlateEditableTextLayout.h  

FReply HandleMouseMove ( const FGeometry& InMyGeometry,
const FPointerEvent& InMouseEvent
)

 Called to handle an OnMouseMove event from our parent widget Widgets/Text/SlateEditableTextLayout.h  

bool HandleTypeChar ( const TCHAR InChar
)

 Called to handle a typing a character on the current selection or at the cursor position Widgets/Text/SlateEditableTextLayout.h  

bool HasActiveContextMenu()

   Widgets/Text/SlateEditableTextLayout.h  

bool HasTextChangedFromOriginal()

 Returns whether the current text varies from the original Widgets/Text/SlateEditableTextLayout.h  

void InsertRunAtCursor ( TSharedRef< IRun > InRun
)

 Insert the given run at the current cursor position Widgets/Text/SlateEditableTextLayout.h  

void InsertTextAtCursor ( const FString& InString
)

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

bool IsAtBeginningOfDocument ( const FTextLocation& Location
) const

 Are we at the beginning of all the text. Widgets/Text/SlateEditableTextLayout.h  

bool IsAtBeginningOfLine ( const FTextLocation& Location
) const

 Is this location the beginning of a line Widgets/Text/SlateEditableTextLayout.h  

bool IsAtEndOfDocument ( const FTextLocation& Location
) const

 Are we at the end of all the text. Widgets/Text/SlateEditableTextLayout.h  

bool IsAtEndOfLine ( const FTextLocation& Location
) const

 Is this location the end of a line. Widgets/Text/SlateEditableTextLayout.h  

bool IsAtWordStart ( const FTextLocation& Location
) const

 Are we currently at the beginning of a word Widgets/Text/SlateEditableTextLayout.h  

bool IsTextSelectedAt ( const UE::Slate::FDeprecateVector2DParameter& InLocalPosition
) const

 Query to see if the text under the given position is currently selected (the position is local to the text layout space) Widgets/Text/SlateEditableTextLayout.h  

bool IsTextSelectedAt ( const FGeometry& MyGeometry,
const UE::Slate::FDeprecateVector2DParameter& ScreenSpacePosition
) const

 Query to see if the text under the given position is currently selected Widgets/Text/SlateEditableTextLayout.h  

void JumpTo ( ETextLocation JumpLocation,
ECursorAction Action
)

 Jump the cursor to the given location in the document Widgets/Text/SlateEditableTextLayout.h  

void LoadText()

   Widgets/Text/SlateEditableTextLayout.h  

void MakeUndoState ( SlateEditableTextTypes::FUndoState& OutUndoState
)

 Create an undo state that reflects the current state of the document Widgets/Text/SlateEditableTextLayout.h  

bool MoveCursor ( const FMoveCursor& InArgs
)

 Move the cursor in the document using the specified move method Widgets/Text/SlateEditableTextLayout.h  

void OnArrangeChildren ( const FGeometry& AllottedGeometry,
FArrangedChildren& ArrangedChildren
) const

   Widgets/Text/SlateEditableTextLayout.h  

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

   Widgets/Text/SlateEditableTextLayout.h  

void PasteTextFromClipboard()

 Paste the text from the clipboard into this document Widgets/Text/SlateEditableTextLayout.h  

void PushUndoState ( const SlateEditableTextTypes::FUndoState& InUndoState
)

 Push the given undo state onto the undo stack Widgets/Text/SlateEditableTextLayout.h  

void Redo()

 Execute a redo action Widgets/Text/SlateEditableTextLayout.h  

bool Refresh()

 Refresh this editable text immediately, rather than wait for the usual caching mechanisms to take affect on the text Tick Widgets/Text/SlateEditableTextLayout.h  

void RemoveCursorHighlight()

 Remove any active cursor highlights Widgets/Text/SlateEditableTextLayout.h  

void RestoreOriginalText()

 Restores the text to the original state Widgets/Text/SlateEditableTextLayout.h  

void SaveText ( const FText& TextToSave
)

   Widgets/Text/SlateEditableTextLayout.h  

FTextLocation ScanForWordBoundary ( const FTextLocation& Location,
int8 Direction
) const

 Find the closest word boundary Widgets/Text/SlateEditableTextLayout.h  

void ScrollTo ( const ETextLocation NewLocation
)

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

void ScrollTo ( const FTextLocation& NewLocation
)

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

void SelectAllText()

 Select all the text in the document Widgets/Text/SlateEditableTextLayout.h  

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

 Select a block of text Widgets/Text/SlateEditableTextLayout.h  

void SelectWordAt ( const UE::Slate::FDeprecateVector2DParameter& InLocalPosition
)

 Select the word under the given position (the position is local to the text layout space) Widgets/Text/SlateEditableTextLayout.h  

void SelectWordAt ( const FGeometry& MyGeometry,
const UE::Slate::FDeprecateVector2DParameter& ScreenSpacePosition
)

 Select the word under the given position Widgets/Text/SlateEditableTextLayout.h  

void SetApplyLineHeightToBottomLine ( const TAttribute< bool >& InApplyLineHeightToBottomLine
)

 Set whether to leave extra space below the last line due to line height Widgets/Text/SlateEditableTextLayout.h  

void SetAutoWrapText ( const TAttribute< bool >& InAutoWrapText
)

 Set whether to wrap text automatically based on the widget's computed horizontal space Widgets/Text/SlateEditableTextLayout.h  

void SetCompositionBrush ( const TAttribute< const FSlateBrush* >& InCompositionBrush
)

 Set the brush to use when drawing the composition highlight Widgets/Text/SlateEditableTextLayout.h  

void SetCursorBrush ( const TAttribute< const FSlateBrush* >& InCursorBrush
)

 Set the brush to use when drawing the cursor Widgets/Text/SlateEditableTextLayout.h  

void SetDebugSourceInfo ( const TAttribute< FString >& InDebugSourceInfo
)

 Set the information used to help identify who owns this text layout in the case of an error Widgets/Text/SlateEditableTextLayout.h  

bool SetEditableText ( const FText& TextToSet,
const bool bForce
)

 Sets the current editable text for this text block Note: Doesn't update the value of BoundText, nor does it call OnTextChanged Widgets/Text/SlateEditableTextLayout.h  

void SetHintText ( const TAttribute< FText >& InHintText
)

   Widgets/Text/SlateEditableTextLayout.h  

UE::Slate::FDeprecateVector2DResult SetHorizontalScrollFraction ( const float InScrollOffsetFraction
)

 Update the horizontal scroll amount from the given fraction Widgets/Text/SlateEditableTextLayout.h  

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

 Set how the text should be aligned with the margin Widgets/Text/SlateEditableTextLayout.h  

void SetLineHeightPercentage ( const TAttribute< float >& InLineHeightPercentage
)

 Set the amount to scale each lines height by Widgets/Text/SlateEditableTextLayout.h  

void SetMargin ( const TAttribute< FMargin >& InMargin
)

 Set the amount of blank space left around the edges of text area Widgets/Text/SlateEditableTextLayout.h  

void SetOverflowPolicy ( TOptional< ETextOverflowPolicy > InOverflowPolicy
)

 Set the text overflow policy that should be used to determine what happens to clipped text Widgets/Text/SlateEditableTextLayout.h  

UE::Slate::FDeprecateVector2DResult SetScrollOffset ( const UE::Slate::FDeprecateVector2DParameter& InScrollOffset,
const FGeometry& InGeometry
)

 Set the absolute scroll offset value Widgets/Text/SlateEditableTextLayout.h  

void SetSearchText ( const TAttribute< FText >& InSearchText
)

   Widgets/Text/SlateEditableTextLayout.h  

void SetText ( const TAttribute< FText >& InText
)

   Widgets/Text/SlateEditableTextLayout.h  

void SetTextFlowDirection ( const TOptional< ETextFlowDirection >& InTextFlowDirection
)

 Set the text flow direction that the internal text layout should use Widgets/Text/SlateEditableTextLayout.h  

void SetTextShapingMethod ( const TOptional< ETextShapingMethod >& InTextShapingMethod
)

 Set the text shaping method that the internal text layout should use Widgets/Text/SlateEditableTextLayout.h  

void SetTextStyle ( const FTextBlockStyle& InTextStyle
)

   Widgets/Text/SlateEditableTextLayout.h  

void SetTextWrapping ( const TAttribute< float >& InWrapTextAt,
const TAttribute< bool >& InAutoWrapText,
const TAttribute< ETextWrappingPolicy >& InWrappingPolicy
)

 Set the wrapping to use for this document Widgets/Text/SlateEditableTextLayout.h  

UE::Slate::FDeprecateVector2DResult SetVerticalScrollFraction ( const float InScrollOffsetFraction
)

 Update the vertical scroll amount from the given fraction Widgets/Text/SlateEditableTextLayout.h  

void SetWrappingPolicy ( const TAttribute< ETextWrappingPolicy >& InWrappingPolicy
)

 Set the wrapping policy to use Widgets/Text/SlateEditableTextLayout.h  

void SetWrapTextAt ( const TAttribute< float >& InWrapTextAt
)

 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 Widgets/Text/SlateEditableTextLayout.h  

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

   Widgets/Text/SlateEditableTextLayout.h  

FTextLocation TranslatedLocation ( const FTextLocation& CurrentLocation,
int8 Direction
) const

 Given a location and a Direction to offset, return a new location. Widgets/Text/SlateEditableTextLayout.h  

void TranslateLocationVertical ( const FTextLocation& Location,
int32 NumLinesToMove,
float GeometryScale,
FTextLocation& OutCursorPosition,
TOptional< SlateEditableTextTypes::ECursorAlignment >& OutCursorAlignment
) const

 Given a location and a Direction to offset, return a new location. Widgets/Text/SlateEditableTextLayout.h  

void Undo()

 Execute an undo action Widgets/Text/SlateEditableTextLayout.h  

void UpdateCursorHighlight()

 Update the active cursor highlight based on the state of the text layout Widgets/Text/SlateEditableTextLayout.h  

void UpdatePreferredCursorScreenOffsetInLine()

 Update the preferred offset of the cursor, based on the current state of the text layout Widgets/Text/SlateEditableTextLayout.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page