Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Slate > Widgets > Input > SMenuAnchor

Light Theme

Dark Theme

SMenuAnchor

A PopupAnchor summons a Popup relative to its content.

Windows

MacOS

Linux

Inheritance Hierarchy

SPanel

IMenuHost

SMenuAnchor

SComboButton

SComboBox

SEnumComboBox

SComponentClassCombo

SPopupErrorText

SSearchableComboBox

References

Module	Slate
Header	/Engine/Source/Runtime/Slate/Public/Widgets/Input/SMenuAnchor.h
Include	#include "Widgets/Input/SMenuAnchor.h"

Syntax

class SMenuAnchor :
public SPanel,
public IMenuHost

Remarks

A PopupAnchor summons a Popup relative to its content. Summoning a popup relative to the cursor is accomplished via the application.

Variables

	Name	Description
bool	bApplyWidgetStyleToMenu	Should we paint the popup using the received InWidgetStyle?
bool	bDismissedThisTick	Was the menu just dismissed this tick?
bool	bFitInWindow	Should the menu anchor fit inside the window?
bool	bIsCollapsedByParent	Whether this menu should be collapsed when its parent gets focus
bool	bShouldDeferPaintingAfterWindowContent	Should the menu content painting be deferred? If not, the menu content will layer over the menu anchor, rather than above all window contents.
bool	bUseApplicationMenuStack	Should the menu by created by the application stack code making it behave like and have the lifetime of a normal menu?
TPanelChildren<...	Children	The currently arranged children in the menu anchor.
FVector2D	LocalPopupPosition
TSharedPtr< SWi...	MenuContent	Static menu content to use when the delegate used when OnGetMenuContent is not defined.
TOptional< EPop...	Method	Should we summon a new window for this popup or
FPopupMethodRep...	MethodInUse	Method currently being used to show the popup. No value if popup is closed.
FOnGetContent	OnGetMenuContent	Callback invoked when the popup is being summoned
FOnIsOpenChange...	OnMenuOpenChanged	Callback invoked when the popup is being opened/closed
TSharedPtr< IMe...	OwnedMenuPtr	An interface pointer to the menu object presenting this popup.
TAttribute< EMe...	Placement	How should the popup be placed relative to the anchor.
TWeakPtr< IMenu...	PopupMenuPtr	An interface pointer to the menu object presenting this popup.
TWeakPtr< SWind...	PopupWindowPtr	A pointer to the window presenting this popup.
FVector2D	ScreenPopupPosition	Screen-space version of LocalPopupPosition, also cached in Tick.
TSharedPtr< SWi...	WrappedContent	MenuContent plus any extra wrapping widgets needed by the menu infrastructure.

Constructors

	Name	Description
	SMenuAnchor()

Destructors

	Name	Description
	~SMenuAnchor()

Functions

	Name	Description
FGeometry	ComputeNewWindowMenuPlacement ( const FGeometry& AllottedGeometry, const FVector2D& PopupDesiredSize, EMenuPlacement PlacementMode )	Computes the placement geometry for menus displayed in a separately created window
void	Construct ( const FArguments& InArgs )	Construct this widget
void	DismissAllApplicationMenus()
FVector2D	GetMenuPosition()
bool	HasOpenSubMenus()
bool	IsOpen()
bool	IsOpenAndReusingWindow()
bool	IsOpenViaCreatedWindow()
void	OnMenuClosed ( TSharedRef< IMenu > InMenu )	Handler/callback called by menus created by this anchor, when they are dismissed
void	ResetPopupMenuContent()	Reset the popup state to prepopup.
void	SetContent ( TSharedRef< SWidget > InContent )	See Content Slot attribute
void	SetFitInWindow ( bool bFit )
void	SetIsOpen ( bool InIsOpen, const bool bFocusMenu, const int32 FocusUserIndex )	Open or close the popup
void	SetMenuContent ( TSharedRef< SWidget > InMenuContent )	See MenuContent attribute
void	SetMenuPlacement ( TAttribute< EMenuPlacement > InMenu... )
bool	ShouldOpenDueToClick()

Overridden from SWidget

	Name	Description
FVector2D	ComputeDesiredSize ( float )	A Panel's desired size in the space required to arrange of its children on the screen while respecting all of the children's desired sizes and any layout-related options specified by the user.
bool	ComputeVolatility()	Recomputes the volatility of the widget.
FChildren &#...	GetChildren()	All widgets must provide a way to access their children in a layout-agnostic way.
void	OnArrangeChildren ( const FGeometry& AllottedGeometry, FArrangedChildren& ArrangedChildre... )	Panels arrange their children in a space described by the AllottedGeometry parameter.
int32	OnPaint ( const FPaintArgs& Args, const FGeometry& AllottedGeometry, const FSlateRect& MyCullingRect, FSlateWindowElementList& OutDrawEl..., int32 LayerId, const FWidgetStyle& InWidgetStyle, bool bParentEnabled )	The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children.
void	Tick ( const FGeometry& AllottedGeometry, const double InCurrentTime, const float InDeltaTime )	Ticks this widget with Geometry.

Overridden from IMenuHost

		Name	Description
	TSharedPtr< ...	GetMenuWindow()
	void	OnMenuDismissed()
	bool	UsingApplicationMenuStack()

Classes

	Name	Description
	FArguments
	FPopupPlacement

Constants

Name	Description
OpenApplicationMenus

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

Take our survey

Dismiss