SEditableText.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Misc/Attribute.h"
#include "Styling/SlateColor.h"
#include "Fonts/SlateFontInfo.h"
#include "Input/CursorReply.h"
#include "Input/Reply.h"
#include "Layout/Visibility.h"
#include "Widgets/DeclarativeSyntaxSupport.h"
#include "Widgets/SWidget.h"
#include "Styling/SlateTypes.h"
#include "Styling/CoreStyle.h"
#include "Styling/SlateWidgetStyleAsset.h"
#include "Framework/SlateDelegates.h"
#include "Framework/MultiBox/MultiBoxExtender.h"
#include "Framework/Text/TextLayout.h"
#include "Widgets/Text/ISlateEditableTextWidget.h"
 
class FActiveTimerHandle;
class FArrangedChildren;
class FChildren;
class FPaintArgs;
class FPlainTextLayoutMarshaller;
class FSlateEditableTextLayout;
class FSlateWindowElementList;
class IBreakIterator;
struct FTextLocation;
enum class ETextFlowDirection : uint8;
enum class ETextShapingMethod : uint8;
 
class SEditableText : public SWidget, public ISlateEditableTextWidget
{
public:
    SLATE_BEGIN_ARGS( SEditableText )
        : _Text()
        , _HintText()
        , _SearchText()
        , _Style(&FCoreStyle::Get().GetWidgetStyle< FEditableTextStyle >("NormalEditableText"))
        , _Font()
        , _ColorAndOpacity()
        , _BackgroundImageSelected()
        , _BackgroundImageComposing()
        , _CaretImage()
        , _IsReadOnly( false )
        , _IsPassword( false )
        , _IsCaretMovedWhenGainFocus( true )
        , _SelectAllTextWhenFocused( false )
        , _SelectWordOnMouseDoubleClick(true)
        , _RevertTextOnEscape( false )
        , _ClearKeyboardFocusOnCommit(true)
        , _Justification(ETextJustify::Left)
        , _AllowContextMenu(true)
        , _MinDesiredWidth(0.0f)
        , _SelectAllTextOnCommit( false )
        , _VirtualKeyboardType(EKeyboardType::Keyboard_Default)
        , _VirtualKeyboardOptions(FVirtualKeyboardOptions())
        , _VirtualKeyboardTrigger(EVirtualKeyboardTrigger::OnFocusByPointer)
        , _VirtualKeyboardDismissAction(EVirtualKeyboardDismissAction::TextChangeOnDismiss)
        , _TextShapingMethod()
        , _TextFlowDirection()
        , _OverflowPolicy()
        {
            _Clipping = EWidgetClipping::ClipToBounds;
        }
 
        SLATE_ATTRIBUTE( FText, Text )
 
        
        SLATE_ATTRIBUTE( FText, HintText )
 
        
        SLATE_ATTRIBUTE( FText, SearchText )
 
        
        SLATE_STYLE_ARGUMENT( FEditableTextStyle, Style )
 
        
        SLATE_ATTRIBUTE( FSlateFontInfo, Font )
 
        
        SLATE_ATTRIBUTE( FSlateColor, ColorAndOpacity )
 
        
        SLATE_ATTRIBUTE( const FSlateBrush*, BackgroundImageSelected )
 
        
        SLATE_ATTRIBUTE( const FSlateBrush*, BackgroundImageComposing )
 
        
        SLATE_ATTRIBUTE( const FSlateBrush*, CaretImage )
 
        
        SLATE_ATTRIBUTE( bool, IsReadOnly )
 
        
        SLATE_ATTRIBUTE( bool, IsPassword )
 
        
        SLATE_ATTRIBUTE( bool, IsCaretMovedWhenGainFocus )
 
        
        SLATE_ATTRIBUTE( bool, SelectAllTextWhenFocused )
 
        
        SLATE_ATTRIBUTE(bool, SelectWordOnMouseDoubleClick)
 
        
        SLATE_ATTRIBUTE( bool, RevertTextOnEscape )
 
        
        SLATE_ATTRIBUTE( bool, ClearKeyboardFocusOnCommit )
 
        
        SLATE_ATTRIBUTE(ETextJustify::Type, Justification)
 
        
        SLATE_ATTRIBUTE(bool, AllowContextMenu)
    
        
        SLATE_ATTRIBUTE(bool, EnableIntegratedKeyboard)
 
        
        SLATE_EVENT(FOnContextMenuOpening, OnContextMenuOpening)
 
        
        SLATE_EVENT( FOnIsTypedCharValid, OnIsTypedCharValid )
 
        
        SLATE_EVENT( FOnBeginTextEdit, OnBeginTextEdit )
 
        
        SLATE_EVENT( FOnTextChanged, OnTextChanged )
 
        
        SLATE_EVENT( FOnTextCommitted, OnTextCommitted )
 
        
        SLATE_ATTRIBUTE( float, MinDesiredWidth )
 
        
        SLATE_ATTRIBUTE( bool, SelectAllTextOnCommit )
 
        
        SLATE_EVENT(FOnKeyChar, OnKeyCharHandler)
 
        
        SLATE_EVENT(FOnKeyDown, OnKeyDownHandler)
 
        
        SLATE_EVENT( FMenuExtensionDelegate, ContextMenuExtender )
 
        
        SLATE_ATTRIBUTE( EKeyboardType, VirtualKeyboardType)
 
        
        SLATE_ARGUMENT( FVirtualKeyboardOptions, VirtualKeyboardOptions )
 
        
        SLATE_ATTRIBUTE( EVirtualKeyboardTrigger, VirtualKeyboardTrigger )
 
        
        SLATE_ATTRIBUTE( EVirtualKeyboardDismissAction, VirtualKeyboardDismissAction )
 
        
        SLATE_ARGUMENT(TOptional<ETextShapingMethod>, TextShapingMethod)
 
        
        SLATE_ARGUMENT(TOptional<ETextFlowDirection>, TextFlowDirection)
        
        
        SLATE_ARGUMENT(TOptional<ETextOverflowPolicy>, OverflowPolicy)
    SLATE_END_ARGS()
 
    
    SLATE_API SEditableText();
 
    SLATE_API ~SEditableText();
 
    SLATE_API void Construct( const FArguments& InArgs );
 
    SLATE_API void SetText( const TAttribute< FText >& InNewText );
    
    SLATE_API FText GetText() const;
 
    SLATE_API bool SetEditableText(const FText& InNewText);
 
    SLATE_API void SetHintText( const TAttribute< FText >& InHintText );
    
    SLATE_API FText GetHintText() const;
 
    SLATE_API void SetSearchText(const TAttribute<FText>& InSearchText);
 
    SLATE_API FText GetSearchText() const;
 
    SLATE_API void SetIsReadOnly( TAttribute< bool > InIsReadOnly );
    
    SLATE_API void SetIsPassword( TAttribute< bool > InIsPassword );
    
    SLATE_API void SetColorAndOpacity(TAttribute<FSlateColor> Color);
 
    SLATE_API void SetAllowContextMenu(const TAttribute< bool >& InAllowContextMenu);
 
    SLATE_API void SetEnableIntegratedKeyboard(const TAttribute< bool >& InEnableIntegratedKeyboard);
 
    SLATE_API void SetVirtualKeyboardDismissAction(TAttribute< EVirtualKeyboardDismissAction > InVirtualKeyboardDismissAction);
 
    SLATE_API void SetFont(const TAttribute< FSlateFontInfo >& InNewFont);
 
    SLATE_API FSlateFontInfo GetFont() const;
 
    SLATE_API void SetTextStyle( const FEditableTextStyle& InNewTextStyle );
 
    SLATE_API void SetTextBlockStyle(const FTextBlockStyle* InTextStyle);
 
    SLATE_API void SetMinDesiredWidth(const TAttribute<float>& InMinDesiredWidth);
 
    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);
    void SetOnKeyCharHandler(FOnKeyChar InOnKeyCharHandler)
    {
        OnKeyCharHandler = InOnKeyCharHandler;
    }
 
    void SetOnKeyDownHandler(FOnKeyDown InOnKeyDownHandler)
    {
        OnKeyDownHandler = 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);
 
    SLATE_API void GoTo(const ETextLocation NewLocation);
 
    SLATE_API void ScrollTo(const FTextLocation& NewLocation);
 
    SLATE_API 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 FTextSelection GetSelection() const;
 
    SLATE_API void SelectText(const FTextLocation& InSelectionStart, const FTextLocation& InCursorLocation);
 
    /* Function to spawn virtual keyboard on demand */
    SLATE_API void ToggleVirtualKeyboard(bool bShow, const int32 UserIndex);
 
protected:
    //~ Begin SWidget Interface
    SLATE_API virtual void Tick( const FGeometry& AllottedGeometry, const double InCurrentTime, const float InDeltaTime ) override;
    SLATE_API virtual int32 OnPaint(const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawElements, int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled) const override;
    SLATE_API virtual void CacheDesiredSize(float LayoutScaleMultiplier) override;
    SLATE_API virtual FVector2D ComputeDesiredSize(float LayoutScaleMultiplier) const override;
    SLATE_API virtual FChildren* GetChildren() override;
    SLATE_API virtual void OnArrangeChildren(const FGeometry& AllottedGeometry, FArrangedChildren& ArrangedChildren) const override;
    SLATE_API virtual FReply OnDragOver( const FGeometry& MyGeometry, const FDragDropEvent& DragDropEvent ) override;
    SLATE_API virtual FReply OnDrop( const FGeometry& MyGeometry, const FDragDropEvent& DragDropEvent ) override;
    SLATE_API virtual bool SupportsKeyboardFocus() const override;
    SLATE_API virtual FReply OnFocusReceived( const FGeometry& MyGeometry, const FFocusEvent& InFocusEvent ) override;
    SLATE_API virtual void OnFocusLost( const FFocusEvent& InFocusEvent ) override;
    SLATE_API virtual FReply OnKeyChar( const FGeometry& MyGeometry,  const FCharacterEvent& InCharacterEvent ) override;
    SLATE_API virtual FReply OnKeyDown( const FGeometry& MyGeometry, const FKeyEvent& InKeyEvent ) override;
    SLATE_API virtual FReply OnKeyUp( const FGeometry& MyGeometry, const FKeyEvent& InKeyEvent ) override;
    SLATE_API virtual FReply OnMouseButtonDown( const FGeometry& InMyGeometry, const FPointerEvent& InMouseEvent ) override;
    SLATE_API virtual FReply OnMouseButtonUp( const FGeometry& InMyGeometry, const FPointerEvent& InMouseEvent ) override;
    SLATE_API virtual FReply OnMouseMove( const FGeometry& InMyGeometry, const FPointerEvent& InMouseEvent ) override;
    SLATE_API virtual FReply OnMouseButtonDoubleClick( const FGeometry& InMyGeometry, const FPointerEvent& InMouseEvent ) override;
    SLATE_API virtual FCursorReply OnCursorQuery( const FGeometry& MyGeometry, const FPointerEvent& CursorEvent ) const override;
    SLATE_API virtual const FSlateBrush* GetFocusBrush() const;
    SLATE_API virtual bool IsInteractable() const override;
    SLATE_API virtual bool ComputeVolatility() const override;
#if WITH_ACCESSIBILITY
    SLATE_API virtual TSharedRef<FSlateAccessibleWidget> CreateAccessibleWidget() override;
    SLATE_API virtual TOptional<FText> GetDefaultAccessibleText(EAccessibleType AccessibleType = EAccessibleType::Main) const override;
#endif
    //~ End SWidget Interface
 
protected:
    SLATE_API void SynchronizeTextStyle();
 
public:
    //~ Begin ISlateEditableTextWidget Interface
    SLATE_API virtual bool IsTextReadOnly() const override;
    SLATE_API virtual bool IsTextPassword() const override;
    SLATE_API virtual bool IsMultiLineTextEdit() const override;
    SLATE_API virtual bool IsIntegratedKeyboardEnabled() const override;
    //~ End ISlateEditableTextWidget Interface
 
protected:
    //~ Begin ISlateEditableTextWidget Interface
    SLATE_API virtual bool ShouldJumpCursorToEndWhenFocused() const override;
    SLATE_API virtual bool ShouldSelectAllTextWhenFocused() const override;
    SLATE_API virtual bool ShouldClearTextSelectionOnFocusLoss() const override;
    SLATE_API virtual bool ShouldRevertTextOnEscape() const override;
    SLATE_API virtual bool ShouldClearKeyboardFocusOnCommit() const override;
    SLATE_API virtual bool ShouldSelectAllTextOnCommit() const override;
    SLATE_API virtual bool ShouldSelectWordOnMouseDoubleClick() const override;
    SLATE_API virtual bool CanInsertCarriageReturn() const override;
    SLATE_API virtual bool CanTypeCharacter(const TCHAR InChar) const override;
    SLATE_API virtual void EnsureActiveTick() override;
    SLATE_API virtual EKeyboardType GetVirtualKeyboardType() const override;
    SLATE_API virtual FVirtualKeyboardOptions GetVirtualKeyboardOptions() const override;
    SLATE_API virtual EVirtualKeyboardTrigger GetVirtualKeyboardTrigger() const override;
    SLATE_API virtual EVirtualKeyboardDismissAction GetVirtualKeyboardDismissAction() const override;
    SLATE_API virtual TSharedRef<SWidget> GetSlateWidget() override;
    SLATE_API virtual TSharedPtr<SWidget> GetSlateWidgetPtr() override;
    SLATE_API virtual TSharedPtr<SWidget> BuildContextMenuContent() const override;
    SLATE_API virtual void OnBeginTextEdit(const FText& InText) override;
    SLATE_API virtual void OnTextChanged(const FText& InText) override;
    SLATE_API virtual void OnTextCommitted(const FText& InText, const ETextCommit::Type InTextAction) override;
    SLATE_API virtual void OnCursorMoved(const FTextLocation& InLocation) override;
    SLATE_API virtual float UpdateAndClampHorizontalScrollBar(const float InViewOffset, const float InViewFraction, const EVisibility InVisiblityOverride) override;
    SLATE_API virtual float UpdateAndClampVerticalScrollBar(const float InViewOffset, const float InViewFraction, const EVisibility InVisiblityOverride) override;
    //~ End ISlateEditableTextWidget Interface
 
protected:
    TSharedPtr<FPlainTextLayoutMarshaller> PlainTextMarshaller;
 
    TUniquePtr<FSlateEditableTextLayout> EditableTextLayout;
 
    TAttribute<FSlateFontInfo> Font;
 
    TAttribute<FSlateColor> ColorAndOpacity;
 
    TAttribute<const FSlateBrush*> BackgroundImageSelected;
 
    TAttribute<bool> bIsReadOnly;
 
    TAttribute<bool> bIsPassword;
 
    TAttribute<bool> bIsCaretMovedWhenGainFocus;
    
    TAttribute<bool> bSelectAllTextWhenFocused;
 
    TAttribute<bool> bRevertTextOnEscape;
 
    TAttribute<bool> bClearKeyboardFocusOnCommit;
 
    TAttribute<bool> bSelectAllTextOnCommit;
 
    TAttribute<bool> bSelectWordOnMouseDoubleClick;
 
    TAttribute<bool> bAllowContextMenu;
 
    TAttribute<bool> bEnableIntegratedKeyboard;
 
    FOnContextMenuOpening OnContextMenuOpening;
 
    FOnIsTypedCharValid OnIsTypedCharValid;
 
    FOnBeginTextEdit OnBeginTextEditCallback;
 
    FOnTextChanged OnTextChangedCallback;
 
    FOnTextCommitted OnTextCommittedCallback;
 
    TAttribute<float> MinDesiredWidth;
 
    TSharedPtr<FExtender> MenuExtender;
 
    TWeakPtr<FActiveTimerHandle> ActiveTickTimer;
 
    mutable TSharedPtr<IBreakIterator> WordBreakIterator;
 
    FOnKeyChar OnKeyCharHandler;
 
    FOnKeyDown OnKeyDownHandler;
 
    TAttribute<EKeyboardType> VirtualKeyboardType;
 
    FVirtualKeyboardOptions VirtualKeyboardOptions;
 
    TAttribute<EVirtualKeyboardTrigger> VirtualKeyboardTrigger;
 
    TAttribute<EVirtualKeyboardDismissAction> VirtualKeyboardDismissAction;
};