1. Epic GamesDeveloper
  3. UToolMenu

UToolMenu

Represents a menu in the ToolMenus system.

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

UCLASS (BlueprintType)  
class UToolMenu : public UToolMenuBase

Remarks

Represents a menu in the ToolMenus system.

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

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bCloseSelfOnly  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bPreventCustomization Prevent menu from being customized
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bSearchable  
Public variable UProperty Transient bool bShouldCleanupContextOnDestroy  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bShouldCloseWindowAfterMenuSelection  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bToolBarForceSmallIcons  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bToolBarIsFocusable  
Public variable UProperty FToolMenuContext Context  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FName MenuName  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FToolMenuOwner MenuOwner  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FName MenuParent  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite EMultiBoxType MenuType  
Public variable FMultiBox::FOnModifyBlockWidgetAfterMake ModifyBlockWidgetAfterMake  
Public variable UProperty TArray< FToolMenuSection > Sections  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FName StyleName  
Public variable UProperty TObjectPtr< const UToolMenu > SubMenuParent  
Public variable UProperty FName SubMenuSourceEntryName  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite 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
)

 Build a section in a callback.
Public function UFunction BlueprintCallable, Category, Meta void

AddDynamicSectionScript ( const FName SectionName,
UToolMenuSectionDynamic* Object
)

  
Public function UFunction BlueprintCallable, Category void

AddMenuEntry ( const FName SectionName,
const FToolMenuEntry& Args
)

  
Public function UFunction BlueprintCallable, Category void  
Public function FToolMenuSection &

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

  
Public function UFunction BlueprintCallable, Category, Meta 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 UFunction BlueprintCallable, Category, Meta 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
)

 Finds an existing section using the provided FName or, if not found, creates a new one and assigns it that FName.
Public function 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.
Public function FToolMenuSection *

FindSection ( const FName SectionName
)

 Finds an existing section using the provided FName.
Public function Const TArray< FName >

GetMenuHierarchyNames ( bool bIncludeSubMenuRoot
)

  
Public function Const FName  
Public function Const const ISlateStyle *  
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 UFunction BlueprintCallable, Category 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
)

  
Public function void

SetStyleSet ( const ISlateStyle* InStyleSet
)

  

Overridden from UToolMenuBase

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

AddMenuProfile ( const FName& ProfileName
)

  
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 FToolMenuProfile *

FindMenuProfile ( const FName& ProfileName
)

  
Public function Virtual Const FCustomizedToolMenuHierarchy  
Public function Virtual Const FToolMenuProfileHierarchy

GetMenuProfileHierarchy ( const FName& ProfileName
)

  
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