1. Epic GamesDeveloper
  3. FMenuStack

FMenuStack

Represents a stack of open menus.

API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Framework > API/Runtime/Slate/Framework/Application

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

  Type Name Description
Public function   Constructor

Functions

  Type Name Description
Public function void Dismisses the entire menu stack
Public function void

DismissFrom ( const TSharedPtr< IMenu >& InFromMenu
)

 Dismisses the menu stack including InFromMenu and all its child menus Dismisses in reverse order (children first)
Public function Const TSharedPtr< IMenu > Finds a menu in the stack that owns InWindow.
Public function Const TSharedPtr< IMenu >

FindMenuInWidgetPath ( const FWidgetPath& PathToQuery
)

 Searches from bottom to top of the widget path for a menu in the stack.
Public function Const TSharedPtr< SWidget >  
Public function Const TSharedPtr< SWindow >  
Public function Const bool

GetToolTipForceFieldRect ( const TSharedRef< IMenu >& InMenu,
const FWidgetPath& InPathContainingMenu,
FSlateRect& OutSlateRect
)

 Called by the application when showing tooltips.
Public function Const bool  
Public function Const bool  
Public function void

OnWindowActivated ( TSharedRef< SWindow > ActivatedWindow
)

 Notifies the stack that a new window was activated.
Public function void Called by the application when any window is destroyed.
Public function TSharedRef< IMenu >

Push ( const TSharedPtr< IMenu >& InParentMenu,
const TSharedRef< SWidget >& InContent,
const UE::Slate::FDeprecateVector2DParameter& SummonLocation,
const FPopupTransitionEffect& TransitionEffect,
const bool bFocusImmediately,
const UE::Slate::FDeprecateVector2DParameter& SummonLocationSize,
const bool bIsCollapsedByParent,
const bool bEnablePerPixelTransparency
)

 Pushes a new child menu onto the stack.
Public function TSharedRef< IMenu >

Push ( const FWidgetPath& InOwnerPath,
const TSharedRef< SWidget >& InContent,
const UE::Slate::FDeprecateVector2DParameter& SummonLocation,
const FPopupTransitionEffect& TransitionEffect,
const bool bFocusImmediately,
const UE::Slate::FDeprecateVector2DParameter& SummonLocationSize,
TOptional< EPopupMethod > InMethod,
const bool bIsCollapsedByParent,
const bool bEnablePerPixelTransparency
)

 Pushes a new menu onto the stack.
Public function 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
)

 Pushes a new menu onto the stack that is drawn by an external host widget.
Public function 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
)

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page