MultiLineEditableText.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 "MultiLineEditableText.generated.h"
 
class UMaterialInterface;
class SMultiLineEditableText;
 
UCLASS(meta=( DisplayName="Editable Text (Multi-Line)" ), MinimalAPI)
class UMultiLineEditableText : public UTextLayoutWidget
{
    GENERATED_UCLASS_BODY()
 
public:
 
    DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnMultiLineEditableTextChangedEvent, const FText&, Text);
    DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FOnMultiLineEditableTextCommittedEvent, 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, BlueprintSetter=SetWidgetStyle, Category="Style", meta=(ShowOnlyInnerProperties))
    FTextBlockStyle WidgetStyle;
 
    UE_DEPRECATED(5.1, "Direct access to IsReadOnly is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter = GetIsReadOnly, Setter = SetIsReadOnly, BlueprintSetter = "SetIsReadOnly", Category = Appearance)
    bool bIsReadOnly;
 
    UE_DEPRECATED(5.1, "Direct access to SelectAllTextWhenFocused is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category = Behavior, AdvancedDisplay)
    bool SelectAllTextWhenFocused;
 
    UE_DEPRECATED(5.1, "Direct access to ClearTextSelectionOnFocusLoss is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, Category = Behavior, AdvancedDisplay)
    bool ClearTextSelectionOnFocusLoss;
 
    UE_DEPRECATED(5.1, "Direct access to RevertTextOnEscape is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category = Behavior, AdvancedDisplay)
    bool RevertTextOnEscape;
 
    UE_DEPRECATED(5.1, "Direct access to ClearKeyboardFocusOnCommit is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category = Behavior, AdvancedDisplay)
    bool ClearKeyboardFocusOnCommit;
 
    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 Editable Text)"))
    FOnMultiLineEditableTextChangedEvent OnTextChanged;
 
    UPROPERTY(BlueprintAssignable, Category="Widget Event", meta=(DisplayName="OnTextCommitted (Multi-Line Editable Text)"))
    FOnMultiLineEditableTextCommittedEvent OnTextCommitted;
 
public:
 
    UFUNCTION(BlueprintCallable, Category="Widget", meta=(DisplayName="GetText (Multi-Line Editable Text)"))
    UMG_API FText GetText() const;
 
    UFUNCTION(BlueprintCallable, Category="Widget", meta=(DisplayName="SetText (Multi-Line Editable Text)"))
    UMG_API void SetText(FText InText);
 
    UFUNCTION(BlueprintCallable, Category="Widget", meta=(DisplayName="GetHintText (Multi-Line Editable Text)"))
    UMG_API FText GetHintText() const;
 
    UFUNCTION(BlueprintCallable, Category="Widget", meta=(DisplayName="SetHintText (Multi-Line Editable Text)"))
    UMG_API void SetHintText(FText InHintText);
 
    UMG_API void SetSelectAllTextWhenFocused(bool bSelectAllTextWhenFocused);
 
    UMG_API bool GetSelectAllTextWhenFocused() const;
 
    UMG_API void SetClearTextSelectionOnFocusLoss(bool bClearTextSelectionOnFocusLoss);
 
    UMG_API bool GetClearTextSelectionOnFocusLoss() const;
 
    UMG_API void SetRevertTextOnEscape(bool bRevertTextOnEscape);
 
    UMG_API bool GetRevertTextOnEscape() const;
 
    UMG_API void SetClearKeyboardFocusOnCommit(bool bClearKeyboardFocusOnCommit);
 
    UMG_API bool GetClearKeyboardFocusOnCommit() const; 
 
    UMG_API bool GetIsReadOnly() const;
 
    UFUNCTION(BlueprintCallable, Category="Widget", meta=(DisplayName="SetIsReadOnly (Multi-Line Editable Text"))
    UMG_API void SetIsReadOnly(bool bReadOnly);
 
    UFUNCTION(BlueprintSetter)
    UMG_API void SetWidgetStyle(const FTextBlockStyle& InWidgetStyle);
 
    UFUNCTION(BlueprintCallable, Category = "Appearance")
    UMG_API const FSlateFontInfo& GetFont() const;
 
    UFUNCTION(BlueprintCallable, Category = "Appearance")
    UMG_API void SetFont(FSlateFontInfo InFontInfo);
 
    UFUNCTION(BlueprintCallable, Category = "Appearance")
    UMG_API void SetFontMaterial(UMaterialInterface* InMaterial);
 
    UFUNCTION(BlueprintCallable, Category = "Appearance")
    UMG_API void SetFontOutlineMaterial(UMaterialInterface* InMaterial);
 
    //~ 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
 
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<SMultiLineEditableText> MyMultiLineEditableText;
 
    PROPERTY_BINDING_IMPLEMENTATION(FText, HintText);
 
private:
    bool SetTextInternal(const FText& InText);
};