FMenuStack::Push

Pushes a new menu onto the stack.

Windows
MacOS
Linux

References

Module

Slate

Header

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

Include

#include "Framework/Application/MenuStack.h"

Source

/Engine/Source/Runtime/Slate/Private/Framework/Application/MenuStack.cpp

Syntax

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

Remarks

Pushes a new menu onto the stack. The widget path will be searched for existing menus and the new menu will be parented appropriately. Menus are always auto-sized. Use fixed-size content if a fixed size is required.

Parameters

Parameter

Description

InOwnerPath

The widget path for the parent widget of this menu.

InContent

The menu's content

SummonLocation

Location in screen-space where the menu should appear

TransitionEffect

Animation to use when the popup appears

bFocusImmediately

Should the popup steal focus when shown?

SummonLocationSize

An optional size around the summon location which describes an area in which the menu may not appear

InMethod

An optional popup method that will override the default method for the widgets in InOwnerPath

bIsCollapsedByParent

Is this menu collapsed when a parent menu receives focus/activation? If false, only focus/activation outside the entire stack will auto collapse it.

bEnablePerPixelTransparency

Does the menu's content require per pixel transparency?

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss