SMultiLineEditableTextBox.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 "Styling/SlateColor.h"
#include "Fonts/SlateFontInfo.h"
#include "Input/Reply.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/Layout/SBorder.h"
#include "Widgets/Layout/SScrollBar.h"
#include "Widgets/Text/SMultiLineEditableText.h"
 
class IErrorReportingWidget;
class ITextLayoutMarshaller;
class SBox;
class SHorizontalBox;
enum class ETextShapingMethod : uint8;
 
#if WITH_FANCY_TEXT
 
class SMultiLineEditableTextBox : public SBorder
{
 
public:
 
    SLATE_BEGIN_ARGS( SMultiLineEditableTextBox )
        : _Style(&FCoreStyle::Get().GetWidgetStyle<FEditableTextBoxStyle>("NormalEditableTextBox"))
        , _Marshaller()
        , _Text()
        , _HintText()
        , _SearchText()
        , _Font()
        , _ForegroundColor()
        , _ReadOnlyForegroundColor()
        , _FocusedForegroundColor()
        , _Justification(ETextJustify::Left)
        , _MaximumLength(-1)
        , _LineHeightPercentage(1.0f)
        , _IsReadOnly( false )
        , _AllowMultiLine( true )
        , _IsCaretMovedWhenGainFocus ( true )
        , _SelectAllTextWhenFocused( false )
        , _ClearTextSelectionOnFocusLoss( true )
        , _RevertTextOnEscape( false )
        , _ClearKeyboardFocusOnCommit( true )
        , _AllowContextMenu(true)
        , _AlwaysShowScrollbars( false )
        , _HScrollBar()
        , _VScrollBar()
        , _WrapTextAt(0.0f)
        , _AutoWrapText(false)
        , _WrappingPolicy(ETextWrappingPolicy::DefaultWrapping)
        , _SelectAllTextOnCommit( false )
        , _SelectWordOnMouseDoubleClick( true )
        , _BackgroundColor()        
        , _Padding()
        , _Margin()
        , _ErrorReporting()
        , _ModiferKeyForNewLine(EModifierKey::None)
        , _VirtualKeyboardOptions(FVirtualKeyboardOptions())
        , _VirtualKeyboardTrigger(EVirtualKeyboardTrigger::OnFocusByPointer)
        , _VirtualKeyboardDismissAction(EVirtualKeyboardDismissAction::TextChangeOnDismiss)
        , _TextShapingMethod()
        , _TextFlowDirection()
        , _OverflowPolicy()
        {}
 
        SLATE_STYLE_ARGUMENT(FEditableTextBoxStyle, Style)
 
        
        SLATE_STYLE_ARGUMENT_DEPRECATED(FTextBlockStyle, TextStyle, 5.2, "TextStyle is deprecated and will be ignored. Please use the TextStyle embedded in FEditableTextBoxStyle Style.")
 
        
        SLATE_ARGUMENT(TSharedPtr< ITextLayoutMarshaller >, Marshaller)
 
        SLATE_ATTRIBUTE( FText, Text )
 
        SLATE_ATTRIBUTE( FText, HintText )
 
        SLATE_ATTRIBUTE( FText, SearchText )
 
        SLATE_ATTRIBUTE( FSlateFontInfo, Font )
 
        SLATE_ATTRIBUTE( FSlateColor, ForegroundColor )
        
        SLATE_ATTRIBUTE( FSlateColor, ReadOnlyForegroundColor )
 
        SLATE_ATTRIBUTE(FSlateColor, FocusedForegroundColor)
 
        SLATE_ATTRIBUTE(ETextJustify::Type, Justification)
 
        SLATE_ATTRIBUTE(int32, MaximumLength)
 
        SLATE_ATTRIBUTE(float, LineHeightPercentage)
 
        SLATE_ATTRIBUTE( bool, IsReadOnly )
 
        SLATE_ATTRIBUTE(bool, AllowMultiLine)
 
        SLATE_ATTRIBUTE( bool, IsCaretMovedWhenGainFocus )
 
        SLATE_ATTRIBUTE( bool, SelectAllTextWhenFocused )
 
        SLATE_ATTRIBUTE( bool, ClearTextSelectionOnFocusLoss )
 
        SLATE_ATTRIBUTE( bool, RevertTextOnEscape )
 
        SLATE_ATTRIBUTE( bool, ClearKeyboardFocusOnCommit )
 
        SLATE_ATTRIBUTE(bool, AllowContextMenu)
 
        SLATE_ARGUMENT(bool, AlwaysShowScrollbars)
 
        SLATE_ARGUMENT( TSharedPtr< SScrollBar >, HScrollBar )
 
        SLATE_ARGUMENT( TSharedPtr< SScrollBar >, VScrollBar )
 
        SLATE_ATTRIBUTE( FMargin, HScrollBarPadding )
 
        SLATE_ATTRIBUTE( FMargin, VScrollBarPadding )
 
        SLATE_EVENT(FOnContextMenuOpening, OnContextMenuOpening)
 
        SLATE_EVENT( FOnIsTypedCharValid, OnIsTypedCharValid )
 
        SLATE_EVENT( FOnBeginTextEdit, OnBeginTextEdit )
 
        SLATE_EVENT( FOnTextChanged, OnTextChanged )
 
        SLATE_EVENT( FOnTextCommitted, OnTextCommitted )
 
        SLATE_EVENT( FOnVerifyTextChanged, OnVerifyTextChanged )
 
        SLATE_EVENT( FOnUserScrolled, OnHScrollBarUserScrolled )
 
        SLATE_EVENT( FOnUserScrolled, OnVScrollBarUserScrolled )
 
        SLATE_EVENT( SMultiLineEditableText::FOnCursorMoved, OnCursorMoved )
 
        SLATE_EVENT(FOnKeyChar, OnKeyCharHandler)
 
        SLATE_EVENT(FOnKeyDown, OnKeyDownHandler)
 
        SLATE_EVENT( FMenuExtensionDelegate, ContextMenuExtender )
 
        SLATE_EVENT( FCreateSlateTextLayout, CreateSlateTextLayout )
 
        SLATE_ATTRIBUTE( float, WrapTextAt )
 
        SLATE_ATTRIBUTE( bool, AutoWrapText )
 
        SLATE_ATTRIBUTE( ETextWrappingPolicy, WrappingPolicy )
 
        SLATE_ATTRIBUTE( bool, SelectAllTextOnCommit )
 
        SLATE_ATTRIBUTE(bool, SelectWordOnMouseDoubleClick)
 
        SLATE_ATTRIBUTE( FSlateColor, BackgroundColor )
 
        SLATE_ATTRIBUTE( FMargin, Padding )
 
        SLATE_ATTRIBUTE( FMargin, Margin )
 
        SLATE_ARGUMENT( TSharedPtr<class IErrorReportingWidget>, ErrorReporting )
 
        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 void Construct( const FArguments& InArgs );
    
    FText GetText() const
    {
        return EditableText->GetText();
    }
 
    FText GetPlainText() const
    {
        return EditableText->GetPlainText();
    }
 
    SLATE_API void GetCurrentTextLine(FString& OutTextLine) const;
 
    SLATE_API void SetStyle(const FEditableTextBoxStyle* InStyle);
 
    SLATE_API void SetTextStyle(const FTextBlockStyle* InTextStyle);    
 
    SLATE_API void SetText( const TAttribute< FText >& InNewText );
 
    FText GetHintText() const
    {
        return EditableText->GetHintText();
    }
 
    SLATE_API void SetHintText( const TAttribute< FText >& InHintText );
 
    SLATE_API void SetSearchText(const TAttribute<FText>& InSearchText);
 
    SLATE_API FText GetSearchText() const;
 
    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 SetMaximumLength(const TAttribute<int32>& InMaximumLength);
 
    SLATE_API void SetSelectWordOnMouseDoubleClick(const TAttribute<bool>& InSelectWordOnMouseDoubleClick);
 
    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 SetIsReadOnly(const TAttribute< bool >& InIsReadOnly);
 
    SLATE_API void SetError( const FText& InError );
    SLATE_API void SetError( const FString& InError );
 
    // SWidget overrides
    SLATE_API virtual bool SupportsKeyboardFocus() const override;
    SLATE_API virtual bool HasKeyboardFocus() const override;
    SLATE_API virtual FReply OnFocusReceived( const FGeometry& MyGeometry, const FFocusEvent& InFocusEvent ) override;
    SLATE_API virtual FReply OnKeyDown(const FGeometry& MyGeometry, const FKeyEvent& InKeyEvent) override;
 
 
    SLATE_API bool AnyTextSelected() const;
 
    SLATE_API void SelectAllText();
 
    SLATE_API void ClearSelection();
 
    SLATE_API FText GetSelectedText() const;
 
    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);
 
    void GoTo(const ETextLocation NewLocation)
    {
        EditableText->GoTo(NewLocation);
    }
 
    SLATE_API void ScrollTo(const FTextLocation& NewLocation);
 
    void ScrollTo(const ETextLocation NewLocation)
    {
        EditableText->ScrollTo(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 TSharedPtr<const SScrollBar> GetHScrollBar() const;
 
    SLATE_API TSharedPtr<const SScrollBar> GetVScrollBar() const;
 
    SLATE_API void Refresh();
 
    SLATE_API void SetOnKeyCharHandler(FOnKeyChar InOnKeyCharHandler);
 
    SLATE_API void SetOnKeyDownHandler(FOnKeyDown InOnKeyDownHandler);
 
 
    SLATE_API void ForceScroll(int32 UserIndex, float ScrollAxisMagnitude);
 
protected:
    SLATE_API void OnEditableTextChanged(const FText& InText);
 
    SLATE_API void OnEditableTextCommitted(const FText& InText, ETextCommit::Type InCommitType);
 
protected:
 
    TSharedPtr< SMultiLineEditableText > EditableText;
 
    TAttribute<FMargin> PaddingOverride;
 
    TAttribute<FMargin> HScrollBarPaddingOverride;
 
    TAttribute<FMargin> VScrollBarPaddingOverride;
 
    TAttribute<FSlateFontInfo> FontOverride;
 
    TAttribute<FSlateColor> ForegroundColorOverride;
 
    TAttribute<FSlateColor> BackgroundColorOverride;
 
    TAttribute<FSlateColor> ReadOnlyForegroundColorOverride;
 
    TAttribute<FSlateColor> FocusedForegroundColorOverride;
 
    TAttribute<int32> MaximumLength;
 
    TAttribute< bool > AllowContextMenu;
 
    TAttribute<bool> bSelectWordOnMouseDoubleClick;
 
    TSharedPtr<SHorizontalBox> Box;
 
    bool bHasExternalHScrollBar;
 
    TSharedPtr<SScrollBar> HScrollBar;
 
    TSharedPtr<SBox> HScrollBarPaddingBox;
 
    bool bHasExternalVScrollBar;
 
    TSharedPtr<SScrollBar> VScrollBar;
 
    TSharedPtr<SBox> VScrollBarPaddingBox;
 
    TSharedPtr<class IErrorReportingWidget> ErrorReporting;
 
    FOnTextChanged OnTextChanged;
 
    FOnTextCommitted OnTextCommitted;
 
    FOnVerifyTextChanged OnVerifyTextChanged;
 
    const FEditableTextBoxStyle* Style;
 
private:
 
    SLATE_API FMargin DeterminePadding() const;
    SLATE_API FMargin DetermineHScrollBarPadding() const;
    SLATE_API FMargin DetermineVScrollBarPadding() const;
    SLATE_API FSlateFontInfo DetermineFont() const;
    SLATE_API FSlateColor DetermineBackgroundColor() const;
    SLATE_API FSlateColor DetermineForegroundColor() const;
 
    const FSlateBrush* BorderImageNormal;
    const FSlateBrush* BorderImageHovered;
    const FSlateBrush* BorderImageFocused;
    const FSlateBrush* BorderImageReadOnly;
 
    SLATE_API const FSlateBrush* GetBorderImage() const;
 
};
 
 
#endif //WITH_FANCY_TEXT