SInlineEditableTextBlock.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 "Styling/SlateColor.h"
#include "Fonts/SlateFontInfo.h"
#include "Input/Reply.h"
#include "Styling/SlateWidgetStyleAsset.h"
#include "Widgets/DeclarativeSyntaxSupport.h"
#include "Widgets/SCompoundWidget.h"
#include "Styling/SlateTypes.h"
#include "Styling/CoreStyle.h"
#include "Framework/SlateDelegates.h"
#include "Framework/Text/TextLayout.h"
 
class FActiveTimerHandle;
class IBreakIterator;
class SEditableTextBox;
class SHorizontalBox;
class SMultiLineEditableTextBox;
class STextBlock;
 
class SInlineEditableTextBlock: public SCompoundWidget
{
    SLATE_BEGIN_ARGS( SInlineEditableTextBlock )
        : _Text()
        , _HintText()
        , _Style( &FCoreStyle::Get().GetWidgetStyle<FInlineEditableTextBlockStyle>("InlineEditableTextBlockStyle") )
        , _Font()
        , _ColorAndOpacity()
        , _ShadowOffset()
        , _ShadowColorAndOpacity()
        , _HighlightText()
        , _WrapTextAt(0.0f)
        , _AutoWrapNonEditText(false)
        , _AutoWrapMultilineEditText(false)
        , _Justification(ETextJustify::Left)
        , _MaximumLength(-1)
        , _LineBreakPolicy()
        , _IsReadOnly(false)
        , _MultiLine(false)
        , _DelayedLeftClickEntersEditMode(true)
        , _ModiferKeyForNewLine(EModifierKey::None)
        , _OverflowPolicy()
    {
    }
 
        SLATE_ATTRIBUTE( FText, Text )
 
        
        SLATE_ATTRIBUTE( FText, HintText )
 
        
        SLATE_STYLE_ARGUMENT( FInlineEditableTextBlockStyle, Style )
 
        
        SLATE_ATTRIBUTE( FSlateFontInfo, Font )
 
        
        SLATE_ATTRIBUTE( FSlateColor, ColorAndOpacity )
 
        
        SLATE_ATTRIBUTE( FVector2D, ShadowOffset )
 
        
        SLATE_ATTRIBUTE( FLinearColor, ShadowColorAndOpacity )
 
        
        SLATE_ATTRIBUTE( FText, HighlightText )
 
        
        SLATE_ATTRIBUTE( float, WrapTextAt )
 
        
        SLATE_ATTRIBUTE( bool, AutoWrapNonEditText )
 
        
        SLATE_ATTRIBUTE( bool, AutoWrapMultilineEditText )
 
        
        SLATE_ATTRIBUTE(ETextJustify::Type, Justification)
 
        
        SLATE_ATTRIBUTE(int32, MaximumLength)
 
        
        SLATE_ARGUMENT( TSharedPtr<IBreakIterator>, LineBreakPolicy )
 
        
        SLATE_ATTRIBUTE( bool, IsReadOnly )
 
        
        SLATE_ARGUMENT( bool, MultiLine )
 
        
        SLATE_ARGUMENT( bool, DelayedLeftClickEntersEditMode )
 
        
        SLATE_ARGUMENT(EModifierKey::Type, ModiferKeyForNewLine)
 
        
        SLATE_EVENT( FOnBeginTextEdit, OnBeginTextEdit )
 
        
        SLATE_EVENT( FOnTextCommitted, OnTextCommitted )
 
        
        SLATE_EVENT(FSimpleDelegate, OnEnterEditingMode)
 
        
        SLATE_EVENT(FSimpleDelegate, OnExitEditingMode)
 
        
        SLATE_EVENT( FIsSelected, IsSelected )
 
        
        SLATE_EVENT( FOnVerifyTextChanged, OnVerifyTextChanged )
 
        
        SLATE_ARGUMENT(TOptional<ETextOverflowPolicy>, OverflowPolicy)
    SLATE_END_ARGS()
 
    SLATE_API ~SInlineEditableTextBlock();
 
    SLATE_API void Construct( const FArguments& InArgs );
 
    SLATE_API virtual bool SupportsKeyboardFocus() const override;
 
    SLATE_API virtual FReply OnMouseButtonDown( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent ) override;
 
    SLATE_API virtual FReply OnDragOver( const FGeometry& MyGeometry, const FDragDropEvent& DragDropEvent ) override;
 
    SLATE_API virtual FReply OnMouseButtonDoubleClick( const FGeometry& InMyGeometry, const FPointerEvent& InMouseEvent ) override;
 
    SLATE_API virtual FReply OnKeyDown( const FGeometry& MyGeometry, const FKeyEvent& InKeyEvent ) override;
 
    //virtual void Tick( const FGeometry& AllottedGeometry, const double InCurrentTime, const float InDeltaTime ) override;
     
    SLATE_API void EnterEditingMode();
 
    SLATE_API void ExitEditingMode();
 
    SLATE_API bool IsInEditMode() const;
 
    SLATE_API void SetReadOnly(const TAttribute<bool>& bInIsReadOnly);
 
    SLATE_API void SetMaximumLength(const TAttribute<int32>& InMaximumLength);
 
    SLATE_API void SetText( const TAttribute< FText >& InText );
    SLATE_API void SetText( const FString& InText );
 
    SLATE_API FText GetText() const;
 
    SLATE_API void SetHintText( const TAttribute< FText >& InHintText );
 
    SLATE_API void SetHighlightText(const TAttribute<FText>& InText);
 
    SLATE_API void SetWrapTextAt(const TAttribute<float>& InWrapTextAt);
 
    SLATE_API void SetOverflowPolicy(TOptional<ETextOverflowPolicy> InOverflowPolicy);
 
    SLATE_API void SetOnTextCommitted(FOnTextCommitted InOnTextCommitted);
 
    SLATE_API void SetOnEnterEditingMode(FSimpleDelegate InOnEnterEditingMode);
 
    SLATE_API void SetOnExitEditingMode(FSimpleDelegate InOnExitEditingMode);
 
    SLATE_API void SetOnExitEditingMode(FIsSelected InIsSelected);
 
    SLATE_API void SetOnVerifyTextChanged(FOnVerifyTextChanged InOnVerifyTextChanged);
 
protected:
    SLATE_API void OnTextChanged(const FText& InText);
 
    SLATE_API void OnTextBoxCommitted(const FText& InText, ETextCommit::Type InCommitType);
 
    SLATE_API void CancelEditMode();
 
protected:
    TSharedPtr< STextBlock > TextBlock;
 
    TSharedPtr< SEditableTextBox > TextBox;
 
#if WITH_FANCY_TEXT
    TSharedPtr< SMultiLineEditableTextBox > MultiLineTextBox;
#endif //WITH_FANCY_TEXT
 
    FSimpleDelegate OnEnterEditingMode;
    FSimpleDelegate OnExitEditingMode;
 
    FOnTextCommitted OnTextCommittedDelegate;
 
    FIsSelected IsSelected;
 
    TSharedPtr< SHorizontalBox > HorizontalBox;
 
    FOnVerifyTextChanged OnVerifyTextChanged;
 
    TAttribute<FText> Text;
 
    TAttribute<FText> HintText;
 
    TAttribute< bool > bIsReadOnly;
 
    TAttribute<int32> MaximumLength;
 
    TWeakPtr<SWidget> WidgetToFocus;
 
private:
 
    TSharedPtr<SWidget> GetEditableTextWidget() const;
 
    void SetEditableText( const TAttribute< FText >& InNewText );
 
    void SetTextBoxError( const FText& ErrorText );
 
    EActiveTimerReturnType TriggerEditMode(double InCurrentTime, float InDeltaTime);
 
    TWeakPtr<FActiveTimerHandle> ActiveTimerHandle;
 
protected:
    float DoubleSelectDelay;
 
    uint8 bIsMultiLine:1;
 
    uint8 bDelayedLeftClickEntersEditMode:1;
};