EditableText.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/SlateColor.h"
#include "Styling/SlateTypes.h"
#include "Widgets/SWidget.h"
#include "Components/Widget.h"
#include "Components/TextWidgetTypes.h"
#include "Widgets/Text/ISlateEditableTextWidget.h"
#include "EditableText.generated.h"
 
class SEditableText;
class UMaterialInterface;
class USlateBrushAsset;
class USlateWidgetStyleAsset;
 
UCLASS(MinimalAPI)
class UEditableText : public UWidget
{
    GENERATED_UCLASS_BODY()
 
public:
 
    DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnEditableTextChangedEvent, const FText&, Text);
    DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FOnEditableTextCommittedEvent, 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")
    FText Text;
 
    UPROPERTY()
    FGetText TextDelegate;
 
public:
 
    UE_DEPRECATED(5.1, "Direct access to Hint Text 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;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Setter, Category=Appearance, meta=(DisplayName="Style", ShowOnlyInnerProperties))
    FEditableTextStyle WidgetStyle;
 
    UE_DEPRECATED(5.1, "Direct access to IsReadOnly is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category = Appearance)
    bool IsReadOnly;
 
    UE_DEPRECATED(5.1, "Direct access to IsPassword is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, BlueprintSetter = "SetIsPassword", Category = Appearance)
    bool IsPassword;
 
    UE_DEPRECATED(5.1, "Direct access to MinimumDesiredWidth is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, BlueprintSetter = "SetMinimumDesiredWidth", Category = "Appearance")
    float MinimumDesiredWidth;
 
    UE_DEPRECATED(5.1, "Direct access to IsCaretMovedWhenGainFocus is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category = Behavior, AdvancedDisplay)
    bool IsCaretMovedWhenGainFocus;
 
    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 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;
 
    UE_DEPRECATED(5.1, "Direct access to SelectAllTextOnCommit is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category = Behavior, AdvancedDisplay)
    bool SelectAllTextOnCommit;
 
    UPROPERTY(EditAnywhere, Category=Behavior, AdvancedDisplay)
    bool AllowContextMenu;
 
    UPROPERTY(EditAnywhere, Category=Behavior, AdvancedDisplay)
    TEnumAsByte<EVirtualKeyboardType::Type> KeyboardType;
 
    UPROPERTY(EditAnywhere, Category=Behavior, AdvancedDisplay)
    FVirtualKeyboardOptions VirtualKeyboardOptions;
 
    UPROPERTY(EditAnywhere, Category = Behavior, AdvancedDisplay)
    EVirtualKeyboardTrigger VirtualKeyboardTrigger;
 
    UPROPERTY(EditAnywhere, Category=Behavior, AdvancedDisplay)
    EVirtualKeyboardDismissAction VirtualKeyboardDismissAction;
    
    UE_DEPRECATED(5.1, "Direct access to Justification is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Blueprintgetter = GetJustification, BlueprintSetter = SetJustification, Category = Appearance)
    TEnumAsByte<ETextJustify::Type> Justification;
 
    UE_DEPRECATED(5.1, "Direct access to OverflowPolicy is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter = "GetTextOverflowPolicy", Setter = "SetTextOverflowPolicy", BlueprintSetter = "SetTextOverflowPolicy", Category = "Clipping", AdvancedDisplay, meta = (DisplayName = "Overflow Policy"))
    ETextOverflowPolicy OverflowPolicy;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category=Localization, AdvancedDisplay, meta=(ShowOnlyInnerProperties))
    FShapedTextOptions ShapedTextOptions;
 
public:
 
    UPROPERTY(BlueprintAssignable, Category="Widget Event", meta=(DisplayName="OnTextChanged (Editable Text)"))
    FOnEditableTextChangedEvent OnTextChanged;
 
    UPROPERTY(BlueprintAssignable, Category="Widget Event", meta=(DisplayName="OnTextCommitted (Editable Text)"))
    FOnEditableTextCommittedEvent OnTextCommitted;
 
    UFUNCTION(BlueprintCallable, Category = "Widget", meta=(DisplayName="GetText (Editable Text)"))
    UMG_API FText GetText() const;
 
    UFUNCTION(BlueprintCallable, Category = "Widget", meta=(DisplayName="SetText (Editable Text)"))
    UMG_API void SetText(FText InText);
 
    UMG_API bool GetIsPassword() const;
 
    UFUNCTION(BlueprintCallable, Category = "Widget")
    UMG_API void SetIsPassword(UPARAM(DisplayName="IsPassword") bool InbIsPassword);
 
    UFUNCTION(BlueprintCallable, Category = "Widget", meta = (DisplayName = "GetHintText (Editable Text)"))
    UMG_API FText GetHintText() const;
 
    UFUNCTION(BlueprintCallable, Category = "Widget")
    UMG_API void SetHintText(FText InHintText);
 
    UMG_API float GetMinimumDesiredWidth() const;
 
    UFUNCTION(BlueprintCallable, Category = "Appearance")
    UMG_API void SetMinimumDesiredWidth(float InMinDesiredWidth);
 
    UMG_API void SetIsCaretMovedWhenGainFocus(bool bIsCaretMovedWhenGainFocus);
 
    UMG_API bool GetIsCaretMovedWhenGainFocus() const;
 
    UMG_API void SetSelectAllTextWhenFocused(bool bSelectAllTextWhenFocused);
 
    UMG_API bool GetSelectAllTextWhenFocused() const;
 
    UMG_API void SetRevertTextOnEscape(bool bRevertTextOnEscape);
 
    UMG_API bool GetRevertTextOnEscape() const;
 
    UMG_API bool GetClearKeyboardFocusOnCommit() const;
 
    UMG_API void SetSelectAllTextOnCommit(bool bSelectAllTextOnCommit);
 
    UMG_API bool GetSelectAllTextOnCommit() const;
 
    UMG_API void SetWidgetStyle(const FEditableTextStyle& InEditableTextStyle);
 
    UMG_API bool GetIsReadOnly() const;
 
    UFUNCTION(BlueprintCallable, Category = "Widget", meta=(DisplayName="SetIsReadOnly (Editable Text)"))
    UMG_API void SetIsReadOnly(UPARAM(DisplayName="ReadyOnly") bool InbIsReadyOnly);
 
    UFUNCTION(BlueprintCallable, Category = "Widget")
    UMG_API ETextJustify::Type GetJustification() const;
 
    UFUNCTION(BlueprintSetter)
    UMG_API void SetJustification(ETextJustify::Type InJustification);
 
    UMG_API ETextOverflowPolicy GetTextOverflowPolicy() const;
 
    UFUNCTION(BlueprintSetter)
    UMG_API void SetTextOverflowPolicy(ETextOverflowPolicy InOverflowPolicy);
 
    UMG_API void SetClearKeyboardFocusOnCommit(bool bInClearKeyboardFocusOnCommit);
 
    UMG_API void SetKeyboardType(EVirtualKeyboardType::Type Type);
 
    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);
 
    UMG_API bool GetEnableIntegratedKeyboard() const;
    UMG_API void SetEnableIntegratedKeyboard(bool InEnableIntegratedKeyboard);
 
    /* Function to spawn virtual keyboard on demand */
    UFUNCTION(BlueprintCallable, Category = "VirtualKeyboard")
    UMG_API void ToggleVirtualKeyboard(bool bShow); 
 
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
    //~ End UWidget Interface
 
protected:
    //~ 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);
 
#if WITH_ACCESSIBILITY
    UMG_API virtual TSharedPtr<SWidget> GetAccessibleWidget() const override;
#endif
 
protected:
    TSharedPtr<SEditableText> MyEditableText;
 
    PROPERTY_BINDING_IMPLEMENTATION(FText, Text);
    PROPERTY_BINDING_IMPLEMENTATION(FText, HintText);
 
private:
    bool SetTextInternal(const FText& InText);
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category = Mobile, AdvancedDisplay, meta = (AllowPrivateAccess = "true"))
    bool EnableIntegratedKeyboard;
};