CheckBox.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 "Layout/Margin.h"
#include "Styling/SlateColor.h"
#include "Styling/SlateTypes.h"
#include "Widgets/SWidget.h"
#include "Binding/States/WidgetStateRegistration.h"
#include "Components/ContentWidget.h"
 
#include "CheckBox.generated.h"
 
class SCheckBox;
class USlateBrushAsset;
class USlateWidgetStyleAsset;
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam( FOnCheckBoxComponentStateChanged, bool, bIsChecked );
 
UCLASS(MinimalAPI)
class UCheckBox : public UContentWidget
{
    GENERATED_UCLASS_BODY()
 
public:
    UE_DEPRECATED(5.1, "Direct access to CheckedState is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, BlueprintGetter="GetCheckedState", BlueprintSetter="SetCheckedState", FieldNotify, Category="Appearance")
    ECheckBoxState CheckedState;
 
    UE_DEPRECATED(5.2, "Direct access to CheckedStateDelegate is deprecated. Please use the InitCheckedStateDelegate() function.")
    UPROPERTY()
    FGetCheckBoxState CheckedStateDelegate;
 
    UE_DEPRECATED(5.1, "Direct access to WidgetStyle is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category="Style", meta = (DisplayName="Style"))
    FCheckBoxStyle WidgetStyle;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Appearance")
    TEnumAsByte<EHorizontalAlignment> HorizontalAlignment;
 
    UE_DEPRECATED(5.1, "Direct access to ClickMethod is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, BlueprintSetter="SetClickMethod", Category="Interaction", AdvancedDisplay)
    TEnumAsByte<EButtonClickMethod::Type> ClickMethod;
 
    UE_DEPRECATED(5.1, "Direct access to TouchMethod is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, BlueprintSetter="SetTouchMethod", Category="Interaction", AdvancedDisplay)
    TEnumAsByte<EButtonTouchMethod::Type> TouchMethod;
 
    UE_DEPRECATED(5.1, "Direct access to PressMethod is deprecated. Please use the getter or setter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, BlueprintSetter="SetPressMethod", Category="Interaction", AdvancedDisplay)
    TEnumAsByte<EButtonPressMethod::Type> PressMethod;
 
    UE_DEPRECATED(5.2, "Direct access to bIsFocusable is deprecated. Please use the getter. Note that this property is only set at construction and is not modifiable at runtime.")
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Getter, Category="Interaction")
    bool IsFocusable;
 
public:
 
    UPROPERTY(BlueprintAssignable, Category="CheckBox|Event")
    FOnCheckBoxComponentStateChanged OnCheckStateChanged;
 
public:
 
    UFUNCTION(BlueprintCallable, Category="Widget")
    UMG_API bool IsPressed() const;
    
    UFUNCTION(BlueprintCallable, Category="Widget")
    UMG_API bool IsChecked() const;
 
    UFUNCTION(BlueprintCallable, Category="Widget")
    UMG_API ECheckBoxState GetCheckedState() const;
 
    UFUNCTION(BlueprintCallable, Category="Widget")
    UMG_API void SetIsChecked(bool InIsChecked);
 
    UFUNCTION(BlueprintCallable, Category="Widget")
    UMG_API void SetCheckedState(ECheckBoxState InCheckedState);
 
    UMG_API const FCheckBoxStyle& GetWidgetStyle() const;
 
    UMG_API void SetWidgetStyle(const FCheckBoxStyle& InStyle);
 
    UMG_API EButtonClickMethod::Type GetClickMethod() const;
 
    UFUNCTION(BlueprintCallable, Category="Button")
    UMG_API void SetClickMethod(EButtonClickMethod::Type InClickMethod);
 
    UMG_API EButtonTouchMethod::Type GetTouchMethod() const;
 
    UFUNCTION(BlueprintCallable, Category="Button")
    UMG_API void SetTouchMethod(EButtonTouchMethod::Type InTouchMethod);
 
    UMG_API EButtonPressMethod::Type GetPressMethod() const;
 
    UFUNCTION(BlueprintCallable, Category="Button")
    UMG_API void SetPressMethod(EButtonPressMethod::Type InPressMethod);
 
    UMG_API bool GetIsFocusable() const;
 
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
 
protected:
 
    // UPanelWidget
    UMG_API virtual void OnSlotAdded(UPanelSlot* Slot) override;
    UMG_API virtual void OnSlotRemoved(UPanelSlot* Slot) override;
    // End UPanelWidget
 
    UMG_API void InitIsFocusable(bool InIsFocusable);
 
    UMG_API void InitCheckedStateDelegate(FGetCheckBoxState InCheckedStateDelegate);
protected:
    //~ Begin UWidget Interface
    UMG_API virtual TSharedRef<SWidget> RebuildWidget() override;
#if WITH_EDITOR
    virtual TSharedRef<SWidget> RebuildDesignWidget(TSharedRef<SWidget> Content) override
    {
        return Content;
    }
#endif
    //~ End UWidget Interface
 
    UMG_API void SlateOnCheckStateChangedCallback(ECheckBoxState NewState);
 
#if WITH_ACCESSIBILITY
    UMG_API virtual TSharedPtr<SWidget> GetAccessibleWidget() const override;
#endif
    
protected:
    TSharedPtr<SCheckBox> MyCheckbox;
 
PRAGMA_DISABLE_DEPRECATION_WARNINGS
    PROPERTY_BINDING_IMPLEMENTATION(ECheckBoxState, CheckedState)
PRAGMA_ENABLE_DEPRECATION_WARNINGS
};
 
UCLASS(Transient, MinimalAPI)
class UWidgetCheckedStateRegistration : public UWidgetEnumStateRegistration
{
    GENERATED_BODY()
 
public:
 
    static UMG_API FWidgetStateBitfield Unchecked;
    static UMG_API FWidgetStateBitfield Checked;
    static UMG_API FWidgetStateBitfield Undetermined;
 
    static const inline FName StateName = FName("CheckedState");
 
    //~ Begin UWidgetEnumStateRegistration Interface.
    UMG_API virtual FName GetStateName() const override;
    UMG_API virtual uint8 GetRegisteredWidgetState(const UWidget* InWidget) const override;
    //~ End UWidgetEnumStateRegistration Interface
 
    static UMG_API const FWidgetStateBitfield& GetBitfieldFromValue(uint8 InValue);
 
protected:
    friend UWidgetStateSettings;
 
    //~ Begin UWidgetEnumStateRegistration Interface.
    UMG_API virtual void InitializeStaticBitfields() const override;
    //~ End UWidgetEnumStateRegistration Interface
};