WSTextFieldBase.h

/* 
* Copyright (c) 2021 THEIA INTERACTIVE.  All rights reserved.
*
* Website: https://widgetstudio.design
* Documentation: https://docs.widgetstudio.design
* Support: marketplace@theia.io
* Marketplace FAQ: https://marketplacehelp.epicgames.com
*/
 
#pragma once
 
#include "CoreMinimal.h"
#include "Basic/WSText.h"
#include "Widgets/WSBase.h"
#include "WSTextFieldBase.generated.h"
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FWSTextFieldTextChangedDelegate, const FText&, Text);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FWSTextFieldTextCommittedDelegate, const FText&, Text, ETextCommit::Type, CommitMethod);
 
UENUM(BlueprintType)
enum class ETextFilter : uint8
{
    None            UMETA(DisplayName="None"),
    TextOnly        UMETA(DisplayName="Text Only"),
    NumbersOnly     UMETA(DisplayName="Numbers Only"),
 
    TextFilter_Max  UMETA(Hidden),
};
 
UENUM(BlueprintType)
enum class ETextFieldIconVisibility : uint8
{
    Hidden                  UMETA(DisplayName="Hidden"),
    Leading                 UMETA(DisplayName="Leading"),
    Trailing                UMETA(DisplayName="Trailing"),
    LeadingAndTrailing      UMETA(DisplayName="Leading & Trailing"),
 
    TextFieldStyle_Max      UMETA(Hidden),
};
 
UENUM(BlueprintType)
enum class ETextFieldState : uint8
{
    Normal      UMETA(DisplayName="Normal"),
    Focused     UMETA(DisplayName="Focused"),
    Accepted    UMETA(DisplayName="Accepted"),
    Warning     UMETA(DisplayName="Warning"),
    Error       UMETA(DisplayName="Error"),
 
    TextFieldState_Max  UMETA(Hidden),
};
 
UCLASS()
class WIDGETSTUDIORUNTIME_API UWidgetStudioTextFieldBase : public UWidgetStudioBase
{
    GENERATED_BODY()
 
protected:
    UWidgetStudioTextFieldBase(const FObjectInitializer& ObjectInitializer);
    
    /* Overrides */
    virtual void SynchronizeProperties() override;
 
    /* Delegates */
 
    UFUNCTION()
    virtual void OnTextInputTextChanged(const FText& InText);
    
    UFUNCTION()
    virtual void OnTextInputTextCommitted(const FText& InText, ETextCommit::Type InCommitMethod);
 
    
    /* Properties */
 
    UPROPERTY(EditAnywhere, Category = "Widget Studio", meta=(DesignerRebuild="True", ForceRebuildProperty="Text"))
    bool bMultiLine = false;
 
    UPROPERTY(EditAnywhere, Category = "Widget Studio|Deprecated",Meta=(DeprecatedProperty, DeprecationMessage="Per-widget labeling is no longer supported. Place this widget in the Label Widget instead."))
    FText Label;
    
    UPROPERTY(EditAnywhere, Category = "Widget Studio")
    FText PlaceholderText = FText().FromString("Enter text here!");
 
    UPROPERTY(EditAnywhere, Category = "Widget Studio", Meta = (MultiLine = bMultiLine))
    FText Text = FText().FromString("");
 
    UPROPERTY(EditAnywhere, Category = "Widget Studio")
    FWSTextStyle TextStyle = FWSTextStyle(
        EWSFontType::Body2,
        FFontStyle(),
        EFontCase::Sentence,
        ETextJustify::Left,
        true,
        0,
        ETextWrappingPolicy::DefaultWrapping);
    
    UPROPERTY(EditAnywhere, Category = "Widget Studio")
    ETextFieldState State = ETextFieldState::Normal;
 
    UPROPERTY(EditAnywhere, Category = "Widget Studio")
    ETextFilter Filter = ETextFilter::None;
 
    UPROPERTY(EditAnywhere, Category = "Widget Studio", Meta = (ClampMin = "0", UIMin = "0"))
    int32 CharacterLimit = 0;
 
    UPROPERTY(EditAnywhere, Category = "Widget Studio", Meta=(EditCondition = "!bMultiLine", EditConditionHides))
    bool bIsPasswordField = false;
 
public:
 
    /* Bindings */
    
    UPROPERTY(BlueprintAssignable, Category = "Widget Studio|Event")
    FWSTextFieldTextChangedDelegate OnTextChanged;
 
    UPROPERTY(BlueprintAssignable, Category = "Widget Studio|Event")
    FWSTextFieldTextCommittedDelegate OnTextCommitted;
 
    
    /* Helpers */
 
    UFUNCTION(BlueprintPure, Category = "Widget Studio|Deprecated",Meta=(DeprecatedProperty, DeprecationMessage="Per-widget labeling is no longer supported. Place this widget in the Label Widget instead."))
    FText GetLabel() const;
 
    UFUNCTION(BlueprintPure, Category = "Widget Studio|Helper")
    FText GetText() const;
 
    UFUNCTION(BlueprintPure, Category = "Widget Studio|Helper")
    FText GetPlaceholderText() const;
 
    UFUNCTION(BlueprintPure, Category = "Widget Studio|Helper")
    ETextFilter GetFilter() const;
 
    UFUNCTION(BlueprintPure, Category = "Widget Studio|Helper")
    int32 GetCharacterLimit() const;
 
    UFUNCTION(BlueprintPure, Category = "Widget Studio|Helper")
    ETextFieldState GetState() const;
 
    UFUNCTION(BlueprintPure, Category = "Widget Studio|Helper")
    bool IsPasswordField() const;
 
    
    /* Modifiers */
 
    UFUNCTION(BlueprintCallable, Category = "Widget Studio|Deprecated",Meta=(DeprecatedProperty, DeprecationMessage="Per-widget labeling is no longer supported. Place this widget in the Label Widget instead."))
    virtual void SetLabel(FText NewLabel);
 
    UFUNCTION(BlueprintCallable, Category = "Widget Studio|Modifier")
    virtual void SetText(FText NewText);
 
    UFUNCTION(BlueprintCallable, Category = "Widget Studio|Modifier")
    virtual void SetPlaceholderText(FText NewText);
 
    UFUNCTION(BlueprintCallable, Category = "Widget Studio|Modifier")
    virtual void SetFilter(ETextFilter NewFilter);
 
    UFUNCTION(BlueprintCallable, Category = "Widget Studio|Modifier")
    virtual void SetCharacterLimit(int32 NewLimit);
 
    UFUNCTION(BlueprintCallable, Category = "Widget Studio|Modifier")
    virtual void SetState(ETextFieldState NewState);
    
};