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

Light Theme

Dark Theme

UMenuAnchor

The Menu Anchor allows you to specify an location that a popup menu should be anchored to, and should be summoned from.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UVisual

UWidget

UPanelWidget

UContentWidget

UMenuAnchor

References

Module	UMG
Header	/Engine/Source/Runtime/UMG/Public/Components/MenuAnchor.h
Include	#include "Components/MenuAnchor.h"

Syntax

class UMenuAnchor : public UContentWidget

Remarks

The Menu Anchor allows you to specify an location that a popup menu should be anchored to, and should be summoned from. Single Child Popup

Variables

	Name	Description
bool	bFitInWindow	Should the menu anchor attempt to fit the menu inside the window.
TSubclassOf< cl...	MenuClass	The widget class to spawn when the menu is required.
TSharedPtr< SMe...	MyMenuAnchor
FGetUserWidget	OnGetUserMenuContentEvent	Called when the menu content is requested to allow a more customized handling over what to display
FOnMenuOpenChan...	OnMenuOpenChanged	Called when the opened state of the menu changes
TEnumAsByte< EM...	Placement	The placement location of the summoned widget.
bool	ShouldDeferPaintingAfterWindowContent
bool	UseApplicationMenuStack	Does this menu behave like a normal stacked menu? Set it to false to control the menu's lifetime yourself.

Constructors

	Name	Description
	UMenuAnchor ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	Close()	Closes the menu if it is currently open.
void	FitInWindow ( bool bFit )
FVector2D	GetMenuPosition()	Returns the current menu position
TSharedRef< ...	HandleGetMenuContent()
void	HandleMenuOpenChanged ( bool bIsOpen )
bool	HasOpenSubMenus()	Returns whether this menu has open submenus
bool	IsOpen()	Returns true if the popup is open; false otherwise.
void	Open ( bool bFocusMenu )	Opens the menu if it is not already open
void	SetPlacement ( TEnumAsByte< EMenuPlacement > InPla... )
bool	ShouldOpenDueToClick()	Returns true if we should open the menu due to a click.
void	ToggleOpen ( bool bFocusOnOpen )	Toggles the menus open state.

Overridden from UPanelWidget

		Name	Description
	void	OnSlotAdded ( UPanelSlot* Slot )	UPanelWidget.
	void	OnSlotRemoved ( UPanelSlot* Slot )

Overridden from UWidget

		Name	Description
	const FText	GetPaletteCategory()	Gets the palette category of the widget
	TSharedRef< ...	RebuildWidget()	Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.

Overridden from UVisual

		Name	Description
	void	ReleaseSlateResources ( bool bReleaseChildren )

Classes

	Name	Description
	FGetUserWidget

Deprecated Variables

		Name	Description
	FGetWidget	OnGetMenuContentEvent	Use OnGetUserMenuContentEvent instead, you may need to make the previous binding return an User Widget.