SMultiLineEditableText.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 "SlateGlobals.h"
#include "Layout/Margin.h"
#include "Fonts/SlateFontInfo.h"
#include "Input/CursorReply.h"
#include "Input/Reply.h"
#include "Layout/Visibility.h"
#include "Widgets/DeclarativeSyntaxSupport.h"
#include "Styling/SlateTypes.h"
#include "Styling/CoreStyle.h"
#include "Framework/Text/IRun.h"
#include "Framework/Text/TextLayout.h"
#include "Widgets/SWidget.h"
#include "Widgets/Layout/SScrollBar.h"
#include "Framework/SlateDelegates.h"
#include "Framework/MultiBox/MultiBoxExtender.h"
#if WITH_FANCY_TEXT
    #include "Widgets/Text/ISlateEditableTextWidget.h"
    #include "Framework/Text/SlateTextLayoutFactory.h"
#endif
 
class FActiveTimerHandle;
class FArrangedChildren;
class FPaintArgs;
class FSlateEditableTextLayout;
class FSlateWindowElementList;
class ITextLayoutMarshaller;
enum class ETextShapingMethod : uint8;
 
#if WITH_FANCY_TEXT
 
class ITextLayoutMarshaller;
class FSlateEditableTextLayout;
 
class SMultiLineEditableText : public SWidget, public ISlateEditableTextWidget
{
public:
 
    struct FScopedEditableTextTransaction
    {
    public:
        FScopedEditableTextTransaction(TSharedPtr<SMultiLineEditableText> InText)
            : Text(InText)
        {
            Text->BeginEditTransaction();
        }
 
        ~FScopedEditableTextTransaction()
        {
            Text->EndEditTransaction(); 
        };
 
    private:
        TSharedPtr<SMultiLineEditableText> Text;
    };
    
    DECLARE_DELEGATE_OneParam( FOnCursorMoved, const FTextLocation& );
 
    SLATE_BEGIN_ARGS( SMultiLineEditableText )
        : _Text()
        , _HintText()
        , _SearchText()
        , _Marshaller()
        , _WrapTextAt( 0.0f )
        , _AutoWrapText(false)
        , _WrappingPolicy(ETextWrappingPolicy::DefaultWrapping)
        , _TextStyle( &FCoreStyle::Get().GetWidgetStyle<FTextBlockStyle>( "NormalText" ) )
        , _Font()
        , _Margin( FMargin() )
        , _LineHeightPercentage( 1.0f )
        , _ApplyLineHeightToBottomLine( true )
        , _Justification( ETextJustify::Left )
        , _IsReadOnly(false)
        , _OnTextChanged()
        , _OnTextCommitted()
        , _AllowMultiLine(true)
        , _SelectAllTextWhenFocused(false)
        , _SelectWordOnMouseDoubleClick(true)
        , _ClearTextSelectionOnFocusLoss(true)
        , _RevertTextOnEscape(false)
        , _ClearKeyboardFocusOnCommit(true)
        , _AllowContextMenu(true)
        , _OnCursorMoved()
        , _ContextMenuExtender()
        , _ModiferKeyForNewLine(EModifierKey::None)
        , _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_ARGUMENT(TSharedPtr< ITextLayoutMarshaller >, Marshaller)
 
        
        SLATE_ATTRIBUTE(float, WrapTextAt)
 
        
        SLATE_ATTRIBUTE(bool, AutoWrapText)
 
        
        SLATE_ATTRIBUTE(ETextWrappingPolicy, WrappingPolicy)
 
        
        SLATE_STYLE_ARGUMENT(FTextBlockStyle, TextStyle)
 
        
        SLATE_ATTRIBUTE(FSlateFontInfo, Font)
 
        
        SLATE_ATTRIBUTE(FMargin, Margin)
 
        
        SLATE_ATTRIBUTE(float, LineHeightPercentage)
 
        
        SLATE_ATTRIBUTE(bool, ApplyLineHeightToBottomLine)
 
        
        SLATE_ATTRIBUTE(ETextJustify::Type, Justification)
 
        
        SLATE_ATTRIBUTE(bool, IsReadOnly)
 
        
        SLATE_ARGUMENT(TSharedPtr< SScrollBar >, HScrollBar)
 
        
        SLATE_ARGUMENT(TSharedPtr< SScrollBar >, VScrollBar)
 
        
        SLATE_EVENT(FOnIsTypedCharValid, OnIsTypedCharValid)
 
        
        SLATE_EVENT(FOnBeginTextEdit, OnBeginTextEdit )
 
        
        SLATE_EVENT(FOnTextChanged, OnTextChanged)
 
        
        SLATE_EVENT(FOnTextCommitted, OnTextCommitted)
 
        
        SLATE_ATTRIBUTE(bool, AllowMultiLine)
 
        
        SLATE_ATTRIBUTE(bool, SelectAllTextWhenFocused)
 
        
        SLATE_ATTRIBUTE(bool, SelectWordOnMouseDoubleClick)
 
        
        SLATE_ATTRIBUTE(bool, ClearTextSelectionOnFocusLoss)
 
        
        SLATE_ATTRIBUTE(bool, RevertTextOnEscape)
 
        
        SLATE_ATTRIBUTE(bool, ClearKeyboardFocusOnCommit)
 
        
        SLATE_ATTRIBUTE(bool, AllowContextMenu)
 
        
        SLATE_EVENT(FOnContextMenuOpening, OnContextMenuOpening)
 
        
        SLATE_EVENT(FOnUserScrolled, OnHScrollBarUserScrolled)
 
        
        SLATE_EVENT(FOnUserScrolled, OnVScrollBarUserScrolled)
 
        
        SLATE_EVENT(FOnCursorMoved, OnCursorMoved)
 
        
        SLATE_EVENT(FOnKeyChar, OnKeyCharHandler)
 
        
        SLATE_EVENT(FOnKeyDown, OnKeyDownHandler)
 
        
        SLATE_EVENT(FMenuExtensionDelegate, ContextMenuExtender)
 
        
        SLATE_EVENT(FCreateSlateTextLayout, CreateSlateTextLayout)
 
        
        SLATE_ARGUMENT(EModifierKey::Type, ModiferKeyForNewLine)
 
        
        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 SMultiLineEditableText();
    SLATE_API ~SMultiLineEditableText();
 
    SLATE_API void Construct( const FArguments& InArgs );
 
    SLATE_API void SetText(const TAttribute< FText >& InText);
 
    SLATE_API FText GetText() const;
 
    SLATE_API FText GetPlainText() const;
 
    SLATE_API void GetCurrentTextLine(FString& OutTextLine) const;
 
    SLATE_API void GetTextLine(const int32 InLineIndex, FString& OutTextLine) const;
    
    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 int32 GetSearchResultIndex() const;
 
    SLATE_API int32 GetNumSearchResults() const;
 
    SLATE_API void SetTextStyle(const FTextBlockStyle* InTextStyle);
 
    SLATE_API void SetFont(const TAttribute< FSlateFontInfo >& InNewFont);
    SLATE_API FSlateFontInfo GetFont() const;
 
    SLATE_API void SetTextShapingMethod(const TOptional<ETextShapingMethod>& InTextShapingMethod);
 
    SLATE_API void SetTextFlowDirection(const TOptional<ETextFlowDirection>& InTextFlowDirection);
 
    SLATE_API void SetWrapTextAt(const TAttribute<float>& InWrapTextAt);
 
    SLATE_API void SetAutoWrapText(const TAttribute<bool>& InAutoWrapText);
 
    SLATE_API void SetWrappingPolicy(const TAttribute<ETextWrappingPolicy>& InWrappingPolicy);
 
    SLATE_API void SetLineHeightPercentage(const TAttribute<float>& InLineHeightPercentage);
 
    SLATE_API void SetApplyLineHeightToBottomLine(const TAttribute<bool>& InApplyLineHeightToBottomLine);
 
    SLATE_API void SetMargin(const TAttribute<FMargin>& InMargin);
 
    SLATE_API void SetJustification(const TAttribute<ETextJustify::Type>& InJustification);
 
    SLATE_API void SetOverflowPolicy(TOptional<ETextOverflowPolicy> InOverflowPolicy);
 
    SLATE_API void SetAllowContextMenu(const TAttribute< bool >& InAllowContextMenu);
 
    SLATE_API void SetVirtualKeyboardDismissAction(TAttribute< EVirtualKeyboardDismissAction > InVirtualKeyboardDismissAction);
 
    SLATE_API void SetSelectWordOnMouseDoubleClick(const TAttribute<bool>& InSelectWordOnMouseDoubleClick);
    
    SLATE_API void SetIsReadOnly(const TAttribute< bool >& InIsReadOnly);
 
    SLATE_API int32 GetTextLineCount();
 
    SLATE_API void SetSelectAllTextWhenFocused(const TAttribute<bool>& InSelectAllTextWhenFocused);
 
    SLATE_API void SetClearTextSelectionOnFocusLoss(const TAttribute<bool>& InClearTextSelectionOnFocusLoss);
 
    SLATE_API void SetRevertTextOnEscape(const TAttribute<bool>& InRevertTextOnEscape);
 
    SLATE_API void SetClearKeyboardFocusOnCommit(const TAttribute<bool>& InClearKeyboardFocusOnCommit);
 
    SLATE_API bool AnyTextSelected() const;
 
    SLATE_API void SelectAllText();
 
    SLATE_API void SelectText(const FTextLocation& InSelectionStart, const FTextLocation& InCursorLocation);
    
    SLATE_API void ClearSelection();
 
    SLATE_API FText GetSelectedText() const;
 
    SLATE_API FTextSelection GetSelection() const;
 
    SLATE_API void DeleteSelectedText();
 
    SLATE_API void InsertTextAtCursor(const FText& InText);
    SLATE_API void InsertTextAtCursor(const FString& InString);
 
    SLATE_API void InsertRunAtCursor(TSharedRef<IRun> InRun);
 
    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 ApplyToSelection(const FRunInfo& InRunInfo, const FTextBlockStyle& InStyle);
 
    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 TSharedPtr<const IRun> GetRunUnderCursor() const;
 
    SLATE_API TArray<TSharedRef<const IRun>> GetSelectedRuns() const;
 
    SLATE_API FTextLocation GetCursorLocation() const;
 
    SLATE_API TCHAR GetCharacterAt(const FTextLocation& Location) const;
 
    SLATE_API TSharedPtr<const SScrollBar> GetHScrollBar() const;
 
    SLATE_API TSharedPtr<const SScrollBar> GetVScrollBar() const;
 
    SLATE_API void Refresh();
 
    void SetOnKeyCharHandler(FOnKeyChar InOnKeyCharHandler)
    {
        OnKeyCharHandler = InOnKeyCharHandler;
    }
 
    void SetOnKeyDownHandler(FOnKeyDown InOnKeyDownHandler)
    {
        OnKeyDownHandler = InOnKeyDownHandler;
    }
 
    SLATE_API void ForceScroll(int32 UserIndex, float ScrollAxisMagnitude);
 
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 bool SupportsKeyboardFocus() const 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 OnFocusReceived( const FGeometry& MyGeometry, const FFocusEvent& InFocusEvent ) override;
    SLATE_API virtual void OnFocusLost( const FFocusEvent& InFocusEvent ) override;
    SLATE_API virtual FReply OnMouseButtonDown( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent ) override;
    SLATE_API virtual FReply OnMouseButtonUp( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent ) override;
    SLATE_API virtual FReply OnMouseMove( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent ) override;
    SLATE_API virtual FReply OnMouseWheel( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent ) override;
    SLATE_API virtual FReply OnMouseButtonDoubleClick(const FGeometry& MyGeometry, const FPointerEvent& MouseEvent) override;
    SLATE_API virtual FCursorReply OnCursorQuery( const FGeometry& MyGeometry, const FPointerEvent& CursorEvent ) const override;
    SLATE_API virtual bool IsInteractable() const override;
    SLATE_API virtual bool ComputeVolatility() const override;
    //~ End SWidget Interface
 
protected:
    SLATE_API void OnHScrollBarMoved(const float InScrollOffsetFraction);
    SLATE_API void OnVScrollBarMoved(const float InScrollOffsetFraction);
 
    SLATE_API bool IsRightClickScrolling() const;
 
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:
    SLATE_API void BeginEditTransaction();
 
    SLATE_API void EndEditTransaction();
 
protected:
    TUniquePtr<FSlateEditableTextLayout> EditableTextLayout;
 
    TAttribute<bool> bAllowMultiLine;
 
    TAttribute<bool> bSelectAllTextWhenFocused;
 
    TAttribute<bool> bClearTextSelectionOnFocusLoss;
 
    TAttribute<bool> bSelectWordOnMouseDoubleClick;
 
    TAttribute<bool> bRevertTextOnEscape;
 
    TAttribute<bool> bClearKeyboardFocusOnCommit;
 
    TAttribute<bool> bAllowContextMenu;
 
    TAttribute<bool> bIsReadOnly;
 
    FOnContextMenuOpening OnContextMenuOpening;
 
    FOnIsTypedCharValid OnIsTypedCharValid;
 
    FOnBeginTextEdit OnBeginTextEditCallback;
 
    FOnTextChanged OnTextChangedCallback;
 
    FOnTextCommitted OnTextCommittedCallback;
 
    FOnCursorMoved OnCursorMovedCallback;
 
    TSharedPtr<SScrollBar> HScrollBar;
 
    TSharedPtr<SScrollBar> VScrollBar;
 
    FOnUserScrolled OnHScrollBarUserScrolled;
 
    FOnUserScrolled OnVScrollBarUserScrolled;
 
    TSharedPtr<FExtender> MenuExtender;
 
    EModifierKey::Type ModiferKeyForNewLine;
 
    TWeakPtr<FActiveTimerHandle> ActiveTickTimer;
 
    float AmountScrolledWhileRightMouseDown;
 
    bool bIsSoftwareCursor;
 
    FVector2f SoftwareCursorPosition;
 
    FOnKeyChar OnKeyCharHandler;
 
    FOnKeyDown OnKeyDownHandler;
 
    FVirtualKeyboardOptions VirtualKeyboardOptions;
 
    TAttribute<EVirtualKeyboardTrigger> VirtualKeyboardTrigger;
 
    TAttribute<EVirtualKeyboardDismissAction> VirtualKeyboardDismissAction;
};
 
#endif //WITH_FANCY_TEXT