UToolMenu

Unreal Engine C++ API Reference > Developer > ToolMenus

Inheritance Hierarchy

References

   
Module ToolMenus
Header /Engine/Source/Developer/ToolMenus/Public/ToolMenu.h
Include #include "ToolMenu.h"

Syntax

class UToolMenu : public [UToolMenuBase](API\Runtime\Slate\Framework\MultiBox\UToolMenuBase)  

Variables

Type Name Description
bool bCloseSelfOnly  
bool bPreventCustomization Prevent menu from being customized
bool bSearchable  
bool bShouldCleanupContextOnDestroy  
bool bShouldCloseWindowAfterMenuSelection  
bool bToolBarForceSmallIcons  
bool bToolBarIsFocusable  
FToolMenuContex... Context  
FName MenuName  
FToolMenuOwner MenuOwner  
FName MenuParent  
EMultiBoxType MenuType  
FMultiBox::FOnM... ModifyBlockWidgetAfterMake  
TArray< FToolMe... Sections  
FName StyleName  
TObjectPtr< con... SubMenuParent  
FName SubMenuSourceEntryName  
FName TutorialHighlightName  

Constructors

Type Name Description
  UToolMenu ()  

Functions

Type Name Description
FToolMenuSec... AddDynamicSection ( const FName SectionName, const FNewSectionConstructChoice& ..., const FToolMenuInsert InPosition ) Callback is passed sandboxed empty menu to add as many sections as desired.
void AddDynamicSectionScript ( const FName SectionName, UToolMenuSectionDynamic* Objec... )  
void AddMenuEntry ( const FName SectionName, const FToolMenuEntry& Args )  
void AddMenuEntryObject ( UToolMenuEntryScript* InObject )  
FToolMenuSec... AddSection ( const FName SectionName, const TAttribute< FText >& InLabel, const FToolMenuInsert InPosition )  
void AddSectionScript ( const FName SectionName, const FText& Label, const FName InsertName, const EToolMenuInsertType InsertTyp... )  
UToolMenu &#... AddSubMenu ( const FToolMenuOwner Owner, const FName SectionName, const FName Name, const FText& Label, const FText& ToolTip )  
UToolMenu &#... AddSubMenuScript ( const FName Owner, const FName SectionName, const FName Name, const FText& Label, const FText& ToolTip )  
TContextType... FindContext ()  
FToolMenuSec... FindOrAddSection ( const FName SectionName )  
FToolMenuSec... FindSection ( const FName SectionName )  
TArray< FNam... GetMenuHierarchyNames ( bool bIncludeSubMenuRoot )  
FName GetMenuName ()  
TArray< cons... GetSubMenuChain () Returns array [Menu, Menu.SubMenuA, Menu.SubMenuB] for Menu.SubMenuB.SubMenuB
FString GetSubMenuNamePath () Returns "SubMenuC.SubMenuD" for menu "ModuleA.MenuB.SubMenuC.SubMenuD"
void InitMenu ( const FToolMenuOwner Owner, FName Name, FName Parent, EMultiBoxType Type )  
bool IsRegistered ()  
FReply OnKeyDown ( const FGeometry& MyGeometry, const FKeyEvent& InKeyEvent )  
void RemoveSection ( const FName SectionName )  
void SetExtendersEnabled ( bool bEnabled ) Set support for extenders
void SetMaxHeight ( uint32 InMaxHeight )  

Overridden from UToolMenuBase

Type Name Description
FCustomizedT... AddMenuCustomization ()  
bool ContainsEntry ( const FName InName )  
bool ContainsSection ( const FName InName )  
FCustomizedT... FindMenuCustomization ()  
FCustomizedT... GetMenuCustomizationHierarchy ()  
FName GetSectionName ( const FName InEntryName )  
bool IsEditing ()  
void OnMenuDestroyed ()  
void UpdateMenuCustomizationFromMultibox ( const TSharedRef< const FMultiBox >... )  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library