UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
SEditableTextBox Class Reference

#include <SEditableTextBox.h>

+ Inheritance diagram for SEditableTextBox:

Public Member Functions

 SLATE_BEGIN_ARGS (SEditableTextBox)
 
SLATE_API SEditableTextBox ()
 
virtual SLATE_API ~SEditableTextBox ()
 
SLATE_API void Construct (const FArguments &InArgs)
 
FText GetText () const
 
SLATE_API void SetStyle (const FEditableTextBoxStyle *InStyle)
 
SLATE_API void SetTextBlockStyle (const FTextBlockStyle *InTextStyle)
 
SLATE_API void SetText (const TAttribute< FText > &InNewText)
 
FText GetHintText () const
 
SLATE_API void SetHintText (const TAttribute< FText > &InHintText)
 
SLATE_API void SetSearchText (const TAttribute< FText > &InSearchText)
 
SLATE_API FText GetSearchText () const
 
SLATE_API void SetIsReadOnly (TAttribute< bool > InIsReadOnly)
 
bool IsReadOnly () const
 
SLATE_API void SetIsPassword (TAttribute< bool > InIsPassword)
 
bool IsPassword () const
 
SLATE_API void SetAllowContextMenu (TAttribute< bool > InAllowContextMenu)
 
SLATE_API void SetVirtualKeyboardDismissAction (TAttribute< EVirtualKeyboardDismissAction > InVirtualKeyboardDismissAction)
 
SLATE_API void SetFont (const TAttribute< FSlateFontInfo > &InFont)
 
SLATE_API void SetTextBoxForegroundColor (const TAttribute< FSlateColor > &InForegroundColor)
 
SLATE_API void SetTextBoxBackgroundColor (const TAttribute< FSlateColor > &InBackgroundColor)
 
SLATE_API void SetReadOnlyForegroundColor (const TAttribute< FSlateColor > &InReadOnlyForegroundColor)
 
SLATE_API void SetFocusedForegroundColor (const TAttribute< FSlateColor > &InFocusedForegroundColor)
 
SLATE_API void SetMaximumLength (const TAttribute< int32 > &InMaximumLength)
 
SLATE_API void SetMinimumDesiredWidth (const TAttribute< float > &InMinimumDesiredWidth)
 
SLATE_API void SetIsCaretMovedWhenGainFocus (const TAttribute< bool > &InIsCaretMovedWhenGainFocus)
 
SLATE_API void SetSelectAllTextWhenFocused (const TAttribute< bool > &InSelectAllTextWhenFocused)
 
SLATE_API void SetRevertTextOnEscape (const TAttribute< bool > &InRevertTextOnEscape)
 
SLATE_API void SetClearKeyboardFocusOnCommit (const TAttribute< bool > &InClearKeyboardFocusOnCommit)
 
SLATE_API void SetSelectAllTextOnCommit (const TAttribute< bool > &InSelectAllTextOnCommit)
 
SLATE_API void SetSelectWordOnMouseDoubleClick (const TAttribute< bool > &InSelectWordOnMouseDoubleClick)
 
SLATE_API void SetJustification (const TAttribute< ETextJustify::Type > &InJustification)
 
SLATE_API void SetError (const FText &InError)
 
SLATE_API void SetError (const FString &InError)
 
SLATE_API void SetOnKeyCharHandler (FOnKeyChar InOnKeyCharHandler)
 
SLATE_API void SetOnKeyDownHandler (FOnKeyDown InOnKeyDownHandler)
 
SLATE_API void SetTextShapingMethod (const TOptional< ETextShapingMethod > &InTextShapingMethod)
 
SLATE_API void SetTextFlowDirection (const TOptional< ETextFlowDirection > &InTextFlowDirection)
 
SLATE_API void SetOverflowPolicy (TOptional< ETextOverflowPolicy > InOverflowPolicy)
 
SLATE_API bool AnyTextSelected () const
 
SLATE_API void SelectAllText ()
 
SLATE_API void ClearSelection ()
 
SLATE_API FText GetSelectedText () const
 
SLATE_API void GoTo (const FTextLocation &NewLocation)
 
void GoTo (const ETextLocation NewLocation)
 
SLATE_API void ScrollTo (const FTextLocation &NewLocation)
 
void ScrollTo (const ETextLocation NewLocation)
 
SLATE_API void BeginSearch (const FText &InSearchText, const ESearchCase::Type InSearchCase=ESearchCase::IgnoreCase, const bool InReverse=false)
 
SLATE_API void AdvanceSearch (const bool InReverse=false)
 
SLATE_API void EnableTextInputMethodContext ()
 
SLATE_API bool HasError () const
 
virtual SLATE_API bool SupportsKeyboardFocus () const override
 
virtual SLATE_API bool HasKeyboardFocus () const override
 
virtual SLATE_API FReply OnFocusReceived (const FGeometry &MyGeometry, const FFocusEvent &InFocusEvent) override
 
virtual SLATE_API FReply OnKeyDown (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent) override
 
- Public Member Functions inherited from SBorder
 SLATE_BEGIN_ARGS (SBorder)
 
FArguments & Padding (float Uniform)
 
FArguments & Padding (float Horizontal, float Vertical)
 
FArguments & Padding (float Left, float Top, float Right, float Bottom)
 
SLATE_API SBorder ()
 
virtual SLATE_API ~SBorder ()
 
SLATE_API void Construct (const FArguments &InArgs)
 
virtual SLATE_API void SetContent (TSharedRef< SWidget > InContent)
 
SLATE_API const TSharedRef< SWidget > & GetContent () const
 
SLATE_API void ClearContent ()
 
SLATE_API void SetBorderBackgroundColor (TAttribute< FSlateColor > InColorAndOpacity)
 
FSlateColor GetBorderBackgroundColor () const
 
SLATE_API void SetDesiredSizeScale (TAttribute< FVector2D > InDesiredSizeScale)
 
SLATE_API void SetHAlign (EHorizontalAlignment HAlign)
 
SLATE_API void SetVAlign (EVerticalAlignment VAlign)
 
SLATE_API void SetPadding (TAttribute< FMargin > InPadding)
 
SLATE_API void SetShowEffectWhenDisabled (TAttribute< bool > InShowEffectWhenDisabled)
 
SLATE_API void SetBorderImage (TAttribute< const FSlateBrush * > InBorderImage)
 
const FSlateBrushGetBorderImage () const
 
virtual SLATE_API int32 OnPaint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const override
 
- Public Member Functions inherited from SCompoundWidget
const FVector2D GetContentScale () const
 
void SetContentScale (TAttribute< FVector2D > InContentScale)
 
FLinearColor GetColorAndOpacity () const
 
void SetColorAndOpacity (TAttribute< FLinearColor > InColorAndOpacity)
 
void SetForegroundColor (TAttribute< FSlateColor > InForegroundColor)
 
virtual SLATECORE_API FChildrenGetChildren () override
 
virtual SLATECORE_API void OnArrangeChildren (const FGeometry &AllottedGeometry, FArrangedChildren &ArrangedChildren) const override
 
virtual SLATECORE_API FSlateColor GetForegroundColor () const override
 
virtual SLATECORE_API void SetVisibility (TAttribute< EVisibility > InVisibility) override final
 
- Public Member Functions inherited from SWidget
SLATECORE_API int32 Paint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const
 
virtual SLATECORE_API void Tick (const FGeometry &AllottedGeometry, const double InCurrentTime, const float InDeltaTime)
 
virtual SLATECORE_API void OnFocusLost (const FFocusEvent &InFocusEvent)
 
virtual SLATECORE_API void OnFocusChanging (const FWeakWidgetPath &PreviousFocusPath, const FWidgetPath &NewWidgetPath, const FFocusEvent &InFocusEvent)
 
virtual SLATECORE_API FReply OnKeyChar (const FGeometry &MyGeometry, const FCharacterEvent &InCharacterEvent)
 
virtual SLATECORE_API FReply OnPreviewKeyDown (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent)
 
virtual SLATECORE_API FReply OnKeyUp (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent)
 
virtual SLATECORE_API FReply OnAnalogValueChanged (const FGeometry &MyGeometry, const FAnalogInputEvent &InAnalogInputEvent)
 
virtual SLATECORE_API FReply OnMouseButtonDown (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API FReply OnPreviewMouseButtonDown (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API FReply OnMouseButtonUp (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API FReply OnMouseMove (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API void OnMouseEnter (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API void OnMouseLeave (const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API FReply OnMouseWheel (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API FCursorReply OnCursorQuery (const FGeometry &MyGeometry, const FPointerEvent &CursorEvent) const
 
virtual SLATECORE_API TOptional< TSharedRef< SWidget > > OnMapCursor (const FCursorReply &CursorReply) const
 
virtual SLATECORE_API FReply OnMouseButtonDoubleClick (const FGeometry &InMyGeometry, const FPointerEvent &InMouseEvent)
 
virtual SLATECORE_API bool OnVisualizeTooltip (const TSharedPtr< SWidget > &TooltipContent)
 
virtual SLATECORE_API TSharedPtr< FPopupLayerOnVisualizePopup (const TSharedRef< SWidget > &PopupContent)
 
virtual SLATECORE_API FReply OnDragDetected (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)
 
virtual SLATECORE_API void OnDragEnter (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent)
 
virtual SLATECORE_API void OnDragLeave (const FDragDropEvent &DragDropEvent)
 
virtual SLATECORE_API FReply OnDragOver (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent)
 
virtual SLATECORE_API FReply OnDrop (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent)
 
virtual SLATECORE_API FReply OnTouchGesture (const FGeometry &MyGeometry, const FPointerEvent &GestureEvent)
 
virtual SLATECORE_API FReply OnTouchStarted (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)
 
virtual SLATECORE_API FReply OnTouchMoved (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)
 
virtual SLATECORE_API FReply OnTouchEnded (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)
 
virtual SLATECORE_API FReply OnTouchForceChanged (const FGeometry &MyGeometry, const FPointerEvent &TouchEvent)
 
virtual SLATECORE_API FReply OnTouchFirstMove (const FGeometry &MyGeometry, const FPointerEvent &TouchEvent)
 
virtual SLATECORE_API FReply OnMotionDetected (const FGeometry &MyGeometry, const FMotionEvent &InMotionEvent)
 
virtual SLATECORE_API TOptional< boolOnQueryShowFocus (const EFocusCause InFocusCause) const
 
virtual SLATECORE_API FPopupMethodReply OnQueryPopupMethod () const
 
virtual SLATECORE_API TOptional< FVirtualPointerPositionTranslateMouseCoordinateForCustomHitTestChild (const SWidget &ChildWidget, const FGeometry &MyGeometry, const FVector2D ScreenSpaceMouseCoordinate, const FVector2D LastScreenSpaceMouseCoordinate) const
 
virtual SLATECORE_API void OnFinishedPointerInput ()
 
virtual SLATECORE_API void OnFinishedKeyInput ()
 
virtual SLATECORE_API FNavigationReply OnNavigation (const FGeometry &MyGeometry, const FNavigationEvent &InNavigationEvent)
 
virtual SLATECORE_API EWindowZone::Type GetWindowZoneOverride () const
 
bool NeedsPrepass () const
 
SLATECORE_API void SlatePrepass ()
 
SLATECORE_API void SlatePrepass (float InLayoutScaleMultiplier)
 
void SetCanTick (bool bInCanTick)
 
bool GetCanTick () const
 
bool HasRegisteredSlateAttribute () const
 
bool IsAttributesUpdatesEnabled () const
 
const FSlateWidgetPersistentStateGetPersistentState () const
 
const FWidgetProxyHandle GetProxyHandle () const
 
SLATECORE_API UE::Slate::FDeprecateVector2DResult GetDesiredSize () const
 
SLATECORE_API void AssignParentWidget (TSharedPtr< SWidget > InParent)
 
SLATECORE_API bool ConditionallyDetatchParentWidget (SWidget *InExpectedParent)
 
virtual bool ValidatePathToChild (SWidget *InChild)
 
bool IsParentValid () const
 
TSharedPtr< SWidgetGetParentWidget () const
 
TSharedPtr< SWidgetAdvanced_GetPaintParentWidget () const
 
SLATECORE_API FSlateRect CalculateCullingAndClippingRules (const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, bool &bClipToBounds, bool &bAlwaysClip, bool &bIntersectClipBounds) const
 
bool HasAnyUpdateFlags (EWidgetUpdateFlags FlagsToCheck) const
 
TStatId GetStatID (bool bForDeferredUse=false) const
 
virtual SLATECORE_API float GetRelativeLayoutScale (const int32 ChildIndex, float LayoutScaleMultiplier) const
 
SLATECORE_API void ArrangeChildren (const FGeometry &AllottedGeometry, FArrangedChildren &ArrangedChildren, bool bUpdateAttributes=false) const
 
virtual FChildrenGetAllChildren ()
 
SLATECORE_API TOptional< EFocusCauseHasUserFocus (int32 UserIndex) const
 
SLATECORE_API TOptional< EFocusCauseHasAnyUserFocus () const
 
SLATECORE_API bool HasUserFocusedDescendants (int32 UserIndex) const
 
SLATECORE_API bool HasFocusedDescendants () const
 
SLATECORE_API bool HasAnyUserFocusOrFocusedDescendants () const
 
SLATECORE_API bool HasMouseCapture () const
 
SLATECORE_API bool HasMouseCaptureByUser (int32 UserIndex, TOptional< int32 > PointerIndex=TOptional< int32 >()) const
 
virtual SLATECORE_API void OnMouseCaptureLost (const FCaptureLostEvent &CaptureLostEvent)
 
void SetEnabled (TAttribute< bool > InEnabledState)
 
bool IsEnabled () const
 
virtual bool IsInteractable () const
 
virtual SLATECORE_API TSharedPtr< IToolTipGetToolTip ()
 
virtual SLATECORE_API void OnToolTipClosing ()
 
SLATECORE_API void EnableToolTipForceField (const bool bEnableForceField)
 
bool HasToolTipForceField () const
 
bool IsHovered () const
 
SLATECORE_API bool IsDirectlyHovered () const
 
EVisibility GetVisibility () const
 
bool IsVolatile () const
 
bool IsVolatileIndirectly () const
 
void ForceVolatile (bool bForce)
 
bool ShouldInvalidatePrepassDueToVolatility ()
 
SLATECORE_API void Invalidate (EInvalidateWidgetReason InvalidateReason)
 
void CacheVolatility ()
 
void MarkPrepassAsDirty ()
 
float GetRenderOpacity () const
 
void SetRenderOpacity (float InRenderOpacity)
 
void SetTag (FName InTag)
 
const TOptional< FSlateRenderTransform > & GetRenderTransform () const
 
TOptional< FSlateRenderTransformGetRenderTransformWithRespectToFlowDirection () const
 
UE::Slate::FDeprecateVector2DResult GetRenderTransformPivotWithRespectToFlowDirection () const
 
void SetRenderTransform (TAttribute< TOptional< FSlateRenderTransform > > InTransform)
 
UE::Slate::FDeprecateVector2DResult GetRenderTransformPivot () const
 
void SetRenderTransformPivot (TAttribute< FVector2D > InTransformPivot)
 
SLATECORE_API void SetClipping (EWidgetClipping InClipping)
 
EWidgetClipping GetClipping () const
 
SLATECORE_API void SetPixelSnapping (EWidgetPixelSnapping InPixelSnappingMethod)
 
EWidgetPixelSnapping GetPixelSnapping () const
 
void SetCullingBoundsExtension (const FMargin &InCullingBoundsExtension)
 
FMargin GetCullingBoundsExtension () const
 
void SetFlowDirectionPreference (EFlowDirectionPreference InFlowDirectionPreference)
 
EFlowDirectionPreference GetFlowDirectionPreference () const
 
SLATECORE_API void SetToolTipText (const TAttribute< FText > &ToolTipText)
 
SLATECORE_API void SetToolTipText (const FText &InToolTipText)
 
SLATECORE_API void SetToolTip (const TAttribute< TSharedPtr< IToolTip > > &InToolTip)
 
SLATECORE_API void SetCursor (const TAttribute< TOptional< EMouseCursor::Type > > &InCursor)
 
template<typename MetaDataType >
TSharedPtr< MetaDataType > GetMetaData () const
 
template<typename MetaDataType >
TArray< TSharedRef< MetaDataType > > GetAllMetaData () const
 
template<typename MetaDataType >
void AddMetadata (const TSharedRef< MetaDataType > &AddMe)
 
template<typename MetaDataType >
int32 RemoveMetaData (const TSharedRef< MetaDataType > &RemoveMe)
 
SLATECORE_API void SetOnMouseButtonDown (FPointerEventHandler EventHandler)
 
SLATECORE_API void SetOnMouseButtonUp (FPointerEventHandler EventHandler)
 
SLATECORE_API void SetOnMouseMove (FPointerEventHandler EventHandler)
 
SLATECORE_API void SetOnMouseDoubleClick (FPointerEventHandler EventHandler)
 
SLATECORE_API void SetOnMouseEnter (FNoReplyPointerEventHandler EventHandler)
 
SLATECORE_API void SetOnMouseLeave (FSimpleNoReplyPointerEventHandler EventHandler)
 
virtual SLATECORE_API FString ToString () const
 
SLATECORE_API FString GetTypeAsString () const
 
SLATECORE_API FName GetType () const
 
virtual SLATECORE_API FString GetReadableLocation () const
 
SLATECORE_API FName GetCreatedInLocation () const
 
virtual SLATECORE_API FName GetTag () const
 
virtual SLATECORE_API FSlateColor GetDisabledForegroundColor () const
 
SLATECORE_API const FGeometryGetCachedGeometry () const
 
SLATECORE_API const FGeometryGetTickSpaceGeometry () const
 
SLATECORE_API const FGeometryGetPaintSpaceGeometry () const
 
const TOptional< FSlateClippingState > & GetCurrentClippingState () const
 
virtual bool Advanced_IsWindow () const
 
virtual bool Advanced_IsInvalidationRoot () const
 
virtual const FSlateInvalidationRootAdvanced_AsInvalidationRoot () const
 
SLATECORE_API TSharedRef< FActiveTimerHandleRegisterActiveTimer (float TickPeriod, FWidgetActiveTimerDelegate TickFunction)
 
SLATECORE_API void UnRegisterActiveTimer (const TSharedRef< FActiveTimerHandle > &ActiveTimerHandle)
 
bool HasActiveTimers () const
 
- Public Member Functions inherited from FSlateControlledConstruction
 FSlateControlledConstruction ()=default
 
virtual ~FSlateControlledConstruction ()=default
 
virtual const FSlateWidgetClassDataGetWidgetClass () const =0
 
void operator delete (void *mem)
 
- Public Member Functions inherited from TSharedFromThis< SWidget >
TSharedRef< SWidget, Mode > AsShared ()
 
TSharedRef< SWidget const, Mode > AsShared () const
 
TSharedRef< SubobjectType, Mode > AsSharedSubobject (SubobjectType *SubobjectPtr) const
 
TWeakPtr< SWidget, Mode > AsWeak ()
 
TWeakPtr< SWidget const, Mode > AsWeak () const
 
TWeakPtr< SubobjectType, Mode > AsWeakSubobject (SubobjectType *SubobjectPtr) const
 
void UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const *InSharedPtr, OtherType *InObject) const
 
void UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const *InSharedRef, OtherType *InObject) const
 
UE_FORCEINLINE_HINT bool DoesSharedInstanceExist () const
 

Protected Member Functions

SLATE_API void OnEditableTextChanged (const FText &InText)
 
SLATE_API void OnEditableTextCommitted (const FText &InText, ETextCommit::Type InCommitType)
 
- Protected Member Functions inherited from SBorder
virtual SLATE_API FVector2D ComputeDesiredSize (float) const override
 
bool GetShowDisabledEffect () const
 
FVector2D GetDesiredSizeScale () const
 
TSlateAttributeRef< const FSlateBrush * > GetBorderImageAttribute () const
 
TSlateAttributeRef< FSlateColorGetBorderBackgroundColorAttribute () const
 
TSlateAttributeRef< FVector2DGetDesiredSizeScaleAttribute () const
 
TSlateAttributeRef< boolGetShowDisabledEffectAttribute () const
 
- Protected Member Functions inherited from SCompoundWidget
TSlateAttributeRef< FVector2DGetContentScaleAttribute () const
 
TSlateAttributeRef< FLinearColorGetColorAndOpacityAttribute () const
 
TSlateAttributeRef< FSlateColorGetForegroundColorAttribute () const
 
SLATECORE_API SCompoundWidget ()
 
virtual SLATECORE_API ~SCompoundWidget ()
 
- Protected Member Functions inherited from SWidget
void SetVolatilePrepass (bool bVolatile)
 
virtual bool CustomPrepass (float LayoutScaleMultiplier)
 
virtual SLATECORE_API void CacheDesiredSize (float InLayoutScaleMultiplier)
 
void SetHover (TAttribute< bool > InHovered)
 
bool IsChildWidgetCulled (const FSlateRect &, const FArrangedWidget &) const
 
SLATECORE_API void InvalidateChildRemovedFromTree (SWidget &Child)
 
bool Advanced_InvalidateVolatility ()
 
EFlowDirection ComputeFlowDirection () const
 
SLATECORE_API void SetDebugInfo (const ANSICHAR *InType, const ANSICHAR *InFile, int32 OnLine, size_t InAllocSize)
 
virtual SLATECORE_API TOptional< EMouseCursor::TypeGetCursor () const
 
SLATECORE_API SWidget ()
 
SLATECORE_API void SWidgetConstruct (const FSlateBaseNamedArgs &Args)
 
bool IsConstructed () const
 
SLATECORE_API bool FindChildGeometries (const FGeometry &MyGeometry, const TSet< TSharedRef< SWidget > > &WidgetsToFind, TMap< TSharedRef< SWidget >, FArrangedWidget > &OutResult) const
 
SLATECORE_API void FindChildGeometries_Helper (const FGeometry &MyGeometry, const TSet< TSharedRef< SWidget > > &WidgetsToFind, TMap< TSharedRef< SWidget >, FArrangedWidget > &OutResult) const
 
SLATECORE_API FGeometry FindChildGeometry (const FGeometry &MyGeometry, TSharedRef< SWidget > WidgetToFind) const
 
bool ShouldBeEnabled (bool InParentEnabled) const
 
virtual SLATECORE_API const FSlateBrushGetFocusBrush () const
 
virtual bool ComputeVolatility () const
 
virtual SLATECORE_API void OnClippingChanged ()
 
float GetPrepassLayoutScaleMultiplier () const
 
SLATECORE_API void Prepass_ChildLoop (float InLayoutScaleMultiplier, FChildren *MyChildren)
 
template<typename TargetValueType , typename SourceValueType >
bool SetAttribute (TAttribute< TargetValueType > &TargetValue, const TAttribute< SourceValueType > &SourceValue, EInvalidateWidgetReason BaseInvalidationReason)
 
TSlateAttributeRef< boolGetEnabledStateAttribute () const
 
TSlateAttributeRef< boolGetHoveredAttribute () const
 
TSlateAttributeRef< EVisibilityGetVisibilityAttribute () const
 
TSlateAttributeRef< TOptional< FSlateRenderTransform > > GetRenderTransformAttribute () const
 
TSlateAttributeRef< FVector2DGetRenderTransformPivotAttribute () const
 
virtual SLATECORE_API ~SWidget ()
 
- Protected Member Functions inherited from TSharedFromThis< SWidget >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
UE_FORCEINLINE_HINT TSharedFromThisoperator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 

Protected Attributes

const FEditableTextBoxStyleStyle
 
TSharedPtr< SBoxPaddingBox
 
TSharedPtr< SEditableTextEditableText
 
TAttribute< FMarginPaddingOverride
 
TAttribute< FSlateFontInfoFontOverride
 
TAttribute< FSlateColorForegroundColorOverride
 
TAttribute< FSlateColorBackgroundColorOverride
 
TAttribute< FSlateColorReadOnlyForegroundColorOverride
 
TAttribute< FSlateColorFocusedForegroundColorOverride
 
TAttribute< int32MaximumLength
 
TSharedPtr< SHorizontalBoxBox
 
TSharedPtr< class IErrorReportingWidgetErrorReporting
 
FOnTextChanged OnTextChanged
 
FOnTextCommitted OnTextCommitted
 
FOnVerifyTextChanged OnVerifyTextChanged
 
- Protected Attributes inherited from SCompoundWidget
FCompoundWidgetOneChildSlot ChildSlot
 
- Protected Attributes inherited from SWidget
uint8 bCanSupportFocus: 1
 
uint8 bCanHaveChildren: 1
 
uint8 bClippingProxy: 1
 
uint8 bHasCustomPrepass: 1
 
uint8 bHasRelativeLayoutScale: 1
 
uint8 bVolatilityAlwaysInvalidatesPrepass: 1
 
EWidgetClipping Clipping
 
EWidgetPixelSnapping PixelSnappingMethod
 
FMargin CullingBoundsExtension
 
float RenderOpacity
 

Additional Inherited Members

- Static Public Member Functions inherited from FSlateControlledConstruction
static const FSlateWidgetClassDataStaticWidgetClass ()
 
- Static Protected Member Functions inherited from SWidget
static SLATECORE_API int32 FindChildUnderMouse (const FArrangedChildren &Children, const FPointerEvent &MouseEvent)
 
static SLATECORE_API int32 FindChildUnderPosition (const FArrangedChildren &Children, const UE::Slate::FDeprecateVector2DParameter &ArrangedSpacePosition)
 
static TAttribute< EVisibilityAccessWidgetVisibilityAttribute (const TSharedRef< SWidget > &Widget)
 
- Static Protected Member Functions inherited from TSharedFromThis< SWidget >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode > SharedThis (OtherType *ThisPtr)
 
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode > SharedThis (const OtherType *ThisPtr)
 

Detailed Description

Editable text box widget

Constructor & Destructor Documentation

◆ SEditableTextBox()

SEditableTextBox::SEditableTextBox ( )

The styling of the textbox Sets the text content for this editable text box widget Hint text that appears when there is no text in the text box Text to search for (a new search is triggered whenever this text changes) Font color and opacity (overrides Style) Text color and opacity (overrides Style) Text color and opacity when read-only (overrides Style) Text color and opacity when this box has keyboard focus (overrides Style) Sets whether this text box can actually be modified interactively by the user Sets whether this text box is for storing a password Workaround as we loose focus when the auto completion closes. Whether to select all text when the user clicks to give focus on the widget Whether to allow the user to back out of changes when they press the escape key Whether to clear keyboard focus when pressing enter to commit changes How should the value be justified in the editable text field. Maximum length of the text. Input will refuse text longer than that. Whether the context menu can be opened Delegate to call before a context menu is opened. User returns the menu content or null to the disable context menu Menu extender for the right-click context menu Callback when the text starts to be edited Called whenever the text is changed programmatically or interactively by the user Called whenever the text is committed. This happens when the user presses enter or the text box loses focus. Called whenever the text is changed programmatically or interactively by the user Minimum width that a text block should be Whether to select all text when pressing enter to commit changes Whether to select word on mouse double click on the widget Callback delegate to have first chance handling of the OnKeyChar event Callback delegate to have first chance handling of the OnKeyDown event The color of the background/border around the editable text (overrides Style) Padding between the box/border and the text widget inside (overrides Style) Provide a alternative mechanism for error reporting. The type of virtual keyboard to use on mobile devices Additional options for the virtual keyboard summoned by this widget The type of event that will trigger the display of the virtual keyboard The message action to take when the virtual keyboard is dismissed by the user Which text shaping method should we use? (unset to use the default returned by GetDefaultTextShapingMethod) Which text flow direction should we use? (unset to use the default returned by GetDefaultTextFlowDirection) Determines what happens to text that is clipped and doesnt fit within the allotted area for this text box

◆ ~SEditableTextBox()

SEditableTextBox::~SEditableTextBox ( )
virtualdefault

Member Function Documentation

◆ AdvanceSearch()

void SEditableTextBox::AdvanceSearch ( const bool  InReverse = false)

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

◆ AnyTextSelected()

bool SEditableTextBox::AnyTextSelected ( ) const

Query to see if any text is selected within the document

◆ BeginSearch()

void SEditableTextBox::BeginSearch ( const FText InSearchText,
const ESearchCase::Type  InSearchCase = ESearchCase::IgnoreCase,
const bool  InReverse = false 
)

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

◆ ClearSelection()

void SEditableTextBox::ClearSelection ( )

Clear the active text selection

◆ Construct()

void SEditableTextBox::Construct ( const FArguments &  InArgs)

Construct this widget

Parameters
InArgsThe declaration data for this widget

◆ EnableTextInputMethodContext()

void SEditableTextBox::EnableTextInputMethodContext ( )

Register and activate the IME context for the text layout of this textbox

◆ GetHintText()

FText SEditableTextBox::GetHintText ( ) const
inline

Returns the Hint text string

Returns
Hint Text string

◆ GetSearchText()

FText SEditableTextBox::GetSearchText ( ) const

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

◆ GetSelectedText()

FText SEditableTextBox::GetSelectedText ( ) const

Get the currently selected text

◆ GetText()

FText SEditableTextBox::GetText ( ) const
inline

Returns the text string

Returns
Text string

◆ GoTo() [1/2]

void SEditableTextBox::GoTo ( const ETextLocation  NewLocation)
inline

Move the cursor to the specified location

◆ GoTo() [2/2]

void SEditableTextBox::GoTo ( const FTextLocation NewLocation)

Move the cursor to the given location in the document

◆ HasError()

bool SEditableTextBox::HasError ( ) const

◆ HasKeyboardFocus()

bool SEditableTextBox::HasKeyboardFocus ( ) const
overridevirtual

Checks to see if this widget currently has the keyboard focus

Returns
True if this widget has keyboard focus

Reimplemented from SWidget.

◆ IsPassword()

bool SEditableTextBox::IsPassword ( ) const
inline

◆ IsReadOnly()

bool SEditableTextBox::IsReadOnly ( ) const
inline

◆ OnEditableTextChanged()

void SEditableTextBox::OnEditableTextChanged ( const FText InText)
protected

Callback for the editable text's OnTextChanged event

◆ OnEditableTextCommitted()

void SEditableTextBox::OnEditableTextCommitted ( const FText InText,
ETextCommit::Type  InCommitType 
)
protected

Callback when the editable text is committed.

◆ OnFocusReceived()

FReply SEditableTextBox::OnFocusReceived ( const FGeometry MyGeometry,
const FFocusEvent InFocusEvent 
)
overridevirtual

Called when focus is given to this widget. This event does not bubble.

Parameters
MyGeometryThe Geometry of the widget receiving the event
InFocusEventThe FocusEvent
Returns
Returns whether the event was handled, along with other possible actions

Reimplemented from SWidget.

◆ OnKeyDown()

FReply SEditableTextBox::OnKeyDown ( const FGeometry MyGeometry,
const FKeyEvent InKeyEvent 
)
overridevirtual

Called after a key is pressed when this widget has focus (this event bubbles if not handled)

Parameters
MyGeometryThe Geometry of the widget receiving the event
InKeyEventKey event
Returns
Returns whether the event was handled, along with other possible actions

Reimplemented from SWidget.

◆ ScrollTo() [1/2]

void SEditableTextBox::ScrollTo ( const ETextLocation  NewLocation)
inline

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

◆ ScrollTo() [2/2]

void SEditableTextBox::ScrollTo ( const FTextLocation NewLocation)

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

◆ SelectAllText()

void SEditableTextBox::SelectAllText ( )

Select all the text in the document

◆ SetAllowContextMenu()

void SEditableTextBox::SetAllowContextMenu ( TAttribute< bool InAllowContextMenu)

See the AllowContextMenu attribute

◆ SetClearKeyboardFocusOnCommit()

void SEditableTextBox::SetClearKeyboardFocusOnCommit ( const TAttribute< bool > &  InClearKeyboardFocusOnCommit)

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

Parameters
InClearKeyboardFocusOnCommitClear keyboard focus when pressing enter?

◆ SetError() [1/2]

void SEditableTextBox::SetError ( const FString &  InError)

◆ SetError() [2/2]

void SEditableTextBox::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.

◆ SetFocusedForegroundColor()

void SEditableTextBox::SetFocusedForegroundColor ( const TAttribute< FSlateColor > &  InFocusedForegroundColor)

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

Parameters
InFocusedForegroundColorThe focused color and opacity

◆ SetFont()

void SEditableTextBox::SetFont ( const TAttribute< FSlateFontInfo > &  InFont)

Sets the font used to draw the text

Parameters
InFontThe new font to use

◆ SetHintText()

void SEditableTextBox::SetHintText ( const TAttribute< FText > &  InHintText)

See the HintText attribute

◆ SetIsCaretMovedWhenGainFocus()

void SEditableTextBox::SetIsCaretMovedWhenGainFocus ( const TAttribute< bool > &  InIsCaretMovedWhenGainFocus)

Workaround as we loose focus when the auto completion closes.

Parameters
InIsCaretMovedWhenGainFocusWorkaround

◆ SetIsPassword()

void SEditableTextBox::SetIsPassword ( TAttribute< bool InIsPassword)

See the IsPassword attribute

◆ SetIsReadOnly()

void SEditableTextBox::SetIsReadOnly ( TAttribute< bool InIsReadOnly)

See the IsReadOnly attribute

◆ SetJustification()

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

See Justification attribute

◆ SetMaximumLength()

void SEditableTextBox::SetMaximumLength ( const TAttribute< int32 > &  InMaximumLength)

Sets the maximum text length that will be accepted by the widget

Parameters
InMaximumLengthLength to check for. Only values superior to 0 will be taken into account, otherwise no length check will occur.

◆ SetMinimumDesiredWidth()

void SEditableTextBox::SetMinimumDesiredWidth ( const TAttribute< float > &  InMinimumDesiredWidth)

Sets the minimum width that a text box should be.

Parameters
InMinimumDesiredWidthThe minimum width

◆ SetOnKeyCharHandler()

void SEditableTextBox::SetOnKeyCharHandler ( FOnKeyChar  InOnKeyCharHandler)

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

Parameters
InOnKeyCharHandlerDelegate to call during OnKeyChar event

◆ SetOnKeyDownHandler()

void SEditableTextBox::SetOnKeyDownHandler ( FOnKeyDown  InOnKeyDownHandler)

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

Parameters
InOnKeyDownHandlerDelegate to call during OnKeyDown event

◆ SetOverflowPolicy()

void SEditableTextBox::SetOverflowPolicy ( TOptional< ETextOverflowPolicy InOverflowPolicy)

Sets the overflow policy for this text block

◆ SetReadOnlyForegroundColor()

void SEditableTextBox::SetReadOnlyForegroundColor ( const TAttribute< FSlateColor > &  InReadOnlyForegroundColor)

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

Parameters
InReadOnlyForegroundColorThe read-only text color and opacity

◆ SetRevertTextOnEscape()

void SEditableTextBox::SetRevertTextOnEscape ( const TAttribute< bool > &  InRevertTextOnEscape)

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

Parameters
InRevertTextOnEscapeAllow the user to back out of changes?

◆ SetSearchText()

void SEditableTextBox::SetSearchText ( const TAttribute< FText > &  InSearchText)

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

◆ SetSelectAllTextOnCommit()

void SEditableTextBox::SetSelectAllTextOnCommit ( const TAttribute< bool > &  InSelectAllTextOnCommit)

Sets whether to select all text when pressing enter to commit changes

Parameters
InSelectAllTextOnCommitSelect all text when pressing enter?

◆ SetSelectAllTextWhenFocused()

void SEditableTextBox::SetSelectAllTextWhenFocused ( const TAttribute< bool > &  InSelectAllTextWhenFocused)

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

Parameters
InSelectAllTextWhenFocusedSelect all text when the user clicks?

◆ SetSelectWordOnMouseDoubleClick()

void SEditableTextBox::SetSelectWordOnMouseDoubleClick ( const TAttribute< bool > &  InSelectWordOnMouseDoubleClick)

Sets whether to select select word on mouse double click

Parameters
InSelectWordOnMouseDoubleClickSelect select word on mouse double click?

◆ SetStyle()

void SEditableTextBox::SetStyle ( const FEditableTextBoxStyle InStyle)

See attribute Style

◆ SetText()

void SEditableTextBox::SetText ( const TAttribute< FText > &  InNewText)

Sets the text string currently being edited

Parameters
InNewTextThe new text string

◆ SetTextBlockStyle()

void SEditableTextBox::SetTextBlockStyle ( const FTextBlockStyle InTextStyle)

Sets the text block style currently used

Parameters
InTextStyleThe new text string

◆ SetTextBoxBackgroundColor()

void SEditableTextBox::SetTextBoxBackgroundColor ( const TAttribute< FSlateColor > &  InBackgroundColor)

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

Parameters
InBackgroundColorThe background/border color

◆ SetTextBoxForegroundColor()

void SEditableTextBox::SetTextBoxForegroundColor ( const TAttribute< FSlateColor > &  InForegroundColor)

Sets the text color and opacity (overrides Style)

Parameters
InForegroundColorThe text color and opacity

◆ SetTextFlowDirection()

void SEditableTextBox::SetTextFlowDirection ( const TOptional< ETextFlowDirection > &  InTextFlowDirection)

See TextFlowDirection attribute

◆ SetTextShapingMethod()

void SEditableTextBox::SetTextShapingMethod ( const TOptional< ETextShapingMethod > &  InTextShapingMethod)

See TextShapingMethod attribute

◆ SetVirtualKeyboardDismissAction()

void SEditableTextBox::SetVirtualKeyboardDismissAction ( TAttribute< EVirtualKeyboardDismissAction InVirtualKeyboardDismissAction)

Set the VirtualKeyboardDismissAction attribute

◆ SLATE_BEGIN_ARGS()

SEditableTextBox::SLATE_BEGIN_ARGS ( SEditableTextBox  )
inline

◆ SupportsKeyboardFocus()

bool SEditableTextBox::SupportsKeyboardFocus ( ) const
overridevirtual

Checks to see if this widget supports keyboard focus. Override this in derived classes.

Returns
True if this widget can take keyboard focus

Reimplemented from SWidget.

Member Data Documentation

◆ BackgroundColorOverride

TAttribute<FSlateColor> SEditableTextBox::BackgroundColorOverride
protected

Background color (overrides style)

◆ Box

TSharedPtr<SHorizontalBox> SEditableTextBox::Box
protected

Allows for inserting additional widgets that extend the functionality of the text box

◆ EditableText

TSharedPtr< SEditableText > SEditableTextBox::EditableText
protected

Editable text widget

◆ ErrorReporting

TSharedPtr<class IErrorReportingWidget> SEditableTextBox::ErrorReporting
protected

SomeWidget reporting

◆ FocusedForegroundColorOverride

TAttribute<FSlateColor> SEditableTextBox::FocusedForegroundColorOverride
protected

Focused foreground color (overrides style)

◆ FontOverride

TAttribute<FSlateFontInfo> SEditableTextBox::FontOverride
protected

Font (overrides style)

◆ ForegroundColorOverride

TAttribute<FSlateColor> SEditableTextBox::ForegroundColorOverride
protected

Foreground color (overrides style)

◆ MaximumLength

TAttribute<int32> SEditableTextBox::MaximumLength
protected

Maximum text length that will be accepted by the widget

◆ OnTextChanged

FOnTextChanged SEditableTextBox::OnTextChanged
protected

Called when the text is changed interactively

◆ OnTextCommitted

FOnTextCommitted SEditableTextBox::OnTextCommitted
protected

Called when the user commits their change to the editable text control

◆ OnVerifyTextChanged

FOnVerifyTextChanged SEditableTextBox::OnVerifyTextChanged
protected

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

◆ PaddingBox

TSharedPtr< SBox > SEditableTextBox::PaddingBox
protected

Box widget that adds padding around the editable text

◆ PaddingOverride

TAttribute<FMargin> SEditableTextBox::PaddingOverride
protected

Padding (overrides style)

◆ ReadOnlyForegroundColorOverride

TAttribute<FSlateColor> SEditableTextBox::ReadOnlyForegroundColorOverride
protected

Read-only foreground color (overrides style)

◆ Style

const FEditableTextBoxStyle* SEditableTextBox::Style
protected

The documentation for this class was generated from the following files: