1. Epic GamesDeveloper
  3. FMenuBuilder

FMenuBuilder

Vertical menu builder

Unreal Engine C++ API Reference > Runtime > Slate > Framework > MultiBox

Inheritance Hierarchy

References

   
Module Slate
Header /Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
Include #include "Framework/MultiBox/MultiBoxBuilder.h"

Syntax

class FMenuBuilder : public FBaseMenuBuilder

Remarks

Vertical menu builder

Constructors

  Type Name Description
Public function  

FMenuBuilder ( const bool bInShouldCloseWindowAfterMenuSelection,
TSharedPtr< const FUICommandList > InCommandList,
TSharedPtr< FExtender > InExtender,
const bool bCloseSelfOnly,
const ISlateStyle* InStyleSet,
bool bInSearchable,
FName InMenuName,
bool bInRecursivelySearchable
)

 Constructor

Functions

  Type Name Description
Public function void

AddMenuSeparator ( FName InExtensionHook
)

 Adds a separator
Public function void Adds the widget the multibox will use for searching
Public function void

AddSeparator ( FName InExtensionHook
)

  
Public function void

AddSubMenu ( const TAttribute< FText >& InMenuLabel,
const TAttribute< FText >& InToolTip,
const FNewMenuDelegate& InSubMenu,
const FUIAction& InUIAction,
FName InExtensionHook,
const EUserInterfaceActionType InUserInterfaceActionType,
const bool bInOpenSubMenuOnClick,
const FSlateIcon& InIcon,
const bool bInShouldCloseWindowAfterMenuSelection
)

 Adds a sub-menu which is a menu within a menu
Public function void

AddSubMenu ( const TAttribute< FText >& InMenuLabel,
const TAttribute< FText >& InToolTip,
const FNewMenuDelegate& InSubMenu,
const bool bInOpenSubMenuOnClick,
const FSlateIcon& InIcon,
const bool bInShouldCloseWindowAfterMenuSelection,
FName InExtensionHook
)

  
Public function void

AddSubMenu ( const FUIAction& UIAction,
const TSharedRef< SWidget > Contents,
const FNewMenuDelegate& InSubMenu,
const bool bInShouldCloseWindowAfterMenuSelection
)

  
Public function void

AddSubMenu ( const TSharedRef< SWidget > Contents,
const FNewMenuDelegate& InSubMenu,
const bool bInOpenSubMenuOnClick,
const bool bInShouldCloseWindowAfterMenuSelection
)

  
Public function void

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

 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 FOnGetContent& InSubMenu,
const FSlateIcon& InIcon,
const FUIAction& UIAction
)

  
Public function void

AddWrapperSubMenu ( const FText& InMenuLabel,
const FText& InToolTip,
const TSharedPtr< SWidget >& InSubMenu,
const FSlateIcon& InIcon
)

 Adds a sub-menu which is a menu within a menu
Public function void

BeginSection ( FName InExtensionHook,
const TAttribute< FText >& InHeadingText
)

 Starts a section on to the extender section hook stack
Public function void Ends the current section
Public function void

SetIsEditing ( bool bInIsEditing
)

  

Overridden from FMultiBoxBuilder

  Type Name Description
Protected function Virtual void

ApplyHook ( FName InExtensionHook,
EExtensionHook::Position HookPosition
)

 FMultiBoxBuilder interface
Protected function Virtual void Applies the beginning of a section, including the header and relevant separator
Public function Virtual TSharedRef< class SWidget >

MakeWidget ( FMultiBox::FOnMakeMultiBoxBuilderOverride* InMakeMultiBoxBuilderOverride,
uint32 MaxHeight
)

 Creates a widget for this MultiBox

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page