1. Epic GamesDeveloper
  3. ISlateEditableTextWidget

ISlateEditableTextWidget

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

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

Inheritance Hierarchy

References

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

Syntax

class ISlateEditableTextWidget

Remarks

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

Functions

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

CanTypeCharacter ( const TCHAR InChar
)

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

OnCursorMoved ( const FTextLocation& InLocation
)

 Called when the cursor is moved within the text area
Public function void

OnTextChanged ( const FText& InText
)

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

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

 Called when the text control has committed its current edit changes
Public function Const bool Should we clear the keyboard focus when the user commits text to this widget?
Public function Const bool Should the text clear its selection the widget loses focus?
Public function Const bool Should the cursor be jumped to the end of the document when the widget gains focus?
Public function Const bool Should we revert the text back to its original state when the user presses escape?
Public function Const bool Should we select all text when the user commits text to this widget?
Public function Const bool Should the text be selected when the widget gains focus?
Public function Const bool Should we select word on mouse double click?
Public function 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.
Public function 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.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page