MultiLineEditableTextBox.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "Fonts/SlateFontInfo.h"
#include "Styling/SlateTypes.h"
#include "Widgets/SWidget.h"
#include "Components/TextWidgetTypes.h"
#include "Widgets/Text/ISlateEditableTextWidget.h"
#include "MultiLineEditableTextBox.generated.h"
 
class SMultiLineEditableTextBox;
class USlateWidgetStyleAsset;
 
UCLASS(meta=(DisplayName="Text Box (Multi-Line)"), MinimalAPI)
class UMultiLineEditableTextBox : public UTextLayoutWidget
{
    GENERATED_UCLASS_BODY()
 
public:
 
    DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnMultiLineEditableTextBoxChangedEvent, const FText&, Text);
    DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FOnMultiLineEditableTextBoxCommittedEvent, const FText&, Text, ETextCommit::Type, CommitMethod);
 
public:
    
    UE_DEPRECATED(5.1, "Direct access to Text is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, BlueprintGetter = "GetText", BlueprintSetter = "SetText", FieldNotify, Category = Content, meta=(MultiLine="true"))
    FText Text;
 
    UE_DEPRECATED(5.1, "Direct access to HintText is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, BlueprintGetter = "GetHintText", BlueprintSetter = "SetHintText", Category = Content, meta = (MultiLine = "true"))
    FText HintText;
 
    UPROPERTY()
    FGetText HintTextDelegate;
public:
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category="Style", meta=(DisplayName="Style"))
    FEditableTextBoxStyle WidgetStyle;
 
#if WITH_EDITORONLY_DATA
    UE_DEPRECATED(5.1, "TextStyle has been deprecated as it was mainly duplicated information already available inside WidgetStyle. Please use the WidgetStyle.TextStyle instead.")
    UPROPERTY(meta=(DisplayName="Text Style"))
    FTextBlockStyle TextStyle_DEPRECATED;
#endif
 
    UE_DEPRECATED(5.1, "Direct access to IsReadOnly is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter = GetIsReadOnly, Setter = SetIsReadOnly, Category = Appearance)
    bool bIsReadOnly;
 
    UPROPERTY(EditAnywhere, Category=Behavior, AdvancedDisplay)
    bool AllowContextMenu;
    
    UPROPERTY(EditAnywhere, Category=Behavior, AdvancedDisplay)
    FVirtualKeyboardOptions VirtualKeyboardOptions;
 
    UPROPERTY(EditAnywhere, Category=Behavior, AdvancedDisplay)
    EVirtualKeyboardDismissAction VirtualKeyboardDismissAction;
 
    UPROPERTY(BlueprintAssignable, Category="Widget Event", meta=(DisplayName="OnTextChanged (Multi-Line Text Box)"))
    FOnMultiLineEditableTextBoxChangedEvent OnTextChanged;
 
    UPROPERTY(BlueprintAssignable, Category="Widget Event", meta=(DisplayName="OnTextCommitted (Multi-Line Text Box)"))
    FOnMultiLineEditableTextBoxCommittedEvent OnTextCommitted;
 
    //SLATE_ARGUMENT(TSharedPtr<class IErrorReportingWidget>, ErrorReporting)
 
public:
 
    UFUNCTION(BlueprintCallable, Category="Widget", meta=(DisplayName="GetText (Multi-Line Text Box)"))
    UMG_API FText GetText() const;
 
    UFUNCTION(BlueprintCallable, Category="Widget", meta=(DisplayName="SetText (Multi-Line Text Box)"))
    UMG_API void SetText(FText InText);
 
    UFUNCTION(BlueprintCallable, Category = "Widget", meta = (DisplayName = "GetHintText (Multi-Line Text Box)"))
    UMG_API FText GetHintText() const;
 
    UFUNCTION(BlueprintCallable, Category="Widget", meta=(DisplayName="SetHintText (Multi-Line Text Box)"))
    UMG_API void SetHintText(FText InHintText);
 
    UFUNCTION(BlueprintCallable, Category="Widget", meta=(DisplayName="SetError (Multi-Line Text Box)"))
    UMG_API void SetError(FText InError);
 
    UMG_API bool GetIsReadOnly() const;
 
    UFUNCTION(BlueprintCallable, Category = "Widget", meta = (DisplayName = "SetIsReadOnly (Multi-Line Text Box)"))
    UMG_API void SetIsReadOnly(UPARAM(DisplayName = "ReadyOnly") bool bReadOnly);
 
    UFUNCTION(BlueprintCallable, Category="Widget", meta=(DisplayName="SetTextStyle (Multi-Line Text Box)"))
    UMG_API void SetTextStyle(const FTextBlockStyle& InTextStyle);
 
    UFUNCTION(BlueprintCallable, Category="Widget", meta=(DisplayName="SetForegroundColor (Multi-Line Text Box)"))
    UMG_API void SetForegroundColor(FLinearColor color);
 
    //TODO UMG Add Set ReadOnlyForegroundColor
    //TODO UMG Add Set BackgroundColor
    //TODO UMG Add Set Font
 
public:
    //~ Begin UWidget Interface
    UMG_API virtual void SynchronizeProperties() override;
    //~ End UWidget Interface
 
    //~ Begin UVisual Interface
    UMG_API virtual void ReleaseSlateResources(bool bReleaseChildren) override;
    //~ End UVisual Interface
 
#if WITH_EDITOR
    UMG_API virtual const FText GetPaletteCategory() override;
#endif
    UMG_API virtual void Serialize(FArchive& Ar) override;
 
protected:
    //~ Begin UTextLayoutWidget Interface
    UMG_API virtual void OnShapedTextOptionsChanged(FShapedTextOptions InShapedTextOptions) override;
    UMG_API virtual void OnJustificationChanged(ETextJustify::Type InJustification) override;
    UMG_API virtual void OnWrappingPolicyChanged(ETextWrappingPolicy InWrappingPolicy) override;
    UMG_API virtual void OnAutoWrapTextChanged(bool InAutoWrapText) override;
    UMG_API virtual void OnWrapTextAtChanged(float InWrapTextAt) override;
    UMG_API virtual void OnLineHeightPercentageChanged(float InLineHeightPercentage) override;
    UMG_API virtual void OnApplyLineHeightToBottomLineChanged(bool InApplyLineHeightToBottomLine) override;
    UMG_API virtual void OnMarginChanged(const FMargin& InMargin) override;
    //~ End UTextLayoutWidget Interface
 
    //~ Begin UWidget Interface
    UMG_API virtual TSharedRef<SWidget> RebuildWidget() override;
    // End of UWidget
 
    UMG_API void HandleOnTextChanged(const FText& Text);
    UMG_API void HandleOnTextCommitted(const FText& Text, ETextCommit::Type CommitMethod);
 
protected:
    TSharedPtr<SMultiLineEditableTextBox> MyEditableTextBlock;
 
    PROPERTY_BINDING_IMPLEMENTATION(FText, HintText);
 
private:
    bool SetTextInternal(const FText& InText);
 
#if WITH_EDITORONLY_DATA
    UPROPERTY()
    bool bIsFontDeprecationDone;
#endif
};