UToolMenus

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

ToolMenus

Header

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

Include

#include "ToolMenus.h"

Syntax

class UToolMenus : public UObject

Variables

Name Description

Public variable

FEditMenuDelega...

 

EditMenuDelegate

Public variable

FSlateIcon

 

EditMenuIcon

Icon to display in menus for command to open menu editor

Public variable

FSlateIcon

 

EditToolbarIcon

Icon to display in toolbars for command to open menu editor

Public variable

FShouldDisplayE...

 

ShouldDisplayExtensionPoints

Constructors

Name Description

Public function

UToolMenus()

Functions

Name Description

Public function

void

 

AddEntry

(
    const FName MenuName,
    const FName SectionName,
    const FToolMenuEntry& Entry
)

Registers an entry for a menu's section

Public function

FCustomizedT...

 

AddMenuCustomization

(
    const FName InName
)

Find or add customization settings for a menu

Public function Static

bool

 

AddMenuEntryObject

(
    UToolMenuEntryScript* MenuEntr...
)

Registers menu entry object from blueprint/script

Public function

void

 

AddMenuSubstitutionDuringGenerate

(
    const FName OriginalMenu,
    const FName NewMenu
)

Substitute one menu for another during generate but not during find or extend

Public function Static

void

 

AddReferencedObjects

(
    UObject* InThis,
    FReferenceCollector& Collector
)

Public function

void

 

AddSection

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

Registers a section for a menu

Public function

void

 

AssembleMenuHierarchy

(
    UToolMenu* GeneratedMenu,
    const TArray< UToolMenu* >& H...
)

Bake final menu including calls to construction delegates, sorting, and customization

Public function

void

 

AssignSetTimerForNextTickDelegate

(
    const FSimpleDelegate& InDelegate
)

Sets delegate to setup timer for deferred one off ticks

Public function

TArray< UToo...

 

CollectHierarchy

(
    const FName Name
)

Returns list of menus starting with root parent

Public function Const

FToolMenuOwn...

 

CurrentOwner()

For advanced use cases

Public function

UToolMenu &#...

 

ExtendMenu

(
    const FName Name
)

Extends a menu without registering the menu or claiming ownership of it.

Public function Static

UObject *...

 

FindContext

(
    const FToolMenuContext& InContext,
    UClass* InClass
)

Finds a context object of a given class if it exists

Public function

UToolMenu &#...

 

FindMenu

(
    const FName Name
)

Finds an existing menu that has been registered or extended.

Public function

FCustomizedT...

 

FindMenuCustomization

(
    const FName InName
)

Find customization settings for a menu

Public function

int32

 

FindMenuCustomizationIndex

(
    const FName InName
)

Find index of customization settings for a menu

Public function

UToolMenu &#...

 

GenerateMenu

(
    const FName Name,
    const FToolMenuContext& InMenuCont...
)

Create a finalized menu that combines all parents used to generate a widget.

Public function

UToolMenu &#...

 

GenerateMenuAsBuilder

(
    const UToolMenu* InMenu,
    const FToolMenuContext& InMenuCont...
)

Create a finalized menu based on a custom crafted menu. Advanced special use cases only.

Public function

UToolMenu &#...

 

GenerateMenuOrSubMenuForEdit

(
    const UToolMenu* InMenu
)

Generate either a menu or submenu ready for editing

Public function

UToolMenu &#...

 

GenerateSubMenu

(
    const UToolMenu* InGeneratedPa...,
    const FName InBlockName
)

Generates sub menu by entry name in the given generated menu parent

Public function

TSharedRef< ...

 

GenerateWidget

(
    UToolMenu* GeneratedMenu
)

Generate widget from a final collapsed menu. For advanced specialized use cases.

Public function

TSharedRef< ...

 

GenerateWidget

(
    const TArray< UToolMenu* >& H...,
    const FToolMenuContext& InMenuCont...
)

Generate widget from a hierarchy of menus. For advanced specialized use cases.

Public function

TSharedRef< ...

 

GenerateWidget

(
    const FName Name,
    const FToolMenuContext& InMenuCont...
)

Generate widget from a registered menu. Most common function used to generate new menu widgets.

Public function Static

UToolMenus &...

 

Get()

Public function Const

bool

 

GetEditMenusMode()

When true, adds command to open edit menu dialog to each menu

Public function

void

 

HandleNextTick()

Timer function used to consolidate multiple duplicate requests into a single frame.

Public function Const

bool

 

IsMenuRegistered

(
    const FName Name
)

Determines if a menu has already been registered.

Public function Static

bool

 

IsToolMenuUIEnabled()

Returns true if slate initialized and editor GUI is being used.

Public function Static

FName

 

JoinMenuPaths

(
    const FName Base,
    const FName Child
)

Join two paths together

Public function

void

 

RefreshAllWidgets()

Rebuilds all currently generated widgets next tick.

Public function

bool

 

RefreshMenuWidget

(
    const FName Name
)

Rebuilds all widgets generated from a specific menu.

Public function

UToolMenu &#...

 

RegisterMenu

(
    FName Name,
    const FName Parent,
    EMultiBoxType Type,
    bool bWarnIfAlreadyRegistered
)

Registers a menu by name

Public function Static

FDelegateHan...

 

RegisterStartupCallback

(
    const FSimpleMulticastDelegate::FDe...
)

Delays menu registration until safe and ready Will not trigger if Slate does not end up being enabled after loading Will not trigger when running commandlet, game, dedicated server or client only

Public function

void

 

RegisterStringCommandHandler

(
    const FName InName,
    const FToolMenuExecuteString& InDe...
)

Registers a new type of string based command handler.

Public function

void

 

RemoveAllCustomizations()

Remove all menu customizations for all menus

Public function

void

 

RemoveCustomization

(
    const FName InName
)

Remove customization for a menu

Public function

void

 

RemoveEntry

(
    const FName MenuName,
    const FName Section,
    const FName Name
)

Removes a menu entry from a given menu and section

Public function

void

 

RemoveMenu

(
    const FName MenuName
)

Unregisters a menu by name

Public function

void

 

RemoveSection

(
    const FName MenuName,
    const FName Section
)

Removes a section from a given menu

Public function

void

 

RemoveSubstitutionDuringGenerate

(
    const FName InMenu
)

Remove substitute one menu for another during generate

Public function

void

 

SaveCustomizations()

Save menu customizations to ini files

Public function

void

 

SetEditMenusMode

(
    bool bEnable
)

Enables adding command to open edit menu dialog to each menu

Public function

void

 

SetSectionLabel

(
    const FName MenuName,
    const FName SectionName,
    const FText Label
)

Sets a section's displayed label text.

Public function

void

 

SetSectionPosition

(
    const FName MenuName,
    const FName SectionName,
    const FName OtherSectionName,
    const EToolMenuInsertType PositionT...
)

Sets where to insert a section into a menu when generating relative to other section names.

Public function Static

bool

 

SplitMenuPath

(
    const FName MenuPath,
    FName& OutLeft,
    FName& OutRight
)

Break apart a menu path into components

Public function Static

UToolMenus &...

 

TryGet()

Try to get UToolMenus without forcing ToolMenus module to load.

Public function Static

void

 

UnregisterOwner

(
    FToolMenuOwner Owner
)

Unregister everything associated with the given owner without forcing ToolMenus module to load.

Public function

void

 

UnregisterOwnerByName

(
    FName InOwnerName
)

Removes all entries that were registered under a specific owner name

Public function Static

void

 

UnRegisterStartupCallback

(
    const void* UserPointer
)

Unregister a startup callback delegate by pointer

Public function Static

void

 

UnRegisterStartupCallback

(
    FDelegateHandle InHandle
)

Unregister a startup callback delegate by handle

Public function

void

 

UnregisterStringCommandHandler

(
    const FName InName
)

Removes a string based command handler.

Overridden from UObject

Name Description

Public function Virtual

void

 

BeginDestroy()

Called before destroying the object.

Public function Virtual Const

bool

 

IsDestructionThreadSafe()

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

Typedefs

Name

Description

FEditMenuDelegate

Delegate that opens a menu editor

FShouldDisplayExtensionPoints

Displaying extension points is for debugging menus

Constants

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss