FMenuBuilder

Vertical menu builder

Windows
MacOS
Linux

Inheritance Hierarchy

Syntax

class FMenuBuilder : public FBaseMenuBuilder

Remarks

Vertical menu builder

Constructors

Name Description

Public function

FMenuBuilder

(
    const bool bInShouldCloseWindowAfte...,
    TSharedPtr< const FUICommandList > ...,
    TSharedPtr< FExtender > InExtender,
    const bool bCloseSelfOnly,
    const ISlateStyle* InStyleSet,
    bool bInSearchable
)

Constructor

Functions

Name Description

Public function

void

 

AddMenuSeparator

(
    FName InExtensionHook
)

Adds a menu separator

Public function

void

 

AddSearchWidget()

Adds the widget the multibox will use for searching

Public function

void

 

AddSubMenu

(
    const TSharedRef< SWidget > Content...,
    const FNewMenuDelegate& InSubMenu,
    const bool bInOpenSubMenuOnClick,
    const bool bInShouldCloseWindowAfte...
)

Public function

void

 

AddSubMenu

(
    const FUIAction& UIAction,
    const TSharedRef< SWidget > Content...,
    const FNewMenuDelegate& InSubMenu,
    const bool bInShouldCloseWindowAfte...
)

Public function

void

 

AddSubMenu

(
    const TAttribute< FText >& InMenuL...,
    const TAttribute< FText >& InToolT...,
    const FNewMenuDelegate& InSubMenu,
    const bool bInOpenSubMenuOnClick,
    const FSlateIcon& InIcon,
    const bool bInShouldCloseWindowAfte...
)

Public function

void

 

AddSubMenu

(
    const TAttribute< FText >& InMenuL...,
    const TAttribute< FText >& InToolT...,
    const FNewMenuDelegate& InSubMenu,
    const FUIAction& InUIAction,
    FName InExtensionHook,
    const EUserInterfaceActionType::Typ...,
    const bool bInOpenSubMenuOnClick,
    const FSlateIcon& InIcon,
    const bool bInShouldCloseWindowAfte...
)

Adds a sub-menu which is a menu within a menu

Public function

void

 

AddWidget

(
    TSharedRef< SWidget > InWidget,
    const FText& Label,
    bool bNoIndent,
    bool bSearchable
)

Adds any widget to the menu

Public function

void

 

AddWrapperSubMenu

(
    const FText& InMenuLabel,
    const FText& InToolTip,
    const FOnGetContent& InSubMenu,
    const FSlateIcon& InIcon
)

These classes need access to the AddWrapperSubMenu() methods friend class FWidgetBlock; friend class FToolBarComboButtonBlock; Adds a sub-menu which is a menu within a menu

Public function

void

 

AddWrapperSubMenu

(
    const FText& InMenuLabel,
    const FText& InToolTip,
    const TSharedPtr< SWidget >& InSub...,
    const FSlateIcon& InIcon
)

Adds a sub-menu which is a menu within a menu

Public function

void

 

BeginSection

(
    FName InExtensionHook,
    const TAttribute< FText >& InHeadi...
)

Starts a section on to the extender section hook stack

Public function

void

 

EndSection()

Ends the current section

Overridden from FMultiBoxBuilder

Name Description

Protected function Virtual

void

 

ApplyHook

(
    FName InExtensionHook,
    EExtensionHook::Position HookPositi...
)

FMultiBoxBuilder interface

Protected function Virtual

void

 

ApplySectionBeginning()

Applies the beginning of a section, including the header and relevant separator

Public function Virtual

TSharedRef< ...

 

MakeWidget

Creates a widget for this MultiBox

References

Module

Slate

Header

Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h

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