SToolBarButtonBlock.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/DeclarativeSyntaxSupport.h"
#include "Input/Reply.h"
#include "Textures/SlateIcon.h"
#include "Framework/Commands/UICommandInfo.h"
#include "Framework/Commands/UICommandList.h"
#include "Framework/MultiBox/MultiBox.h"
#include "Framework/MultiBox/MultiBoxBuilder.h"
 
class SBorder;
 
DECLARE_DELEGATE_OneParam( FNewMenuDelegate, class FMenuBuilder& );
 
DECLARE_DELEGATE_RetVal_OneParam( TSharedRef<SWidget>, FGetDecoratedButtonDelegate, TSharedRef<SWidget> );
 
struct FButtonArgs : public TSharedFromThis<FButtonArgs>
{
    TSharedPtr< const FUICommandInfo > Command;
    TSharedPtr< const FUICommandList > CommandList;
    FName ExtensionHook;
    TAttribute<FText> LabelOverride;
    TAttribute<FText> ToolbarLabelOverride;
    TAttribute<FText> ToolTipOverride;
    TAttribute<FSlateIcon> IconOverride;
    FName TutorialHighlightName;
    FName BorderBrushName;
    EUserInterfaceActionType UserInterfaceActionType = EUserInterfaceActionType::None;
    FUIAction Action;
    
    FNewMenuDelegate CustomMenuDelegate;
    FOnGetContent OnGetMenuContent;
    FGetDecoratedButtonDelegate GetDecoratedButtonDelegate;
 
    explicit FButtonArgs() {}
};
 
 
class FToolBarButtonBlock
    : public FMultiBlock
{
 
public:
 
    
    SLATE_API FToolBarButtonBlock( FButtonArgs ButtonArgs );
 
    SLATE_API FToolBarButtonBlock(
        const TSharedPtr<const FUICommandInfo> InCommand,
        TSharedPtr<const FUICommandList> InCommandList,
        const TAttribute<FText>& InLabelOverride = TAttribute<FText>(),
        const TAttribute<FText>& InToolTipOverride = TAttribute<FText>(),
        const TAttribute<FSlateIcon>& InIconOverride = TAttribute<FSlateIcon>(),
        TAttribute<FText> InToolbarLabelOverride = TAttribute<FText>()
    );
 
    SLATE_API FToolBarButtonBlock(
        const TAttribute<FText>& InLabel,
        const TAttribute<FText>& InToolTip,
        const TAttribute<FSlateIcon>& InIcon,
        const FUIAction& InUIAction,
        const EUserInterfaceActionType InUserInterfaceActionType,
        TAttribute<FText> InToolbarLabelOverride = TAttribute<FText>()
    );
 
    void SetLabelVisibility( EVisibility InLabelVisibility ) { LabelVisibility = InLabelVisibility ; }
 
    void SetIsFocusable( bool bInIsFocusable ) { bIsFocusable = bInIsFocusable; }
 
    void SetForceSmallIcons( const bool InForceSmallIcons ) { bForceSmallIcons = InForceSmallIcons; }
 
    void SetBorderBrushName( const FName InBorderBrushName ) { BorderBrushName = InBorderBrushName; }
 
    SLATE_API virtual void CreateMenuEntry(class FMenuBuilder& MenuBuilder) const override;
    SLATE_API virtual bool HasIcon() const override;
 
    SLATE_API void SetCustomMenuDelegate(const FNewMenuDelegate& InOnFillMenuDelegate);
    
    SLATE_API void SetCustomWidget(const TSharedPtr<SWidget>& InCustomWidget);
 
    SLATE_API void SetOnGetMenuContent(const FOnGetContent& OnGetMenuContent);
 
    void SetGetDecoratedButtonDelegate( const FGetDecoratedButtonDelegate& InGetDecoratedButtonDelegate );
 
protected:
    
    SLATE_API bool GetIsFocusable() const;
 
private:
 
    SLATE_API virtual TSharedRef< class IMultiBlockBaseWidget > ConstructWidget() const override;
 
private:
 
    // Friend our corresponding widget class
    friend class SToolBarButtonBlock;
 
    TAttribute<FText> LabelOverride;
 
    TAttribute<FText> ToolbarLabelOverride;
 
    TAttribute<FText> ToolTipOverride;
    
    TAttribute<FName> BorderBrushName;
 
    TAttribute<FSlateIcon> IconOverride;
 
    TOptional< EVisibility > LabelVisibility;
    
    TSharedPtr<SWidget> CustomWidget;
    
    EUserInterfaceActionType UserInterfaceActionType;
 
    bool bIsFocusable;
 
    bool bForceSmallIcons;
 
    FNewMenuDelegate CustomMenuDelegate;
 
    FOnGetContent OnGetMenuContent;
 
    FGetDecoratedButtonDelegate GetDecoratedButtonDelegate;
};
 
 
 
class SToolBarButtonBlock
    : public SMultiBlockBaseWidget
{
 
public:
 
    SLATE_BEGIN_ARGS( SToolBarButtonBlock )
        : _IsFocusable(false)
        , _ForceSmallIcons(false)
        , _TutorialHighlightName(NAME_None)
        {}
 
        SLATE_ARGUMENT( TOptional<EVisibility>, LabelVisibility )
        SLATE_ARGUMENT( bool, IsFocusable )
        SLATE_ARGUMENT( bool, ForceSmallIcons )
        SLATE_ARGUMENT( FName, TutorialHighlightName )
    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 FReply OnClicked();
    
    SLATE_API void OnCheckStateChanged( const ECheckBoxState NewCheckedState );
 
    SLATE_API ECheckBoxState GetCheckState() const;
 
    SLATE_API bool IsEnabled() const;
 
    SLATE_API EVisibility GetBlockVisibility() const;
 
private:
    EVisibility GetIconVisibility(bool bIsASmallIcon) const;
 
    const FSlateBrush* GetIconBrush() const;
 
    const FSlateBrush* GetOverlayIconBrush() const;
 
    const FSlateBrush* GetNormalIconBrush() const;
    const FSlateBrush* GetSmallIconBrush() const;
 
    FSlateColor GetIconForegroundColor() const;
 
    const FSlateBrush* GetOptionsBlockLeftBrush() const;
 
    const FSlateBrush* GetOptionsBlockRightBrush() const;
 
    EVisibility GetOptionsSeparatorVisibility() const;
private:
    TOptional<EVisibility> LabelVisibilityOverride;
 
    TAttribute<EVisibility> LabelVisibility;
 
    TSharedPtr<SBorder> ButtonBorder;
    TSharedPtr<SBorder> OptionsBorder;
 
    bool bIsFocusable;
 
    bool bForceSmallIcons;
 
    FName TutorialHighlightName;
 
};