FSlateApplication::PushHostedMenu

Creates a new hosted Menu and adds it to the menu stack.

Windows
MacOS
Linux

References

Module

Slate

Header

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

Include

#include "Framework/Application/SlateApplication.h"

Source

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

Syntax

TSharedPtr< IMenu > PushHostedMenu
(
    const TSharedRef< SWidget > & InParentWidget,
    const FWidgetPath & InOwnerPath,
    const TSharedRef< IMenuHost > & InMenuHost,
    const TSharedRef< SWidget > & InContent,
    TSharedPtr< SWidget > & OutWrappedContent,
    const FPopupTransitionEffect & TransitionEffect,
    EShouldThrottle ShouldThrottle,
    const bool bIsCollapsedByParent
)

Remarks

Creates a new hosted Menu and adds it to the menu stack. Hosted menus are drawn by an external host widget.

Parameters

Parameter

Description

InParentMenu

The parent of the menu. Must be a valid menu in the stack.

InOwnerPath

Optional full widget path of the parent if one is available. If an invalid path is given PushMenu will attempt to generate a path to the InParentWidget

InMenuHost

The host widget that draws the menu's content

InContent

The content to be placed inside the new menu

OutWrappedContent

Returns the InContent wrapped with widgets needed by the menu stack system. This is what should be drawn by the host after this call.

TransitionEffect

Animation to use when the popup appears

ShouldThrottle

Should we throttle engine ticking to maximize the menu responsiveness

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.

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