SCheckBox.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Misc/Attribute.h"
#include "Layout/Margin.h"
#include "Sound/SlateSound.h"
#include "Styling/SlateColor.h"
#include "Input/Reply.h"
#include "Styling/SlateWidgetStyleAsset.h"
#include "Widgets/DeclarativeSyntaxSupport.h"
#include "Widgets/SWidget.h"
#include "Widgets/SCompoundWidget.h"
#include "Styling/SlateTypes.h"
#include "Styling/CoreStyle.h"
#include "Framework/SlateDelegates.h"
 
class SBorder;
 
 
DECLARE_DELEGATE_OneParam( FOnCheckStateChanged, ECheckBoxState );
 
 
class SCheckBox : public SCompoundWidget
{
public:
 
    SLATE_BEGIN_ARGS( SCheckBox )
        : _Content()
        , _Style( &FCoreStyle::Get().GetWidgetStyle< FCheckBoxStyle >("Checkbox") )
        , _Type()
        , _OnCheckStateChanged()
        , _IsChecked( ECheckBoxState::Unchecked )
        , _HAlign( HAlign_Fill )
        , _CheckBoxImageVAlign( VAlign_Center )
        , _CheckBoxContentUsesAutoWidth(true)
        , _Padding()
        , _ClickMethod( EButtonClickMethod::DownAndUp )
        , _TouchMethod(EButtonTouchMethod::DownAndUp)
        , _PressMethod(EButtonPressMethod::DownAndUp)
        , _ForegroundColor(FSlateColor::UseStyle())
        , _BorderBackgroundColor ()
        , _IsFocusable( true )
        , _UncheckedImage( nullptr )
        , _UncheckedHoveredImage( nullptr )
        , _UncheckedPressedImage( nullptr )
        , _CheckedImage( nullptr )
        , _CheckedHoveredImage( nullptr )
        , _CheckedPressedImage( nullptr )
        , _UndeterminedImage( nullptr )
        , _UndeterminedHoveredImage( nullptr )
        , _UndeterminedPressedImage( nullptr )
        , _BackgroundImage( nullptr )
        , _BackgroundHoveredImage( nullptr )
        , _BackgroundPressedImage( nullptr )
    {
    }
 
        SLATE_DEFAULT_SLOT( FArguments, Content )
 
        
        SLATE_STYLE_ARGUMENT( FCheckBoxStyle, Style )
 
        
        SLATE_ARGUMENT( TOptional<ESlateCheckBoxType::Type>, Type )
 
        
        SLATE_EVENT( FOnCheckStateChanged, OnCheckStateChanged )
 
        
        SLATE_ATTRIBUTE( ECheckBoxState, IsChecked )
 
        
        SLATE_ARGUMENT( EHorizontalAlignment, HAlign )
 
        
        SLATE_ARGUMENT( EVerticalAlignment, CheckBoxImageVAlign )
 
        
        SLATE_ARGUMENT(bool, CheckBoxContentUsesAutoWidth)
 
        
        SLATE_ATTRIBUTE( FMargin, Padding )
 
        
        SLATE_ARGUMENT( EButtonClickMethod::Type, ClickMethod )
 
        
        SLATE_ARGUMENT(EButtonTouchMethod::Type, TouchMethod)
 
        
        SLATE_ARGUMENT(EButtonPressMethod::Type, PressMethod)
 
        
        SLATE_ATTRIBUTE( FSlateColor, ForegroundColor )
 
        
        SLATE_ATTRIBUTE( FSlateColor, BorderBackgroundColor )
 
        SLATE_ARGUMENT( bool, IsFocusable )
        
        SLATE_EVENT( FOnGetContent, OnGetMenuContent )
 
        
        SLATE_ARGUMENT( TOptional<FSlateSound>, CheckedSoundOverride )
 
        
        SLATE_ARGUMENT( TOptional<FSlateSound>, UncheckedSoundOverride )
 
        
        SLATE_ARGUMENT( TOptional<FSlateSound>, HoveredSoundOverride )
 
        
        SLATE_ARGUMENT(const FSlateBrush*, UncheckedImage)
 
        
        SLATE_ARGUMENT(const FSlateBrush*, UncheckedHoveredImage)
 
        
        SLATE_ARGUMENT(const FSlateBrush*, UncheckedPressedImage)
 
        
        SLATE_ARGUMENT(const FSlateBrush*, CheckedImage)
 
        
        SLATE_ARGUMENT(const FSlateBrush*, CheckedHoveredImage)
 
        
        SLATE_ARGUMENT(const FSlateBrush*, CheckedPressedImage)
 
        
        SLATE_ARGUMENT(const FSlateBrush*, UndeterminedImage)
 
        
        SLATE_ARGUMENT(const FSlateBrush*, UndeterminedHoveredImage)
 
        
        SLATE_ARGUMENT(const FSlateBrush*, UndeterminedPressedImage)
 
        
        SLATE_ARGUMENT(const FSlateBrush*, BackgroundImage)
 
        
        SLATE_ARGUMENT(const FSlateBrush*, BackgroundHoveredImage)
 
        
        SLATE_ARGUMENT(const FSlateBrush*, BackgroundPressedImage)
 
 
 
 
    SLATE_END_ARGS()
 
    SLATE_API SCheckBox();
    SLATE_API virtual ~SCheckBox();
 
    SLATE_API void Construct( const FArguments& InArgs );
 
    // SWidget interface
    SLATE_API virtual bool SupportsKeyboardFocus() const override;
    SLATE_API virtual FReply OnKeyDown(const FGeometry& MyGeometry, const FKeyEvent& InKeyEvent) override;
    SLATE_API virtual FReply OnKeyUp( const FGeometry& MyGeometry, const FKeyEvent& InKeyEvent ) override;
    SLATE_API virtual FReply OnMouseButtonDown( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent ) override;
    SLATE_API virtual FReply OnMouseButtonDoubleClick( const FGeometry& InMyGeometry, const FPointerEvent& InMouseEvent ) override;
    SLATE_API virtual FReply OnMouseButtonUp( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent ) override;
    SLATE_API virtual void OnMouseEnter( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent ) override;
    SLATE_API virtual void OnMouseLeave( const FPointerEvent& MouseEvent ) override;
    SLATE_API virtual bool IsInteractable() const override;
    SLATE_API virtual FSlateColor GetForegroundColor() const;
#if WITH_ACCESSIBILITY
    SLATE_API virtual TSharedRef<FSlateAccessibleWidget> CreateAccessibleWidget() override;
#endif
    // End of SWidget interface
 
    bool IsChecked() const
    {
        return ( IsCheckboxChecked.Get() == ECheckBoxState::Checked );
    }
 
    SLATE_API ECheckBoxState GetCheckedState() const;
 
    bool IsPressed() const
    {
        return bIsPressed;
    }
 
    SLATE_API void ToggleCheckedState();
 
    SLATE_API void SetIsChecked(TAttribute<ECheckBoxState> InIsChecked);
    
    SLATE_API void SetContent(const TSharedRef< SWidget >& InContent);
    
    SLATE_API void SetStyle(const FCheckBoxStyle* InStyle);
    
    SLATE_API void SetUncheckedImage(const FSlateBrush* Brush);
    SLATE_API void SetUncheckedHoveredImage(const FSlateBrush* Brush);
    SLATE_API void SetUncheckedPressedImage(const FSlateBrush* Brush);
    
    SLATE_API void SetCheckedImage(const FSlateBrush* Brush);
    SLATE_API void SetCheckedHoveredImage(const FSlateBrush* Brush);
    SLATE_API void SetCheckedPressedImage(const FSlateBrush* Brush);
    
    SLATE_API void SetUndeterminedImage(const FSlateBrush* Brush);
    SLATE_API void SetUndeterminedHoveredImage(const FSlateBrush* Brush);
    SLATE_API void SetUndeterminedPressedImage(const FSlateBrush* Brush);
 
    SLATE_API void SetClickMethod(EButtonClickMethod::Type InClickMethod);
    SLATE_API void SetTouchMethod(EButtonTouchMethod::Type InTouchMethod);
    SLATE_API void SetPressMethod(EButtonPressMethod::Type InPressMethod);
 
protected:
 
    SLATE_API void BuildCheckBox(TSharedRef<SWidget> InContent);
 
    SLATE_API FMargin OnGetPadding() const;
    SLATE_API FSlateColor OnGetBorderBackgroundColor() const;
    SLATE_API ESlateCheckBoxType::Type OnGetCheckBoxType() const;
 
    SLATE_API const FSlateBrush* OnGetCheckImage() const;
    
    SLATE_API const FSlateBrush* GetUncheckedImage() const;
    SLATE_API const FSlateBrush* GetUncheckedHoveredImage() const;
    SLATE_API const FSlateBrush* GetUncheckedPressedImage() const;
    
    SLATE_API const FSlateBrush* GetCheckedImage() const;
    SLATE_API const FSlateBrush* GetCheckedHoveredImage() const;
    SLATE_API const FSlateBrush* GetCheckedPressedImage() const;
    
    SLATE_API const FSlateBrush* GetUndeterminedImage() const;
    SLATE_API const FSlateBrush* GetUndeterminedHoveredImage() const;
    SLATE_API const FSlateBrush* GetUndeterminedPressedImage() const;
 
    SLATE_API const FSlateBrush* OnGetBackgroundImage() const;
 
    SLATE_API const FSlateBrush* GetBackgroundImage() const;
    SLATE_API const FSlateBrush* GetBackgroundHoveredImage() const;
    SLATE_API const FSlateBrush* GetBackgroundPressedImage() const;
 
    
protected:
    
    const FCheckBoxStyle* Style;
 
    bool bIsPressed;
 
    TAttribute<ECheckBoxState> IsCheckboxChecked;
 
    FOnCheckStateChanged OnCheckStateChanged;
 
    const FSlateBrush* UncheckedImage;
    const FSlateBrush* UncheckedHoveredImage;
    const FSlateBrush* UncheckedPressedImage;
    const FSlateBrush* CheckedImage;
    const FSlateBrush* CheckedHoveredImage;
    const FSlateBrush* CheckedPressedImage;
    const FSlateBrush* UndeterminedImage;
    const FSlateBrush* UndeterminedHoveredImage;
    const FSlateBrush* UndeterminedPressedImage;
    const FSlateBrush* BackgroundImage;
    const FSlateBrush* BackgroundHoveredImage;
    const FSlateBrush* BackgroundPressedImage;
 
    TAttribute<FMargin> PaddingOverride;
    TAttribute<FSlateColor> ForegroundColorOverride;
    TAttribute<FSlateColor> BorderBackgroundColorOverride;
    TOptional<ESlateCheckBoxType::Type> CheckBoxTypeOverride;
 
    EHorizontalAlignment HorizontalAlignment;
 
    EVerticalAlignment CheckBoxImageVAlign;
 
    bool bCheckBoxContentUsesAutoWidth;
 
    EButtonClickMethod::Type ClickMethod;
 
    TEnumAsByte<EButtonTouchMethod::Type> TouchMethod;
 
    TEnumAsByte<EButtonPressMethod::Type> PressMethod;
 
    bool bIsFocusable;
 
    FOnGetContent OnGetMenuContent;
 
    SLATE_API void PlayCheckedSound() const;
 
    SLATE_API void PlayUncheckedSound() const;
 
    SLATE_API void PlayHoverSound() const;
 
    SLATE_API TEnumAsByte<EButtonClickMethod::Type> GetClickMethodFromInputType(const FPointerEvent& MouseEvent) const;
 
    SLATE_API bool IsPreciseTapOrClick(const FPointerEvent& MouseEvent) const;
 
    FSlateSound HoveredSound;
 
    FSlateSound CheckedSound;
 
    FSlateSound UncheckedSound;
 
protected:
    TSharedPtr<SBorder> ContentContainer;
};