1. Epic GamesDeveloper
  3. UToolMenu

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

Variables

  Type Name Description
Public variable bool bCloseSelfOnly  
Public variable bool bPreventCustomization Prevent menu from being customized
Public variable bool bSearchable  
Public variable bool bShouldCleanupContextOnDestroy  
Public variable bool bShouldCloseWindowAfterMenuSelection  
Public variable bool bToolBarForceSmallIcons  
Public variable bool bToolBarIsFocusable  
Public variable FToolMenuContext Context  
Public variable FName MenuName  
Public variable FToolMenuOwner MenuOwner  
Public variable FName MenuParent  
Public variable EMultiBoxType MenuType  
Public variable FMultiBox::FOnModifyBlockWidgetAfterMake ModifyBlockWidgetAfterMake  
Public variable TArray< FToolMenuSection > Sections  
Public variable FName StyleName  
Public variable TObjectPtr< const UToolMenu > SubMenuParent  
Public variable FName SubMenuSourceEntryName  
Public variable FName TutorialHighlightName  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function FToolMenuSection &

AddDynamicSection ( const FName SectionName,
const FNewSectionConstructChoice& InConstruct,
const FToolMenuInsert InPosition
)

 Callback is passed sandboxed empty menu to add as many sections as desired.
Public function void

AddDynamicSectionScript ( const FName SectionName,
UToolMenuSectionDynamic* Object
)

  
Public function void

AddMenuEntry ( const FName SectionName,
const FToolMenuEntry& Args
)

  
Public function void  
Public function FToolMenuSection &

AddSection ( const FName SectionName,
const TAttribute< FText >& InLabel,
const FToolMenuInsert InPosition
)

  
Public function void

AddSectionScript ( const FName SectionName,
const FText& Label,
const FName InsertName,
const EToolMenuInsertType InsertType
)

  
Public function UToolMenu *

AddSubMenu ( const FToolMenuOwner Owner,
const FName SectionName,
const FName Name,
const FText& Label,
const FText& ToolTip
)

  
Public function UToolMenu *

AddSubMenuScript ( const FName Owner,
const FName SectionName,
const FName Name,
const FText& Label,
const FText& ToolTip
)

  
Public function Const TContextType *  
Public function FToolMenuSection &

FindOrAddSection ( const FName SectionName
)

  
Public function FToolMenuSection *

FindSection ( const FName SectionName
)

  
Public function Const TArray< FName >

GetMenuHierarchyNames ( bool bIncludeSubMenuRoot
)

  
Public function Const FName  
Public function Const TArray< const UToolMenu * > Returns array [Menu, Menu.SubMenuA, Menu.SubMenuB] for Menu.SubMenuB.SubMenuB
Public function Const FString Returns "SubMenuC.SubMenuD" for menu "ModuleA.MenuB.SubMenuC.SubMenuD"
Public function void

InitMenu ( const FToolMenuOwner Owner,
FName Name,
FName Parent,
EMultiBoxType Type
)

  
Public function Const bool  
Public function FReply

OnKeyDown ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

  
Public function void

RemoveSection ( const FName SectionName
)

  
Public function void

SetExtendersEnabled ( bool bEnabled
)

 Set support for extenders
Public function void

SetMaxHeight ( uint32 InMaxHeight
)

  

Overridden from UToolMenuBase

  Type Name Description
Public function Virtual Const FCustomizedToolMenu *  
Public function Virtual Const bool

ContainsEntry ( const FName InName
)

  
Public function Virtual Const bool

ContainsSection ( const FName InName
)

  
Public function Virtual Const FCustomizedToolMenu *  
Public function Virtual Const FCustomizedToolMenuHierarchy  
Public function Virtual Const FName

GetSectionName ( const FName InEntryName
)

  
Public function Virtual Const bool  
Public function Virtual void  
Public function Virtual void  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page