EditableTextBox.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 "Layout/Margin.h"
#include "Styling/SlateTypes.h"
#include "Widgets/SWidget.h"
#include "Components/Widget.h"
#include "Components/TextWidgetTypes.h"
#include "Widgets/Text/ISlateEditableTextWidget.h"
#include "EditableTextBox.generated.h"
 
class SEditableTextBox;
class USlateWidgetStyleAsset;
 
UCLASS(meta=(DisplayName="Text Box"), MinimalAPI)
class UEditableTextBox : public UWidget
{
    GENERATED_UCLASS_BODY()
 
public:
 
    DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnEditableTextBoxChangedEvent, const FText&, Text);
    DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FOnEditableTextBoxCommittedEvent, 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:
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category=Appearance, meta=(DisplayName="Style", ShowOnlyInnerProperties))
    FEditableTextBoxStyle WidgetStyle;
 
    UE_DEPRECATED(5.1, "Direct access to Hint Text is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, BlueprintSetter = "SetHintText", Category = Content, meta = (MultiLine = "true"))
    FText HintText;
 
    UPROPERTY()
    FGetText HintTextDelegate;
 
    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=SetMinDesiredWidth, 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, 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="TextBox|Event")
    FOnEditableTextBoxChangedEvent OnTextChanged;
 
    UPROPERTY(BlueprintAssignable, Category="TextBox|Event")
    FOnEditableTextBoxCommittedEvent OnTextCommitted;
 
    //SLATE_ARGUMENT(TSharedPtr<class IErrorReportingWidget>, ErrorReporting)
 
public:
 
    UFUNCTION(BlueprintCallable, Category="Widget", meta=(DisplayName="GetText (Text Box)"))
    UMG_API FText GetText() const;
 
    UFUNCTION(BlueprintCallable, Category="Widget", meta=(DisplayName="SetText (Text Box)"))
    UMG_API void SetText(FText InText);
    
    UMG_API FText GetHintText() const;
 
    UFUNCTION(BlueprintCallable, Category = "Widget", meta = (DisplayName = "Set Hint Text (Text Box)"))
    UMG_API void SetHintText(FText InText);
 
    UMG_API float GetMinimumDesiredWidth() const;
 
    UMG_API void SetMinDesiredWidth(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 void SetClearKeyboardFocusOnCommit(bool bClearKeyboardFocusOnCommit);
 
    UMG_API bool GetClearKeyboardFocusOnCommit() const;
 
    UMG_API void SetSelectAllTextOnCommit(bool bSelectAllTextOnCommit);
 
    UMG_API bool GetSelectAllTextOnCommit() const;
 
    UFUNCTION(BlueprintCallable, Category="Widget",  meta=(DisplayName="SetError (Text Box)"))
    UMG_API void SetError(FText InError);
 
    UMG_API bool GetIsReadOnly() const;
 
    UFUNCTION(BlueprintCallable, Category = "Widget", meta = (DisplayName = "SetIsReadOnly (Editable Text)"))
    UMG_API void SetIsReadOnly(UPARAM(DisplayName = "ReadyOnly") bool bReadOnly);
 
    UMG_API bool GetIsPassword() const;
 
    UFUNCTION(BlueprintCallable, Category = "Widget", meta = (DisplayName = "IsPassword"))
    UMG_API void SetIsPassword(bool bIsPassword);
 
    UFUNCTION(BlueprintCallable, Category="Widget")
    UMG_API void ClearError();
 
    UFUNCTION(BlueprintCallable, Category = "Widget")
    UMG_API bool HasError() const;
 
    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 SetWidgetStyle(const FEditableTextBoxStyle& InStyle);
 
    UMG_API const FEditableTextBoxStyle& GetWidgetStyle() const;
 
    UFUNCTION(BlueprintCallable, Category="Widget", meta=(DisplayName="SetForegroundColor (Text Box)"))
    UMG_API void SetForegroundColor(FLinearColor color);
 
    //~ 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 UWidget Interface
    UMG_API virtual TSharedRef<SWidget> RebuildWidget() override;
    // End of UWidget
 
    UMG_API virtual void HandleOnTextChanged(const FText& Text);
    UMG_API virtual void HandleOnTextCommitted(const FText& Text, ETextCommit::Type CommitMethod);
 
#if WITH_ACCESSIBILITY
    UMG_API virtual TSharedPtr<SWidget> GetAccessibleWidget() const override;
#endif
 
protected:
    TSharedPtr<SEditableTextBox> MyEditableTextBlock;
 
    PROPERTY_BINDING_IMPLEMENTATION(FText, Text);
    PROPERTY_BINDING_IMPLEMENTATION(FText, HintText);
 
private:
    bool SetTextInternal(const FText& InText);
 
#if WITH_EDITORONLY_DATA
    UPROPERTY()
    bool bIsFontDeprecationDone;
#endif
};