WSButtonBase.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 "Widgets/WSBase.h"
#include "Blueprint/UserWidget.h"
#include "WSButtonBase.generated.h"
 
DECLARE_DELEGATE(FWSButtonLambda);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FWSButtonDelegate, UWidgetStudioButtonBase*, CallingButton);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FWSButtonToggledDelegate, UWidgetStudioButtonBase*, CallingButton, bool, NewCheckedState);
 
UCLASS()
class WIDGETSTUDIORUNTIME_API UWidgetStudioButtonBase : public UWidgetStudioBase
{
    GENERATED_BODY()
 
    // Depicts if the button is currently being pressed down.
    bool bIsPressed = false;
 
protected:
    virtual void NativeOnInitialized() override;
    virtual FReply NativeOnMouseButtonDown(const FGeometry& InGeometry, const FPointerEvent& InMouseEvent) override;
    virtual FReply NativeOnMouseButtonUp(const FGeometry& InGeometry, const FPointerEvent& InMouseEvent) override;
    virtual void NativeOnMouseCaptureLost(const FCaptureLostEvent& CaptureLostEvent) override;
    virtual void NativeOnMouseLeave(const FPointerEvent& InMouseEvent) override;
 
    FTimerHandle DoublePressTimer;
    
    /* States */
 
    UPROPERTY(EditAnywhere, Category = "Widget Studio|State")
    bool bIsCheckable = false;
 
    UPROPERTY(EditAnywhere, Category = "Widget Studio|State", Meta = (EditCondition="bIsCheckable == true"))
    bool bIsChecked = false;
 
    UPROPERTY(EditAnywhere, Category = "Widget Studio|State", Meta = (EditCondition="bIsCheckable == true"))
    bool bIsCheckedStateLocked = false;
 
public:
 
    /* Bindings */
 
    FWSButtonLambda OnPressedLambda;
 
    UPROPERTY(BlueprintAssignable, Category = "Widget Studio|Event")
    FWSButtonDelegate OnPressed;
 
    UPROPERTY(BlueprintAssignable, Category = "Widget Studio|Event")
    FWSButtonDelegate OnReleased;
 
    UPROPERTY(BlueprintAssignable, Category = "Widget Studio|Event")
    FWSButtonDelegate OnDoublePressed;
 
    UFUNCTION(BlueprintCallable, Category = "Widget Studio|Event|Advanced")
    void ExecuteOnPressedLambda(UWidgetStudioButtonBase* CallingButton)
    {
        OnPressedLambda.ExecuteIfBound();
    }
 
    UPROPERTY(BlueprintAssignable, Category = "Widget Studio|Event")
    FWSButtonToggledDelegate OnToggled;
 
    UPROPERTY()
    bool bForceCheckable = false;
 
    UPROPERTY()
    bool bIsInteractable = true;
 
    /* Helpers */
 
    UFUNCTION(BlueprintPure, Category = "Widget Studio|Helper|State")
    bool IsCheckable() const;
 
    UFUNCTION(BlueprintPure, Category = "Widget Studio|Helper|State")
    bool IsChecked() const;
 
    UFUNCTION(BlueprintPure, Category = "Widget Studio|Helper|State")
    bool IsCheckedStateLocked() const;
 
    UFUNCTION(BlueprintPure, Category = "Widget Studio|Helper|State")
    bool IsPressed() const;
 
    /* Modifiers */
 
    UFUNCTION(BlueprintCallable, Category = "Widget Studio|Modifier|State")
    virtual void SetCheckable(bool bNewCheckableState);
 
    UFUNCTION(BlueprintCallable, Category = "Widget Studio|Modifier|State")
    virtual void SetChecked(bool bNewCheckedState, bool bBroadcast = true);
 
    UFUNCTION(BlueprintCallable, Category = "Widget Studio|Modifier|State")
    virtual void SetCheckedLockedState(bool bNewCheckedState);
};