SMenuEntryBlock.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 "Styling/SlateColor.h"
#include "Widgets/SWidget.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 FActiveTimerHandle;
 
class FMenuEntryBlock
    : public FMultiBlock
{
 
public:
 
    FMenuEntryBlock( const FName& InExtensionHook, const TSharedPtr< const FUICommandInfo > InCommand, TSharedPtr< const FUICommandList > InCommandList, const TAttribute<FText>& InLabelOverride = TAttribute<FText>(), const TAttribute<FText>& InToolTipOverride = TAttribute<FText>(), const FSlateIcon& InIconOverride = FSlateIcon(), bool bInCloseSelfOnly = false, bool bInShouldCloseWindowAfterMenuSelection = true);
 
 
    FMenuEntryBlock( const FName& InExtensionHook, const TAttribute<FText>& InLabel, const TAttribute<FText>& InToolTip, const FNewMenuDelegate& InEntryBuilder, TSharedPtr<FExtender> InExtender, bool bInSubMenu, bool bInSubMenuOnClick, TSharedPtr< const FUICommandList > InCommandList, bool bInCloseSelfOnly, const FSlateIcon& InIcon = FSlateIcon(), bool bInShouldCloseWindowAfterMenuSelection = true);
    
 
    FMenuEntryBlock( const FName& InExtensionHook, const TAttribute<FText>& InLabel, const TAttribute<FText>& InToolTip, const FOnGetContent& InMenuBuilder, TSharedPtr<FExtender> InExtender, bool bInSubMenu, bool bInSubMenuOnClick, TSharedPtr< const FUICommandList > InCommandList, bool bInCloseSelfOnly, const FSlateIcon& InIcon = FSlateIcon(), bool bInShouldCloseWindowAfterMenuSelection = true);
 
    FMenuEntryBlock( const FName& InExtensionHook, const TAttribute<FText>& InLabel, const TAttribute<FText>& InToolTip, const TSharedPtr<SWidget>& InEntryWidget, TSharedPtr<FExtender> InExtender, bool bInSubMenu, bool bInSubMenuOnClick, TSharedPtr< const FUICommandList > InCommandList, bool bInCloseSelfOnly, const FSlateIcon& InIcon = FSlateIcon(), bool bInShouldCloseWindowAfterMenuSelection = true);
 
 
    FMenuEntryBlock( const FName& InExtensionHook, const TAttribute<FText>& InLabel, const TAttribute<FText>& InToolTip, const FNewMenuDelegate& InEntryBuilder, TSharedPtr<FExtender> InExtender, bool bInSubMenu, bool bInSubMenuOnClick, const FSlateIcon& InIcon, const FUIAction& InUIAction, const EUserInterfaceActionType InUserInterfaceActionType, bool bInCloseSelfOnly, bool bInShouldCloseWindowAfterMenuSelection = true, TSharedPtr< const FUICommandList > InCommandList = nullptr, const TAttribute<FText>& InInputBindingOverride = TAttribute<FText>());
 
    FMenuEntryBlock( const FName& InExtensionHook, const TAttribute<FText>& InLabel, const TAttribute<FText>& InToolTip, const FSlateIcon& InIcon, const FUIAction& InUIAction, const EUserInterfaceActionType InUserInterfaceActionType, bool bInCloseSelfOnly, bool bInShouldCloseWindowAfterMenuSelection = true, const TAttribute<FText>& InInputBindingOverride = TAttribute<FText>());
 
    FMenuEntryBlock( const FName& InExtensionHook, const FUIAction& UIAction, const TSharedRef< SWidget > Contents, const TAttribute<FText>& InToolTip, const EUserInterfaceActionType InUserInterfaceActionType, bool bInCloseSelfOnly, bool bInShouldCloseWindowAfterMenuSelection = true);
 
    FMenuEntryBlock( const FName& InExtensionHook, const TSharedRef< SWidget > Contents, const FNewMenuDelegate& InEntryBuilder, TSharedPtr<FExtender> InExtender, bool bInSubMenu, bool bInSubMenuOnClick, TSharedPtr< const FUICommandList > InCommandList, bool bInCloseSelfOnly, bool bInShouldCloseWindowAfterMenuSelection = true);
 
    FMenuEntryBlock( const FName& InExtensionHook, const FUIAction& UIAction, const TSharedRef< SWidget > Contents, const FNewMenuDelegate& InEntryBuilder, TSharedPtr<FExtender> InExtender, bool bInSubMenu, TSharedPtr< const FUICommandList > InCommandList, bool bInCloseSelfOnly, bool bInShouldCloseWindowAfterMenuSelection = true);
 
    FMenuEntryBlock( const FName& InExtensionHook, const FUIAction& UIAction, const TAttribute<FText>& InLabel, const TAttribute<FText>& InToolTip, const FOnGetContent& InMenuBuilder, TSharedPtr<FExtender> InExtender, bool bInSubMenu, bool bInSubMenuOnClick, bool bInCloseSelfOnly, const FSlateIcon& InIcon = FSlateIcon(), bool bInShouldCloseWindowAfterMenuSelection = true);
 
    FMenuEntryBlock(const FMenuEntryParams& InMenuEntryParams);
 
    virtual void CreateMenuEntry(class FMenuBuilder& MenuBuilder) const override;
    virtual bool HasIcon() const override;
    
    void SetCheckBoxStyle(FName InCheckBoxStyle);
 
    bool IsSubMenu() const { return bIsSubMenu; }
 
    void SetRecursivelySearchable(bool bInRecursivelySearchable) { bIsRecursivelySearchable = bInRecursivelySearchable; }
 
    bool IsRecursivelySearchable() const { return bIsRecursivelySearchable; }
 
private:
 
    virtual TSharedRef< class IMultiBlockBaseWidget > ConstructWidget() const override;
 
private:
 
    // Friend our corresponding widget class
    friend class SMenuEntryBlock;
    friend class FSlateMacMenu;
 
    TAttribute<FText> LabelOverride;
 
    TAttribute<FText> ToolTipOverride;
 
    TAttribute<FText> InputBindingOverride;
 
    FSlateIcon IconOverride;
 
    FNewMenuDelegate EntryBuilder;
 
    FOnGetContent MenuBuilder;
 
    TSharedPtr<SWidget> EntryWidget;
 
    bool bIsSubMenu;
 
    bool bIsRecursivelySearchable;
 
    bool bOpenSubMenuOnClick;
 
    EUserInterfaceActionType UserInterfaceActionType;
 
    bool bCloseSelfOnly;
 
    TSharedPtr<FExtender> Extender;
 
    bool bShouldCloseWindowAfterMenuSelection;
 
    bool bInvertLabelOnHover;
 
    FName CheckBoxStyle = NAME_None;
};
 
 
 
 
class SMenuEntryBlock
    : public SMultiBlockBaseWidget
{
 
public:
 
    SLATE_BEGIN_ARGS( SMenuEntryBlock ){}
 
    SLATE_END_ARGS()
 
 
    
    SLATE_API virtual void BuildMultiBlockWidget(const ISlateStyle* StyleSet, const FName& StyleName) override;
 
    SLATE_API void Construct( const FArguments& InArgs );
 
    SLATE_API TSharedRef< SWidget > MakeNewMenuWidget() const;
 
 
protected:
    struct FMenuEntryBuildParams
    {
        TSharedPtr< const FMultiBox > MultiBox;
        TSharedPtr< const FMenuEntryBlock > MenuEntryBlock;
        TSharedPtr< const FUICommandInfo > UICommand;
        TAttribute<FText> Label;
        TAttribute<FText> ToolTip;
        TAttribute<FText> InputBinding;
        const ISlateStyle* StyleSet;
        FName StyleName;
    };
 
 
    SLATE_API FReply OnMenuItemButtonClicked();
 
    SLATE_API void OnClicked( bool bCheckBoxClicked );
 
    SLATE_API bool IsEnabled() const;
 
    SLATE_API bool IsEnabledDuringEditMode() const;
 
    SLATE_API void OnCheckStateChanged( const ECheckBoxState NewCheckedState );
 
    SLATE_API ECheckBoxState IsChecked() const;
 
    SLATE_API const FSlateBrush* OnGetCheckImage() const;
 
    // SWidget interface
    SLATE_API virtual void OnMouseEnter( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent ) override;
    SLATE_API virtual void OnMouseLeave( const FPointerEvent& MouseEvent ) override;
    SLATE_API virtual FReply OnKeyDown( const FGeometry& MyGeometry, const FKeyEvent& KeyEvent ) override;
    //virtual void Tick( const FGeometry& AllottedGeometry, const double InCurrentTime, const float InDeltaTime ) override;
    // End of SWidget interface
 
 
    SLATE_API const FSlateBrush* GetMenuBarButtonBorder() const;
    SLATE_API FSlateColor GetMenuBarForegroundColor() const;
 
    SLATE_API TSharedRef< SWidget > BuildMenuBarWidget( const FMenuEntryBuildParams& InBuildParams );
    
    SLATE_API TSharedRef<SWidget> FindTextBlockWidget(TSharedRef<SWidget> Content);
 
    SLATE_API TSharedRef< SWidget > BuildMenuEntryWidget( const FMenuEntryBuildParams& InBuildParams );
 
    SLATE_API TSharedRef< SWidget > BuildSubMenuWidget( const FMenuEntryBuildParams& InBuildParams );
 
    SLATE_API void RequestSubMenuToggle( bool bOpenMenu, const bool bClobber );
 
    SLATE_API void CancelPendingSubMenu();
 
    SLATE_API bool ShouldSubMenuAppearHovered() const;
    
    SLATE_API FText GetFilteredToolTipText( TAttribute<FText> ToolTipText ) const;
 
 
    // Gets the visibility of the menu item
    SLATE_API EVisibility GetVisibility() const;
 
    SLATE_API FSlateColor TintOnHover() const;
 
    SLATE_API FSlateColor InvertOnHover() const;
 
    //void UpdateSubMenuState();
 
private:
    const FSlateBrush* GetCheckBoxImageBrushFromStyle(const FCheckBoxStyle* Style) const;
 
    EActiveTimerReturnType UpdateSubMenuState(double InCurrentTime, float InDeltaTime, bool bWantsOpen);
 
    TWeakPtr<FActiveTimerHandle> ActiveTimerHandle;
 
    const FSlateBrush* CheckedImage;
    const FSlateBrush* UncheckedImage;
    TWeakPtr< SMenuAnchor > MenuAnchor;
    
    const FButtonStyle* MenuBarButtonStyle;
};