WSModernCheckBox.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/WSButtonBase.h"
#include "Widgets/Basic/WSIcon.h"
#include "Widgets/Basic/WSText.h"
#include "Components/HorizontalBox.h"
#include "Components/Image.h"
#include "Components/InvalidationBox.h"
#include "Components/Overlay.h"
#include "Components/SizeBox.h"
#include "Components/Spacer.h"
 
#include "WSModernCheckBox.generated.h"
 
UENUM(Blueprintable, BlueprintType, META=(Tooltip = "The styling of the checkbox."))
enum class ECheckboxStyle : uint8
{
    Modern              UMETA(DisplayName="Modern"),
    Classic             UMETA(DisplayName="Classic"),
    
    CheckboxStyle_Max   UMETA(Hidden),
};
 
UENUM(Blueprintable, BlueprintType, META=(Tooltip = "Choose between inclusive or exclusive."))
enum class EClusivity : uint8
{
    Inclusive               UMETA(DisplayName="Inclusive", Description="Multiple options can be selected at a time."),
    Exclusive               UMETA(DisplayName="Exclusive", Description="Only a single option can be selected at a time."),
    
    Clusivity_Max   UMETA(Hidden),
};
 
 
UCLASS()
class WIDGETSTUDIORUNTIME_API UWidgetStudioModernCheckBox : public UWidgetStudioButtonBase
{
    GENERATED_BODY()
 
protected:
    
    virtual TSharedRef<SWidget> RebuildWidget() override;
    virtual int32 NativePaint(const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawElements, int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled) const override;
    virtual void SynchronizeProperties() override;
    virtual void InitializeStyling() override;
    virtual void UpdateStyling() override;
    
    /* Widget Components */
 
    UPROPERTY(BlueprintReadOnly, Category = "Widgets")
    UInvalidationBox* Retainer = nullptr;
 
    UPROPERTY(BlueprintReadOnly, Category = "Widgets")
    USizeBox* SizeBox = nullptr;
 
    UPROPERTY(BlueprintReadOnly, Category = "Widgets")
    UScaleBox* BackgroundScaleBox = nullptr;
 
    UPROPERTY(BlueprintReadOnly, Category = "Widgets")
    UOverlay* Overlay = nullptr;
 
    UPROPERTY(BlueprintReadOnly, Category = "Widgets")
    UOverlay* BackgroundOverlay = nullptr;
 
    UPROPERTY(BlueprintReadOnly, Category = "Widgets")
    UImage* DropShadow = nullptr;
 
    UPROPERTY(BlueprintReadOnly, Category = "Widgets")
    UImage* Background = nullptr;
 
    UPROPERTY(BlueprintReadOnly, Category = "Widgets")
    UScaleBox* CheckScaleBox = nullptr;
 
    UPROPERTY(BlueprintReadOnly, Category = "Widgets")
    UImage* BackgroundOutline = nullptr;
 
    UPROPERTY(BlueprintReadOnly, Category = "Widgets")
    UHorizontalBox* HBox = nullptr;
 
    UPROPERTY(BlueprintReadOnly, Category = "Widgets")
    UOverlay* CheckOverlay = nullptr;
 
    UPROPERTY(BlueprintReadOnly, Category = "Widgets")
    UImage* CheckBackground = nullptr;
 
    UPROPERTY(BlueprintReadOnly, Category = "Widgets")
    UImage* CheckOutline = nullptr;
 
    UPROPERTY(BlueprintReadOnly, Category = "Widgets")
    UImage* IconItem = nullptr;
 
    UPROPERTY(BlueprintReadOnly, Category = "Widgets")
    UWidgetStudioText* TextItem = nullptr;
 
    UPROPERTY(BlueprintReadOnly, Category = "Widgets")
    USpacer* SpacerItem = nullptr;
 
private:
    
    UPROPERTY(EditAnywhere, Category = "Widget Studio")
    FText Text = FText().FromString("CheckBox");
    
    UPROPERTY(EditAnywhere, Category = "Widget Studio")
    EIconItem Icon = EIconItem::Check;
 
    UPROPERTY(EditAnywhere, Category = "Widget Studio")
    ECheckboxStyle Style = ECheckboxStyle::Modern;
    
    UPROPERTY(EditAnywhere, Category = "Widget Studio")
    EClusivity Clusivity = EClusivity::Inclusive;
 
    /* Colors */
 
    UPROPERTY(EditAnywhere, Category = "Widget Studio|Color")
    EPalette BackgroundColor = EPalette::TertiaryBackground;
 
    UPROPERTY(EditAnywhere, Category = "Widget Studio|Color")
    EPalette ContentColor = EPalette::PrimaryContent;
 
    UPROPERTY(EditAnywhere, Category = "Widget Studio|Color")
    EPalette CheckedColor = EPalette::PrimaryAccent;
 
public:
 
    /* Helpers */
 
    UFUNCTION(BlueprintPure, Category = "Widget Studio|Helper")
    FText GetLabel() const;
 
    UFUNCTION(BlueprintPure, Category = "Widget Studio|Helper")
    EIconItem GetIcon() const;
    
    UFUNCTION(BlueprintPure, Category = "Widget Studio|Helper|Color")
    EPalette GetBackgroundColor() const;
 
    UFUNCTION(BlueprintPure, Category = "Widget Studio|Helper|Color")
    EPalette GetContentColor() const;
 
    UFUNCTION(BlueprintPure, Category = "Widget Studio|Helper|Color")
    EPalette GetCheckedColor() const;
 
    UFUNCTION(BlueprintPure, Category = "Widget Studio|Helper|Color")
    EClusivity GetSelectionMethod() const;
 
    
    /* Modifiers */
 
    UFUNCTION(BlueprintCallable, Category = "Widget Studio|Modifier")
    void SetText(FText NewText);
 
    UFUNCTION(BlueprintCallable, Category = "Widget Studio|Modifier")
    void SetIcon(EIconItem NewIcon);
 
    UFUNCTION(BlueprintCallable, Category = "Widget Studio|Modifier|Color")
    void SetBackgroundColor(EPalette NewColor);
 
    UFUNCTION(BlueprintCallable, Category = "Widget Studio|Modifier|Color")
    void SetContentColor(EPalette NewColor);
 
    UFUNCTION(BlueprintCallable, Category = "Widget Studio|Modifier|Color")
    void SetCheckedColor(EPalette NewColor);
 
    /* The button selection method.
    * Inclusive: Multiple buttons can be selected at a time.
    * Exclusive: Only a single button can be selected at a time.
    * @param NewState The clusivity to use.
    */
    UFUNCTION(BlueprintCallable, Category = "Widget Studio|Modifier")
    void SetSelectionMethod(EClusivity NewState);
};