1. Epic GamesDeveloper
  3. SEditableTextBox

SEditableTextBox

Editable text box widget

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

Inheritance Hierarchy

References

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

Syntax

class SEditableTextBox : public SBorder

Remarks

Editable text box widget

Variables

  Type Name Description
Protected variable TAttribute< FSlateColor > BackgroundColorOverride Background color (overrides style)
Protected variable TSharedPtr< SHorizontalBox > Box Allows for inserting additional widgets that extend the functionality of the text box
Protected variable TSharedPtr< SEditableText > EditableText Editable text widget
Protected variable TSharedPtr< class IErrorReportingWidget > ErrorReporting SomeWidget reporting
Protected variable TAttribute< FSlateColor > FocusedForegroundColorOverride Focused foreground color (overrides style)
Protected variable TAttribute< FSlateFontInfo > FontOverride Font (overrides style)
Protected variable TAttribute< FSlateColor > ForegroundColorOverride Foreground color (overrides style)
Protected variable FOnTextChanged OnTextChanged Called when the text is changed interactively
Protected variable FOnTextCommitted OnTextCommitted Called when the user commits their change to the editable text control
Protected variable FOnVerifyTextChanged OnVerifyTextChanged Callback to verify text when changed. Will return an error message to denote problems.
Protected variable TSharedPtr< SBox > PaddingBox Box widget that adds padding around the editable text
Protected variable TAttribute< FMargin > PaddingOverride Padding (overrides style)
Protected variable TAttribute< FSlateColor > ReadOnlyForegroundColorOverride Read-only foreground color (overrides style)
Protected variable const FEditableTextBoxStyle * Style  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

AdvanceSearch ( const bool InReverse
)

 Advance the current search to the next match (does nothing if not currently searching)
Public function Const bool Query to see if any text is selected within the document
Public function void

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

 Begin a new text search (this is called automatically when the bound search text changes)
Public function void Clear the active text selection
Public function void

Construct ( const FArguments& InArgs
)

 Construct this widget
Public function void Register and activate the IME context for the text layout of this textbox
Public function Const FText Returns the Hint text string
Public function Const FText Get the text that is currently being searched for (if any)
Public function Const FText Get the currently selected text
Public function Const FText

GetText ()

 Returns the text string
Public function void

GoTo ( const ETextLocation NewLocation
)

 Move the cursor to the specified location
Public function void

GoTo ( const FTextLocation& NewLocation
)

 Move the cursor to the given location in the document
Public function Const bool  
Public function Const bool  
Public function Const bool  
Protected function void

OnEditableTextChanged ( const FText& InText
)

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

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

 Callback when the editable text is committed.
Public function void

ScrollTo ( const ETextLocation NewLocation
)

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

ScrollTo ( const FTextLocation& NewLocation
)

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

SetAllowContextMenu ( TAttribute< bool > InAllowContextMenu
)

 See the AllowContextMenu attribute
Public function void

SetClearKeyboardFocusOnCommit ( const TAttribute< bool >& InClearKeyboardFocusOnCommit
)

 Sets whether to clear keyboard focus when pressing enter to commit changes
Public function void

SetError ( const FString& InError
)

 If InError is a non-empty string the TextBox will the ErrorReporting provided during construction If no error reporting was provided, the TextBox will create a default error reporter.
Public function void

SetError ( const FText& InError
)

 If InError is a non-empty string the TextBox will the ErrorReporting provided during construction If no error reporting was provided, the TextBox will create a default error reporter.
Public function void

SetFocusedForegroundColor ( const TAttribute< FSlateColor >& InFocusedForegroundColor
)

 Sets the text color and opacity when this box has keyboard focus(overrides Style)
Public function void

SetFont ( const TAttribute< FSlateFontInfo >& InFont
)

 Sets the font used to draw the text
Public function void

SetHintText ( const TAttribute< FText >& InHintText
)

 See the HintText attribute
Public function void

SetIsCaretMovedWhenGainFocus ( const TAttribute< bool >& InIsCaretMovedWhenGainFocus
)

 Workaround as we loose focus when the auto completion closes.
Public function void

SetIsPassword ( TAttribute< bool > InIsPassword
)

 See the IsPassword attribute
Public function void

SetIsReadOnly ( TAttribute< bool > InIsReadOnly
)

 See the IsReadOnly attribute
Public function void

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

 See Justification attribute
Public function void

SetMinimumDesiredWidth ( const TAttribute< float >& InMinimumDesiredWidth
)

 Sets the minimum width that a text box should be.
Public function void

SetOnKeyCharHandler ( FOnKeyChar InOnKeyCharHandler
)

 Sets the OnKeyCharHandler to provide first chance handling of the SEditableText's OnKeyChar event
Public function void

SetOnKeyDownHandler ( FOnKeyDown InOnKeyDownHandler
)

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

SetOverflowPolicy ( TOptional< ETextOverflowPolicy > InOverflowPolicy
)

 Sets the overflow policy for this text block
Public function void

SetReadOnlyForegroundColor ( const TAttribute< FSlateColor >& InReadOnlyForegroundColor
)

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

SetRevertTextOnEscape ( const TAttribute< bool >& InRevertTextOnEscape
)

 Sets whether to allow the user to back out of changes when they press the escape key
Public function void

SetSearchText ( const TAttribute< FText >& InSearchText
)

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

SetSelectAllTextOnCommit ( const TAttribute< bool >& InSelectAllTextOnCommit
)

 Sets whether to select all text when pressing enter to commit changes
Public function void

SetSelectAllTextWhenFocused ( const TAttribute< bool >& InSelectAllTextWhenFocused
)

 Sets whether to select all text when the user clicks to give focus on the widget
Public function void

SetSelectWordOnMouseDoubleClick ( const TAttribute< bool >& InSelectWordOnMouseDoubleClick
)

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

SetStyle ( const FEditableTextBoxStyle* InStyle
)

 See attribute Style
Public function void

SetText ( const TAttribute< FText >& InNewText
)

 Sets the text string currently being edited
Public function void

SetTextBlockStyle ( const FTextBlockStyle* InTextStyle
)

 Sets the text block style currently used
Public function void

SetTextBoxBackgroundColor ( const TAttribute< FSlateColor >& InBackgroundColor
)

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

SetTextBoxForegroundColor ( const TAttribute< FSlateColor >& InForegroundColor
)

 Sets the text color and opacity (overrides Style)
Public function void

SetTextFlowDirection ( const TOptional< ETextFlowDirection >& InTextFlowDirection
)

 See TextFlowDirection attribute
Public function void

SetTextShapingMethod ( const TOptional< ETextShapingMethod >& InTextShapingMethod
)

 See TextShapingMethod attribute
Public function void

SetVirtualKeyboardDismissAction ( TAttribute< EVirtualKeyboardDismissAction > InVirtualKeyboardDismissAction
)

 Set the VirtualKeyboardDismissAction attribute

Overridden from SWidget

  Type Name Description
Protected function Virtual TSharedRef< FSlateAccessibleWidget >  
Protected function Virtual Const TOptional< FText >

GetDefaultAccessibleText ( EAccessibleType AccessibleType
)

 Assign AccessibleText with a default value that can be used when AccessibleBehavior is set to Auto or Custom.
Public function Virtual Const bool Checks to see if this widget currently has the keyboard focus
Public function Virtual FReply

OnFocusReceived ( const FGeometry& MyGeometry,
const FFocusEvent& InFocusEvent
)

 KEY INPUT Called when focus is given to this widget. This event does not bubble.
Public function Virtual FReply

OnKeyDown ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

 Called after a key is pressed when this widget has focus (this event bubbles if not handled)
Public function Virtual Const bool Checks to see if this widget supports keyboard focus. Override this in derived classes.

Classes

  Type Name Description
Public struct FArguments    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page