SToolBarComboButtonBlock.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/Visibility.h"
#include "Widgets/SWidget.h"
#include "Textures/SlateIcon.h"
#include "Widgets/DeclarativeSyntaxSupport.h"
#include "Framework/MultiBox/MultiBox.h"
 
class SCheckBox;
class SComboButton;
 
class FToolBarComboButtonBlock
    : public FMultiBlock
{
 
public:
    FToolBarComboButtonBlock(
        const FUIAction& InAction,
        const FOnGetContent& InMenuContentGenerator,
        const TAttribute<FText>& InLabel = TAttribute<FText>(),
        const TAttribute<FText>& InToolTip = TAttribute<FText>(),
        const TAttribute<FSlateIcon>& InIcon = TAttribute<FSlateIcon>(),
        bool bInSimpleComboBox = false,
        TAttribute<FText> InToolbarLabelOverride = TAttribute<FText>(),
        TAttribute<EMenuPlacement> InPlacementOverride = MenuPlacement_ComboBox,
        const EUserInterfaceActionType InUserInterfaceActionType = EUserInterfaceActionType::Button
    );
 
    virtual void CreateMenuEntry(class FMenuBuilder& MenuBuilder) const override;
    virtual bool HasIcon() const override;
 
    void SetLabelVisibility( EVisibility InLabelVisibility ) { LabelVisibility = InLabelVisibility; }
 
    void SetForceSmallIcons( const bool InForceSmallIcons ) { bForceSmallIcons = InForceSmallIcons; }
 
    bool IsSimpleComboBox() const { return bSimpleComboBox; }
private:
 
    virtual TSharedRef< class IMultiBlockBaseWidget > ConstructWidget() const override;
 
 
private:
 
    // Friend our corresponding widget class
    friend class SToolBarComboButtonBlock;
 
    FOnGetContent MenuContentGenerator;
 
    TAttribute<FText> Label;
 
    TAttribute<FText> ToolbarLabelOverride;
 
    TAttribute<FText> ToolTip;
 
    TAttribute<FSlateIcon> Icon;
 
    TAttribute<EMenuPlacement> PlacementOverride;
 
    TOptional< EVisibility > LabelVisibility;
 
    EUserInterfaceActionType UserInterfaceActionType;
 
    bool bSimpleComboBox;
 
    bool bForceSmallIcons;
};
 
 
 
class SToolBarComboButtonBlock
    : public SMultiBlockBaseWidget
{
 
public:
 
    SLATE_BEGIN_ARGS( SToolBarComboButtonBlock )
        : _ForceSmallIcons( false )
    {}
 
        SLATE_ARGUMENT( TOptional< EVisibility >, LabelVisibility )
        
        
        SLATE_ATTRIBUTE( FSlateIcon, Icon );
 
        SLATE_ARGUMENT( bool, ForceSmallIcons )
 
    SLATE_END_ARGS()
 
 
    SLATE_API virtual void BuildMultiBlockWidget(const ISlateStyle* StyleSet, const FName& StyleName) override;
 
 
    SLATE_API void Construct( const FArguments& InArgs );
 
protected:
 
    SLATE_API TSharedRef<SWidget> OnGetMenuContent();
 
    SLATE_API FReply OnClicked();
 
    SLATE_API void OnCheckStateChanged(const ECheckBoxState NewCheckedState);
 
    SLATE_API ECheckBoxState GetCheckState() const;
 
    SLATE_API bool IsEnabled() const;
 
    bool HasAction() const;
    
    bool HasCheckedState() const;
 
    const FCheckBoxStyle* GetCheckBoxStyle(const ISlateStyle* StyleSet, const FName& StyleName, bool bIsSplitButton) const;
    
    SLATE_API EVisibility GetVisibility() const;
private:
    bool HasDynamicIcon() const;
 
    const FSlateBrush* GetIconBrush() const;
 
    const FSlateBrush* GetNormalIconBrush() const;
 
    const FSlateBrush* GetSmallIconBrush() const;
 
    EVisibility GetIconVisibility(bool bIsASmallIcon) const;
 
    FSlateColor GetIconForegroundColor() const;
 
    const FSlateBrush* GetOverlayIconBrush() const;
 
    FSlateColor OnGetForegroundColor() const;
 
    const FSlateBrush* GetBorderImage() const;
 
private:
    TOptional<EVisibility> LabelVisibilityOverride;
 
    TAttribute<FSlateIcon> Icon;
    
    bool bForceSmallIcons;
 
    TSharedPtr<SWidget> LeftHandSideWidget; // Widget that comes before the combo button
    TSharedPtr<SComboButton> ComboButtonWidget;
 
    FSlateColor OpenForegroundColor;
 
    const FCheckBoxStyle* CheckBoxStyle = nullptr;
 
    const FSlateBrush* BlockHovered = nullptr;
};