1. Epic GamesDeveloper
  3. ISlateEditableTextWidget

ISlateEditableTextWidget

Interface to allow [FSlateEditableTextLayout](API\Runtime\Slate\FSlateEditableTextLayout) to notify its parent SEditableText/SMultiLineEditableText of changes, as well as query some widget specific state

API > API/Runtime > API/Runtime/Slate

Interface to allow FSlateEditableTextLayout to notify its parent SEditableText/SMultiLineEditableText of changes, as well as query some widget specific state

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

Syntax

class ISlateEditableTextWidget

Derived Classes

Functions

Public

Name Remarks Include Path Unreal Specifiers

TSharedPtr< SWidget > BuildContextMenuContent()

 Build the context menu content to use for this widget (if any) Widgets/Text/ISlateEditableTextWidget.h  

bool CanInsertCarriageReturn()

 Are we currently able to insert a carriage return? (some widgets have modifier keys that need to be pressed) Widgets/Text/ISlateEditableTextWidget.h  

bool CanTypeCharacter ( const TCHAR InChar
) const

 Are we able to insert the given character into our text? Widgets/Text/ISlateEditableTextWidget.h  

void EnsureActiveTick()

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

TSharedRef< SWidget > GetSlateWidget()

 Get the Slate widget this interface is representing (may not be called during destruction) Widgets/Text/ISlateEditableTextWidget.h  

TSharedPtr< SWidget > GetSlateWidgetPtr()

 Get the Slate widget this interface is representing (may be null during destruction) Widgets/Text/ISlateEditableTextWidget.h  

EVirtualKeyboardDismissAction GetVirtualKeyboardDismissAction()

 Get the message action to take when the virtual keyboard is dismissed by the user Widgets/Text/ISlateEditableTextWidget.h  

FVirtualKeyboardOptions GetVirtualKeyboardOptions()

 Get the options for the virtual keyboard used for this widget Widgets/Text/ISlateEditableTextWidget.h  

EVirtualKeyboardTrigger GetVirtualKeyboardTrigger()

 Get the type of event that will trigger the display of the virtual keyboard Widgets/Text/ISlateEditableTextWidget.h  

EKeyboardType GetVirtualKeyboardType()

 Get the type of virtual keyboard to use for this widget Widgets/Text/ISlateEditableTextWidget.h  

bool IsIntegratedKeyboardEnabled()

 Is the widget currently has IntegratedKeyboard enabled? Widgets/Text/ISlateEditableTextWidget.h  

bool IsMultiLineTextEdit()

 Is the text edit multi-line aware? Widgets/Text/ISlateEditableTextWidget.h  

bool IsTextPassword()

 Is the text displaying a password and should be obscured? Widgets/Text/ISlateEditableTextWidget.h  

bool IsTextReadOnly()

 Is the text currently read-only? Widgets/Text/ISlateEditableTextWidget.h  

void OnBeginTextEdit ( const FText& InText
)

 Called when the text starts to be edited Widgets/Text/ISlateEditableTextWidget.h  

void OnCursorMoved ( const FTextLocation& InLocation
)

 Called when the cursor is moved within the text area Widgets/Text/ISlateEditableTextWidget.h  

void OnTextChanged ( const FText& InText
)

 Called when the text has been changed by an edit operation Widgets/Text/ISlateEditableTextWidget.h  

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

 Called when the text control has committed its current edit changes Widgets/Text/ISlateEditableTextWidget.h  

bool ShouldClearKeyboardFocusOnCommit()

 Should we clear the keyboard focus when the user commits text to this widget? Widgets/Text/ISlateEditableTextWidget.h  

bool ShouldClearTextSelectionOnFocusLoss()

 Should the text clear its selection the widget loses focus? Widgets/Text/ISlateEditableTextWidget.h  

bool ShouldJumpCursorToEndWhenFocused()

 Should the cursor be jumped to the end of the document when the widget gains focus? Widgets/Text/ISlateEditableTextWidget.h  

bool ShouldRevertTextOnEscape()

 Should we revert the text back to its original state when the user presses escape? Widgets/Text/ISlateEditableTextWidget.h  

bool ShouldSelectAllTextOnCommit()

 Should we select all text when the user commits text to this widget? Widgets/Text/ISlateEditableTextWidget.h  

bool ShouldSelectAllTextWhenFocused()

 Should the text be selected when the widget gains focus? Widgets/Text/ISlateEditableTextWidget.h  

bool ShouldSelectWordOnMouseDoubleClick()

 Should we select word on mouse double click? Widgets/Text/ISlateEditableTextWidget.h  

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

 Called when the fraction and offset of the horizontal scroll area has been recalculated. Widgets/Text/ISlateEditableTextWidget.h  

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

 Called when the fraction and offset of the vertical scroll area has been recalculated. Widgets/Text/ISlateEditableTextWidget.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page