MenuStack.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Input/PopupMethodReply.h"
#include "Framework/Application/IMenu.h"
#include "Layout/SlateRect.h"
#include "Widgets/SWidget.h"
#include "Types/SlateStructs.h"
#include "Widgets/SWindow.h"
#include "Application/ThrottleManager.h"
#include "Delegates/DelegateCombinations.h"
 
class FWidgetPath;
class SMenuPanel;
class FMenuBase;
 
typedef TArray<TSharedPtr<SWindow>> FMenuWindowList;    // deprecated
 
#if UE_BUILD_DEBUG
    // Debugging is harder with the inline allocator
    typedef TArray<TSharedPtr<IMenu>> FMenuList;
#else
    typedef TArray<TSharedPtr<IMenu>, TInlineAllocator<4>> FMenuList;
#endif
 
 
struct FPopupTransitionEffect
{
    enum ESlideDirection
    {
        None,
 
        ComboButton,
 
        TopMenu,
 
        SubMenu,
 
        TypeInPopup,
 
        ContextMenu,
 
    } SlideDirection;
 
 
    FPopupTransitionEffect( const ESlideDirection InitSlideDirection )
        : SlideDirection(InitSlideDirection)
    { }
};
 
DECLARE_MULTICAST_DELEGATE_OneParam(FOnMenuDestroyed, const TSharedRef<IMenu>& InMenu);
 
#if WITH_SLATE_DEBUGGING
extern FAutoConsoleVariable CVarSlateDismissMenuStacksOnFocusLost;
#endif
 
class FMenuStack
{
public:
    FMenuStack()
        : bHostWindowGuard(false)
    {}
 
    TSharedRef<IMenu> Push(const FWidgetPath& InOwnerPath, const TSharedRef<SWidget>& InContent, const UE::Slate::FDeprecateVector2DParameter& SummonLocation, const FPopupTransitionEffect& TransitionEffect, const bool bFocusImmediately = true, const UE::Slate::FDeprecateVector2DParameter& SummonLocationSize = FVector2f::ZeroVector, TOptional<EPopupMethod> InMethod = TOptional<EPopupMethod>(), const bool bIsCollapsedByParent = true, const bool bEnablePerPixelTransparency = false, const int32 FocusUserIndex = INDEX_NONE);
    
    TSharedRef<IMenu> Push(const TSharedPtr<IMenu>& InParentMenu, const TSharedRef<SWidget>& InContent, const UE::Slate::FDeprecateVector2DParameter& SummonLocation, const FPopupTransitionEffect& TransitionEffect, const bool bFocusImmediately = true, const UE::Slate::FDeprecateVector2DParameter& SummonLocationSize = FVector2f::ZeroVector, const bool bIsCollapsedByParent = true, const bool bEnablePerPixelTransparency = false, const int32 FocusUserIndex = INDEX_NONE);
 
    TSharedRef<IMenu> PushHosted(const FWidgetPath& InOwnerPath, const TSharedRef<IMenuHost>& InMenuHost, const TSharedRef<SWidget>& InContent, TSharedPtr<SWidget>& OutWrappedContent, const FPopupTransitionEffect& TransitionEffect, EShouldThrottle ShouldThrottle, const bool bIsCollapsedByParent = true);
    
    TSharedRef<IMenu> PushHosted(const TSharedPtr<IMenu>& InParentMenu, const TSharedRef<IMenuHost>& InMenuHost, const TSharedRef<SWidget>& InContent, TSharedPtr<SWidget>& OutWrappedContent, const FPopupTransitionEffect& TransitionEffect, EShouldThrottle ShouldThrottle, const bool bIsCollapsedByParent = true);
    
    void DismissFrom(const TSharedPtr<IMenu>& InFromMenu);
 
    void DismissAll();
 
    void OnWindowDestroyed(TSharedRef<SWindow> InWindow);
 
    void OnWindowActivated( TSharedRef<SWindow> ActivatedWindow );
 
    TSharedPtr<IMenu> FindMenuFromWindow(TSharedRef<SWindow> InWindow) const;
 
    TSharedPtr<IMenu> FindMenuInWidgetPath(const FWidgetPath& PathToQuery) const;
 
    bool GetToolTipForceFieldRect(const TSharedRef<IMenu>& InMenu, const FWidgetPath& InPathContainingMenu, FSlateRect& OutSlateRect) const;
 
    TSharedPtr<SWindow> GetHostWindow() const;
 
    TSharedPtr<SWidget> GetHostWidget() const;
 
    bool HasMenus() const;
 
    bool HasOpenSubMenus(TSharedPtr<IMenu> InMenu) const;
 
    FOnMenuDestroyed& OnMenuDestroyedEvent() { return MenuDestroyedEvent; }
 
private:
    FPopupMethodReply QueryPopupMethod(const FWidgetPath& PathToQuery);
 
    void DismissInternal(int32 FirstStackIndexToRemove);
 
    void SetHostPath(const FWidgetPath& InOwnerPath);
 
    void OnMenuDestroyed(TSharedRef<IMenu> InMenu);
 
    void OnMenuContentLostFocus(const FWidgetPath& InFocussedPath);
 
    TSharedRef<SWidget> WrapContent(TSharedRef<SWidget> InContent, FOptionalSize OptionalMinWidth = FOptionalSize(), FOptionalSize OptionalMinHeight = FOptionalSize(), bool bShouldShowBackground = true);
 
    struct FPrePushArgs
    {
        FPrePushArgs() : TransitionEffect(FPopupTransitionEffect::None) {}
 
        TSharedPtr<SWidget> Content;
        FSlateRect Anchor;
        FPopupTransitionEffect TransitionEffect;
        int32 FocusUserIndex = INDEX_NONE;
        bool bFocusImmediately;
        bool bIsCollapsedByParent;
    };
 
    struct FPrePushResults
    {
        TSharedPtr<SWidget> WrappedContent;
        TSharedPtr<SWidget> WidgetToFocus;
        FVector2f AnimStartLocation;
        FVector2f AnimFinalLocation;
        bool bAnchorSetsMinWidth;
        FVector2f ExpectedSize;
        bool bAllowAnimations;
        bool bFocusImmediately;
        bool bIsCollapsedByParent;
    };
 
    FPrePushResults PrePush(const FPrePushArgs& InArgs);
 
    TSharedRef<IMenu> PushInternal(const TSharedPtr<IMenu>& InParentMenu, const TSharedRef<SWidget>& InContent, FSlateRect Anchor, const FPopupTransitionEffect& TransitionEffect, const bool bFocusImmediately, EShouldThrottle ShouldThrottle, const bool bIsCollapsedByParent, const bool bEnablePerPixelTransparency, const int32 FocusUserIndex = INDEX_NONE);
 
    TSharedRef<FMenuBase> PushNewWindow(TSharedPtr<IMenu> InParentMenu, const FPrePushResults& InPrePushResults, const bool bEnablePerPixelTransparency, const int32 FocusUserIndex = INDEX_NONE);
 
    TSharedRef<FMenuBase> PushPopup(TSharedPtr<IMenu> InParentMenu, const FPrePushResults& InPrePushResults, const int32 FocusUserIndex = INDEX_NONE);
 
    void PostPush(TSharedPtr<IMenu> InParentMenu, TSharedRef<FMenuBase> InMenu, EShouldThrottle ShouldThrottle, bool bInInsertAfterDismiss=false);
 
    FPopupMethodReply ActiveMethod;
 
    TSharedPtr<SWindow> HostWindow;
 
    TWeakPtr<SWidget> HostWidget;
 
    TSharedPtr<SMenuPanel> HostWindowPopupPanel;
 
    TSharedPtr<FPopupLayer> HostPopupLayer;
 
    TArray<TSharedPtr<class FMenuBase>> Stack;
 
    TMap<TSharedPtr<const SWidget>, TSharedPtr<class FMenuBase>> CachedContentMap;
    
    FThrottleRequest ThrottleHandle;
 
    TSharedPtr<SWindow> PendingNewWindow;
 
    TSharedPtr<class FMenuBase> PendingNewMenu;
 
    bool bHostWindowGuard;
 
    FOnMenuDestroyed MenuDestroyedEvent;
};