FMenuStack

Represents a stack of open menus.

Windows
MacOS
Linux

References

Module

Slate

Header

/Engine/Source/Runtime/Slate/Public/Framework/Application/MenuStack.h

Include

#include "Framework/Application/MenuStack.h"

Syntax

class FMenuStack

Remarks

Represents a stack of open menus. The last item in the stack is the top most menu Menus are described as IMenus. Implementations of IMenu can control how the menus are created and presented (e.g. in their own window)

Constructors

Name Description

Public function

FMenuStack()

Constructor

Functions

Name Description

Public function

void

 

DismissAll()

Dismisses the entire menu stack

Public function

void

 

DismissFrom

(
    const TSharedPtr< IMenu >& InFromM...
)

Dismisses the menu stack including InFromMenu and all its child menus Dismisses in reverse order (children first)

Public function Const

TSharedPtr< ...

 

FindMenuFromWindow

(
    TSharedRef< SWindow > InWindow
)

Finds a menu in the stack that owns InWindow.

Public function Const

TSharedPtr< ...

 

FindMenuInWidgetPath

(
    const FWidgetPath& PathToQuery
)

Searches from bottom to top of the widget path for a menu in the stack.

Public function Const

TSharedPtr< ...

 

GetHostWindow()

Public function Const

bool

 

GetToolTipForceFieldRect

(
    const TSharedRef< IMenu >& InMenu,
    const FWidgetPath& InPathContainin...,
    FSlateRect& OutSlateRect
)

Called by the application when showing tooltips.

Public function Const

bool

 

HasMenus()

Public function Const

bool

 

HasOpenSubMenus

(
    TSharedPtr< IMenu > InMenu
)

Public function

void

 

OnWindowActivated

(
    TSharedRef< SWindow > ActivatedWind...
)

Notifies the stack that a new window was activated.

Public function

void

 

OnWindowDestroyed

(
    TSharedRef< SWindow > InWindow
)

Called by the application when any window is destroyed.

Public function

TSharedRef< ...

 

Push

(
    const TSharedPtr< IMenu >& InParen...,
    const TSharedRef< SWidget >& InCon...,
    const FVector2D& SummonLocation,
    const FPopupTransitionEffect& Tran...,
    const bool bFocusImmediately,
    const FVector2D& SummonLocationSiz...,
    const bool bIsCollapsedByParent,
    const bool bEnablePerPixelTranspare...
)

Pushes a new child menu onto the stack.

Public function

TSharedRef< ...

 

Push

(
    const FWidgetPath& InOwnerPath,
    const TSharedRef< SWidget >& InCon...,
    const FVector2D& SummonLocation,
    const FPopupTransitionEffect& Tran...,
    const bool bFocusImmediately,
    const FVector2D& SummonLocationSiz...,
    TOptional< EPopupMethod > InMethod,
    const bool bIsCollapsedByParent,
    const bool bEnablePerPixelTranspare...
)

Pushes a new menu onto the stack.

Public function

TSharedRef< ...

 

PushHosted

(
    const FWidgetPath& InOwnerPath,
    const TSharedRef< IMenuHost >& InM...,
    const TSharedRef< SWidget >& InCon...,
    TSharedPtr< SWidget >& OutWrappedC...,
    const FPopupTransitionEffect& Tran...,
    EShouldThrottle ShouldThrottle,
    const bool bIsCollapsedByParent
)

Pushes a new menu onto the stack that is drawn by an external host widget.

Public function

TSharedRef< ...

 

PushHosted

(
    const TSharedPtr< IMenu >& InParen...,
    const TSharedRef< IMenuHost >& InM...,
    const TSharedRef< SWidget >& InCon...,
    TSharedPtr< SWidget >& OutWrappedC...,
    const FPopupTransitionEffect& Tran...,
    EShouldThrottle ShouldThrottle,
    const bool bIsCollapsedByParent
)

Pushes a new child menu onto the stack that is drawn by an external host widget.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss