1. Epic GamesDeveloper
  3. UToolMenu

UToolMenu

Represents a menu in the ToolMenus system.

API > API/Developer > API/Developer/ToolMenus

Represents a menu in the ToolMenus system.

An instance of this class is returned by basic APIs such as UToolMenus::RegisterMenu and UToolMenus::ExtendMenu.

   
Name UToolMenu
Type class
Header File /Engine/Source/Developer/ToolMenus/Public/ToolMenu.h
Include Path #include "ToolMenu.h"

Syntax

UCLASS (MinimalAPI, BlueprintType)  
class UToolMenu : public UToolMenuBase

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UToolMenu()

   ToolMenu.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bAllowToolBarWrapButton TOptional< bool > Whether to (ever) allow the wrap button/overflow menu. Defauls to the style. ToolMenu.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="ToolBar"
bCloseSelfOnly bool   ToolMenu.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Tool Menus"
bPreventCustomization bool Prevent menu from being customized ToolMenu.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="ToolBar"
bSearchable bool   ToolMenu.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Tool Menus"
bSeparateSections bool Whether different sections should have separators automatically added between them. ToolMenu.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="ToolBar"
bShouldCleanupContextOnDestroy bool   ToolMenu.h
  • Transient
bShouldCloseWindowAfterMenuSelection bool   ToolMenu.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Tool Menus"
bToolBarForceSmallIcons bool   ToolMenu.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="ToolBar"
bToolBarIsFocusable bool   ToolMenu.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="ToolBar"
Context FToolMenuContext   ToolMenu.h  
MenuName FName   ToolMenu.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Tool Menus"
MenuOwner FToolMenuOwner   ToolMenu.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Tool Menus"
MenuParent FName   ToolMenu.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Tool Menus"
MenuType EMultiBoxType   ToolMenu.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Tool Menus"
ModifyBlockWidgetAfterMake FMultiBox::FOnModifyBlockWidgetAfterMake   ToolMenu.h  
Sections TArray< FToolMenuSection >   ToolMenu.h  
StyleName FName   ToolMenu.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Tool Menus"
SubMenuParent TObjectPtr< const UToolMenu >   ToolMenu.h  
SubMenuSourceEntryName FName   ToolMenu.h  
TutorialHighlightName FName   ToolMenu.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category="Tool Menus"

Protected

Name Type Remarks Include Path Unreal Specifiers
bExtendersEnabled bool   ToolMenu.h  
bIsRegistering bool   ToolMenu.h  
bRegistered bool   ToolMenu.h  
MaxHeight uint32   ToolMenu.h  
StyleSetName FName   ToolMenu.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

 Build a section in a callback. ToolMenu.h  

void AddDynamicSectionScript ( const FName SectionName,
UToolMenuSectionDynamic* Object
)

   ToolMenu.h
  • BlueprintCallable
  • Category="Tool Menus"
  • Meta=(ScriptName="AddDynamicSection", DisplayName="Add Dynamic Section")

virtual FCustomizedToolMenu * AddMenuCustomization()

   ToolMenu.h  

void AddMenuEntry ( const FName SectionName,
const FToolMenuEntry& Args
)

   ToolMenu.h
  • BlueprintCallable
  • Category="Tool Menus"

void AddMenuEntryObject ( UToolMenuEntryScript* InObject
)

   ToolMenu.h
  • BlueprintCallable
  • Category="Tool Menus"

virtual FToolMenuProfile * AddMenuProfile ( const FName& ProfileName
) const

   ToolMenu.h  

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

 Add a section to the menu. ToolMenu.h  

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

   ToolMenu.h
  • BlueprintCallable
  • Category="Tool Menus"
  • Meta=(ScriptName="AddSection", DisplayName="Add Section", AutoCreateRefTerm="Label", AdvancedDisplay="InsertName,InsertType")

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

   ToolMenu.h  

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

   ToolMenu.h
  • BlueprintCallable
  • Category="Tool Menus"
  • Meta=(ScriptName="AddSubMenu", AutoCreateRefTerm="Label,ToolTip")

virtual bool ContainsEntry ( const FName InName
) const

   ToolMenu.h  

virtual bool ContainsSection ( const FName InName
) const

   ToolMenu.h  

TContextType * FindContext()

   ToolMenu.h  

virtual FCustomizedToolMenu * FindMenuCustomization()

   ToolMenu.h  

virtual FToolMenuProfile * FindMenuProfile ( const FName& ProfileName
) const

   ToolMenu.h  

FToolMenuSection & FindOrAddSection ( const FName SectionName
)

 Finds an existing section using the provided FName or, if not found, creates a new one and assigns it that FName. ToolMenu.h  

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

 Finds an existing section using the provided FName or, if not found, creates a new one and assigns it that FName. ToolMenu.h  

FToolMenuSection * FindSection ( const FName SectionName
)

 Finds an existing section using the provided FName. ToolMenu.h  

virtual FCustomizedToolMenuHierarchy GetMenuCustomizationHierarchy()

   ToolMenu.h  

TArray< FName > GetMenuHierarchyNames ( bool bIncludeSubMenuRoot
) const

   ToolMenu.h  

FName GetMenuName()

   ToolMenu.h  

virtual FToolMenuProfileHierarchy GetMenuProfileHierarchy ( const FName& ProfileName
) const

   ToolMenu.h  

virtual FName GetSectionName ( const FName InEntryName
) const

   ToolMenu.h  

const ISlateStyle * GetStyleSet()

   ToolMenu.h  

TArray< const UToolMenu * > GetSubMenuChain()

 Returns array [Menu, Menu.SubMenuA, Menu.SubMenuB] for Menu.SubMenuB.SubMenuB ToolMenu.h  

FString GetSubMenuNamePath()

 Returns "SubMenuC.SubMenuD" for menu "ModuleA.MenuB.SubMenuC.SubMenuD" ToolMenu.h  

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

   ToolMenu.h
  • BlueprintCallable
  • Category="Tool Menus"

virtual bool IsEditing()

   ToolMenu.h  

bool IsRegistered()

   ToolMenu.h  

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

   ToolMenu.h  

virtual void OnMenuDestroyed()

   ToolMenu.h  

void RemoveMenuEntryObject ( UToolMenuEntryScript* InObject
)

   ToolMenu.h
  • BlueprintCallable
  • Category="Tool Menus"

void RemoveSection ( const FName SectionName
)

   ToolMenu.h  

void SetExtendersEnabled ( bool bEnabled
)

 Set support for extenders ToolMenu.h  

void SetMaxHeight ( uint32 InMaxHeight
)

   ToolMenu.h  

void SetStyleSet ( const ISlateStyle* InStyleSet
)

   ToolMenu.h  

virtual void UpdateMenuCustomizationFromMultibox ( const TSharedRef< const FMultiBox >& InMultiBox
)

   ToolMenu.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page