1. Epic GamesDeveloper
  3. UMenuAnchor

UMenuAnchor

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

API > API/Runtime > API/Runtime/UMG > API/Runtime/UMG/Components

Inheritance Hierarchy

References

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

Syntax

UCLASS (MinimalAPI)  
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

  Type Name Description
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite blueprintsetter, getter, setter bool bFitInWindow Should the menu anchor attempt to fit the menu inside the window.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly TSubclassOf< class UUserWidget > MenuClass The widget class to spawn when the menu is required.
Protected variable TSharedPtr< SMenuAnchor > MyMenuAnchor  
Public variable UProperty Category, EditAnywhere, Meta FGetWidget OnGetMenuContentEvent Deprecated.
Public variable UProperty Category, EditAnywhere FGetUserWidget OnGetUserMenuContentEvent Called when the menu content is requested to allow a more customized handling over what to display
Public variable UProperty Category BlueprintAssignable FOnMenuOpenChangedEvent OnMenuOpenChanged Called when the opened state of the menu changes
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter TEnumAsByte< EMenuPlacement > Placement The placement location of the summoned widget.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly getter bool ShouldDeferPaintingAfterWindowContent  
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadOnly getter bool UseApplicationMenuStack Does this menu behave like a normal stacked menu? Set it to false to control the menu's lifetime yourself.

Constructors

  Type Name Description
Public function  

UMenuAnchor ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category void

Close ()

 Closes the menu if it is currently open.
Public function UFunction BlueprintCallable, Category void

FitInWindow ( bool bFit
)

  
Public function Const UFunction BlueprintCallable, Category FVector2D Returns the current menu position
Public function Const EMenuPlacement  
Protected function TSharedRef< SWidget >  
Protected function void

HandleMenuOpenChanged ( bool bIsOpen
)

  
Public function Const UFunction BlueprintCallable, Category bool Returns whether this menu has open submenus
Protected function void

InitShouldDeferPaintingAfterWindowContent ( bool InShouldDeferPaintingAfterWindowContent
)

 Initialize ShouldDeferPaintingAfterWindowContent in the constructor before the SWidget is constructed.
Protected function void

InitUseApplicationMenuStack ( bool InUseApplicationMenuStack
)

 Initialize UseApplicationMenuStack in the constructor before the SWidget is constructed.
Public function Const bool  
Public function Const bool  
Public function Const UFunction BlueprintCallable, Category bool

IsOpen ()

 Returns true if the popup is open; false otherwise.
Public function Const bool  
Public function UFunction BlueprintCallable, Category void

Open ( bool bFocusMenu
)

 Opens the menu if it is not already open
Public function UFunction BlueprintCallable, Category void

SetPlacement ( EMenuPlacement InPlacement
)

  
Public function Const UFunction BlueprintCallable, Category bool Returns true if we should open the menu due to a click.
Public function UFunction BlueprintCallable, Category void

ToggleOpen ( bool bFocusOnOpen
)

 Toggles the menus open state.

Overridden from UPanelWidget

  Type Name Description
Protected function Virtual void UPanelWidget.
Protected function Virtual void  

Overridden from UWidget

  Type Name Description
Public function Virtual const FText Gets the palette category of the widget
Protected function Virtual TSharedRef< SWidget > Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.

Overridden from UVisual

  Type Name Description
Public function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  

Classes

  Type Name Description
Public class FGetUserWidget    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page