UToolMenu

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

ToolMenus

Header

/Engine/Source/Developer/ToolMenus/Public/ToolMenu.h

Include

#include "ToolMenu.h"

Syntax

class UToolMenu : public UToolMenuBase

Variables

Name Description

Public variable

bool

 

bCloseSelfOnly

Public variable

bool

 

bPreventCustomization

Prevent menu from being customized

Public variable

bool

 

bSearchable

Public variable

bool

 

bShouldCloseWindowAfterMenuSelection

Public variable

bool

 

bToolBarForceSmallIcons

Public variable

bool

 

bToolBarIsFocusable

Public variable

FToolMenuContex ...

 

Context

Public variable

FName

 

MenuName

Public variable

FToolMenuOwner

 

MenuOwner

Public variable

FName

 

MenuParent

Public variable

EMultiBoxType

 

MenuType

Public variable

FMultiBox::FOnM ...

 

ModifyBlockWidgetAfterMake

Public variable

TArray < FToolMe ...

 

Sections

Public variable

FName

 

StyleName

Public variable

const UToolMenu ...

 

SubMenuParent

Public variable

FName

 

SubMenuSourceEntryName

Public variable

FName

 

TutorialHighlightName

Constructors

Name Description

Public function

UToolMenu()

Functions

Name Description

Public function

FToolMenuSec ...

 

AddDynamicSection

(
    const FName SectionName,
    const FNewSectionConstructChoice & ...,
    const FToolMenuInsert InPosition
)

Public function

void

 

AddDynamicSectionScript

(
    const FName SectionName,
    UToolMenuSectionDynamic * Objec...
)

Public function

void

 

AddMenuEntry

(
    const FName SectionName,
    const FToolMenuEntry & Args
)

Public function

void

 

AddMenuEntryObject

(
    UToolMenuEntryScript * InObject
)

Public function

FToolMenuSec ...

 

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 InsertTyp...
)

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...

 

FindContext()

Public function

FToolMenuSec ...

 

FindOrAddSection

(
    const FName SectionName
)

Public function

FToolMenuSec ...

 

FindSection

(
    const FName SectionName
)

Public function Const

TArray < FNam ...

 

GetMenuHierarchyNames

(
    bool bIncludeSubMenuRoot
)

Public function Const

FName

 

GetMenuName()

Public function Const

TArray < cons...

 

GetSubMenuChain()

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

Public function Const

FString

 

GetSubMenuNamePath()

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

 

IsRegistered()

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

Name Description

Public function Virtual Const

FCustomizedT ...

 

AddMenuCustomization()

Public function Virtual Const

bool

 

ContainsEntry

(
    const FName InName
)

Public function Virtual Const

bool

 

ContainsSection

(
    const FName InName
)

Public function Virtual Const

FCustomizedT ...

 

FindMenuCustomization()

Public function Virtual Const

FCustomizedT ...

 

GetMenuCustomizationHierarchy()

Public function Virtual Const

FName

 

GetSectionName

(
    const FName InEntryName
)

Public function Virtual Const

bool

 

IsEditing()

Public function Virtual

void

 

UpdateMenuCustomizationFromMultibox

(
    const TSharedRef < const FMultiBox >...
)

Overridden from UObject

Name Description

Public function Virtual Const

bool

 

IsDestructionThreadSafe()

Called during garbage collection to determine if an object can have its destructor called on a worker thread.

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback