1. Epic GamesDeveloper
  3. FMenuBuilder

FMenuBuilder

Vertical menu builder

API > API/Runtime > API/Runtime/Slate

Vertical menu builder

   
Name FMenuBuilder
Type class
Header File /Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
Include Path #include "Framework/MultiBox/MultiBoxBuilder.h"

Syntax

class FMenuBuilder : public FBaseMenuBuilder

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

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

 Constructor Framework/MultiBox/MultiBoxBuilder.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsEditing bool Whether menu is currently being edited Framework/MultiBox/MultiBoxBuilder.h  
bRecursivelySearchable bool Whether the search algorithm should walk down this menu sub-menu(s) (if the menu is searchable in first place). Framework/MultiBox/MultiBoxBuilder.h  
bSearchable bool Whether this menu is searchable Framework/MultiBox/MultiBoxBuilder.h  
bSectionNeedsToBeApplied bool True if there is a pending section that needs to be applied Framework/MultiBox/MultiBoxBuilder.h  
CurrentSectionExtensionHook FName Current extension hook name for sections to determine where sections begin and end Framework/MultiBox/MultiBoxBuilder.h  
CurrentSectionHeadingText FText Any pending section's heading text Framework/MultiBox/MultiBoxBuilder.h  
CurrentSectionResizeParams TAttribute< FMenuEntryResizeParams > Resize parameters for the current section Framework/MultiBox/MultiBoxBuilder.h  
CurrentSectionVisibility TAttribute< EVisibility > Keep track of current section visibility, in case the section needs to be dynamically hidden Framework/MultiBox/MultiBoxBuilder.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddMenuSeparator ( FName InExtensionHook,
const TAttribute< EVisibility >& InVisibility
)

 Adds a separator Framework/MultiBox/MultiBoxBuilder.h  

void AddSearchWidget()

 Adds the widget the multibox will use for searching Framework/MultiBox/MultiBoxBuilder.h  

void AddSeparator ( FName InExtensionHook,
const TAttribute< EVisibility >& InVisibility
)

   Framework/MultiBox/MultiBoxBuilder.h  

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,
const TAttribute< EVisibility >& InVisibility,
const TAttribute< FText >& InInputBindingOverride
)

 Adds a sub-menu which is a menu within a menu Framework/MultiBox/MultiBoxBuilder.h  

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

   Framework/MultiBox/MultiBoxBuilder.h  

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

   Framework/MultiBox/MultiBoxBuilder.h  

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

   Framework/MultiBox/MultiBoxBuilder.h  

void AddWidget ( TSharedRef< SWidget > InWidget,
const FText& InLabel,
bool bInNoIndent,
bool bInSearchable,
const TAttribute< FText >& InToolTipText
)

 Adds any widget to the menu Framework/MultiBox/MultiBoxBuilder.h  

void AddWidget ( const TSharedRef< SWidget >& InWidget,
const FText& InLabel,
const FMenuEntryStyleParams& InStyleParams,
bool bInSearchable,
const TAttribute< FText >& InToolTipText,
const TAttribute< FSlateIcon >& InIcon,
const TAttribute< EVisibility >& InVisibility
)

 Adds any widget to the menu Framework/MultiBox/MultiBoxBuilder.h  

void AddWidget ( const TSharedRef< SWidget >& InWidget,
const FText& InLabel,
const FMenuEntryStyleParams& InStyleParams,
const TAttribute< FMenuEntryResizeParams >& InResizeParams,
bool bInSearchable,
const TAttribute< FText >& InToolTipText,
const TAttribute< FSlateIcon >& InIcon,
const TAttribute< EVisibility >& InVisibility
)

 Adds any widget to the menu Framework/MultiBox/MultiBoxBuilder.h  

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

 Adds a sub-menu which is a menu within a menu Framework/MultiBox/MultiBoxBuilder.h  

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 Framework/MultiBox/MultiBoxBuilder.h  

void AddWrapperSubMenu ( const FText& InMenuLabel,
const FText& InToolTip,
const FOnGetContent& InSubMenu,
const FSlateIcon& InIcon,
const FUIAction& UIAction
)

   Framework/MultiBox/MultiBoxBuilder.h  

void BeginSection ( FName InExtensionHook,
const TAttribute< FText >& InHeadingText,
const TAttribute< EVisibility >& InVisibility,
const TAttribute< FMenuEntryResizeParams >& InResizeParams
)

 Starts a section on to the extender section hook stack Framework/MultiBox/MultiBoxBuilder.h  

void EndSection()

 Ends the current section Framework/MultiBox/MultiBoxBuilder.h  

virtual TSharedRef< class SWidget > MakeWidget ( FMultiBox::FOnMakeMultiBoxBuilderOverride* InMakeMultiBoxBuilderOverride,
uint32 MaxHeight
)

   Framework/MultiBox/MultiBoxBuilder.h  

void SetIsEditing ( bool bInIsEditing
)

   Framework/MultiBox/MultiBoxBuilder.h  

void SetSearchable ( bool bIsSearchable
)

   Framework/MultiBox/MultiBoxBuilder.h  

Overridden from FMultiBoxBuilder

Name Remarks Include Path Unreal Specifiers

virtual TSharedRef< class SWidget > MakeWidget ( FMultiBox::FOnMakeMultiBoxBuilderOverride* InMakeMultiBoxBuilderOverride
)

 Creates a widget for this MultiBox Framework/MultiBox/MultiBoxBuilder.h  

Protected

Overridden from FMultiBoxBuilder

Name Remarks Include Path Unreal Specifiers

virtual void ApplyHook ( FName InExtensionHook,
EExtensionHook::Position HookPosition
)

 FMultiBoxBuilder interface Framework/MultiBox/MultiBoxBuilder.h  

virtual void ApplySectionBeginning()

 Applies the beginning of a section, including the header and relevant separator Framework/MultiBox/MultiBoxBuilder.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page