FMenuBarBuilder Class Reference

#include <MultiBoxBuilder.h>

Inheritance diagram for FMenuBarBuilder:

Public Member Functions
	FMenuBarBuilder (TSharedPtr< const FUICommandList > InCommandList, TSharedPtr< FExtender > InExtender=TSharedPtr< FExtender >(), const ISlateStyle *InStyleSet=&FCoreStyle::Get(), FName InMenuName=NAME_None)
SLATE_API void	AddPullDownMenu (const TAttribute< FText > &InMenuLabel, const TAttribute< FText > &InToolTip, const FNewMenuDelegate &InPullDownMenu, FName InExtensionHook=NAME_None, FName InTutorialHighlightName=NAME_None)
SLATE_API void	AddPullDownMenu (const TAttribute< FText > &InMenuLabel, const TAttribute< FText > &InToolTip, const FOnGetContent &InMenuContentGenerator, FName InExtensionHook=NAME_None, FName InTutorialHighlightName=NAME_None)
Public Member Functions inherited from FBaseMenuBuilder
SLATE_API	FBaseMenuBuilder (const EMultiBoxType InType, const bool bInShouldCloseWindowAfterMenuSelection, TSharedPtr< const FUICommandList > InCommandList, bool bInCloseSelfOnly, TSharedPtr< FExtender > InExtender=TSharedPtr< FExtender >(), const ISlateStyle *InStyleSet=&FCoreStyle::Get(), FName InTutorialHighlightName=NAME_None, FName InMenuName=NAME_None)
SLATE_API void	AddMenuEntry (const TSharedPtr< const FUICommandInfo > InCommand, FName InExtensionHook=NAME_None, const TAttribute< FText > &InLabelOverride=TAttribute< FText >(), const TAttribute< FText > &InToolTipOverride=TAttribute< FText >(), const FSlateIcon &InIconOverride=FSlateIcon(), FName InTutorialHighlightName=NAME_None, const TAttribute< EVisibility > &InVisibility=TAttribute< EVisibility >())
SLATE_API void	AddMenuEntry (const TAttribute< FText > &InLabel, const TAttribute< FText > &InToolTip, const FSlateIcon &InIcon, const FUIAction &UIAction, FName InExtensionHook=NAME_None, const EUserInterfaceActionType UserInterfaceActionType=EUserInterfaceActionType::Button, FName InTutorialHighlightName=NAME_None, const TAttribute< FText > &InInputBindingOverride=TAttribute< FText >(), const TAttribute< EVisibility > &InVisibility=TAttribute< EVisibility >())
SLATE_API void	AddMenuEntry (const FUIAction &UIAction, const TSharedRef< SWidget > Contents, const FName &InExtensionHook=NAME_None, const TAttribute< FText > &InToolTip=TAttribute< FText >(), const EUserInterfaceActionType UserInterfaceActionType=EUserInterfaceActionType::Button, FName InTutorialHighlightName=NAME_None, const TAttribute< EVisibility > &InVisibility=TAttribute< EVisibility >())
SLATE_API void	AddMenuEntry (const FMenuEntryParams &InMenuEntryParams)
Public Member Functions inherited from FMultiBoxBuilder
SLATE_API	FMultiBoxBuilder (const EMultiBoxType InType, FMultiBoxCustomization InCustomization, const bool bInShouldCloseWindowAfterMenuSelection, const TSharedPtr< const FUICommandList > &InCommandList, TSharedPtr< FExtender > InExtender=TSharedPtr< FExtender >(), FName InTutorialHighlightName=NAME_None, FName InMenuName=NAME_None)
virtual	~FMultiBoxBuilder ()
SLATE_API void	AddEditableText (const FText &InLabel, const FText &InToolTip, const FSlateIcon &InIcon, const TAttribute< FText > &InTextAttribute, const FOnTextCommitted &InOnTextCommitted=FOnTextCommitted(), const FOnTextChanged &InOnTextChanged=FOnTextChanged(), bool bInReadOnly=false)
SLATE_API void	AddVerifiedEditableText (const FText &InLabel, const FText &InToolTip, const FSlateIcon &InIcon, const TAttribute< FText > &InTextAttribute, const FOnVerifyTextChanged &InOnVerifyTextChanged, const FOnTextCommitted &InOnTextCommitted=FOnTextCommitted(), const FOnTextChanged &InOnTextChanged=FOnTextChanged(), bool bInReadOnly=false)
virtual SLATE_API TSharedRef< class SWidget >	MakeWidget (FMultiBox::FOnMakeMultiBoxBuilderOverride *InMakeMultiBoxBuilderOverride=nullptr)
SLATE_API TSharedRef< class FMultiBox >	GetMultiBox ()
SLATE_API void	PushCommandList (const TSharedRef< const FUICommandList > CommandList)
SLATE_API void	SetLastSelectedCommandIndex (int32 InLastSelectedCommandIndex)
SLATE_API void	PopCommandList ()
SLATE_API TSharedPtr< const FUICommandList >	GetTopCommandList ()
SLATE_API void	PushExtender (TSharedRef< FExtender > InExtender)
SLATE_API void	PopExtender ()
SLATE_API const ISlateStyle *	GetStyleSet () const
SLATE_API const FName &	GetStyleName () const
SLATE_API void	SetCheckBoxStyle (FName InCheckBoxStyle)
SLATE_API void	SetStyle (const ISlateStyle *InStyleSet, const FName &InStyleName)
SLATE_API FMultiBoxCustomization	GetCustomization () const
void	SetExtendersEnabled (bool bEnabled)
bool	ExtendersEnabled () const

Protected Member Functions
virtual SLATE_API void	ApplyHook (FName InExtensionHook, EExtensionHook::Position HookPosition) override
Protected Member Functions inherited from FMultiBoxBuilder
virtual void	ApplySectionBeginning ()

Additional Inherited Members
Protected Attributes inherited from FBaseMenuBuilder
bool	bCloseSelfOnly
Protected Attributes inherited from FMultiBoxBuilder
TSharedRef< class FMultiBox >	MultiBox
TArray< TSharedPtr< const FUICommandList > >	CommandListStack
TArray< TSharedPtr< class FExtender > >	ExtenderStack
FName	TutorialHighlightName
FName	MenuName
FName	CheckBoxStyle
bool	bExtendersEnabled

Detailed Description

Menu bar builder

Constructor & Destructor Documentation

FMenuBarBuilder()

FMenuBarBuilder::FMenuBarBuilder ( TSharedPtr< const FUICommandList >  InCommandList, TSharedPtr< FExtender >  InExtender = TSharedPtr<FExtender>(), const ISlateStyle *  InStyleSet = &FCoreStyle::Get(), FName  InMenuName = NAME_None  )

inline

Constructor

Parameters

InCommandList

The action list that maps command infos to delegates that should be called for each command associated with a multiblock widget

Member Function Documentation

AddPullDownMenu() [1/2]

void FMenuBarBuilder::AddPullDownMenu	(	const TAttribute< FText > &	InMenuLabel,
		const TAttribute< FText > &	InToolTip,
		const FNewMenuDelegate &	InPullDownMenu,
		FName	InExtensionHook = NAME_None,
		FName	InTutorialHighlightName = NAME_None
	)

Adds a pull down menu

Parameters

InMenuLabel	The text that should be shown for the menu
InToolTip	The tooltip that should be shown when the menu is hovered over
InPullDownMenu	Pull down menu object for the menu to add.

AddPullDownMenu() [2/2]

void FMenuBarBuilder::AddPullDownMenu	(	const TAttribute< FText > &	InMenuLabel,
		const TAttribute< FText > &	InToolTip,
		const FOnGetContent &	InMenuContentGenerator,
		FName	InExtensionHook = NAME_None,
		FName	InTutorialHighlightName = NAME_None
	)

Adds a pull down menu

Parameters

InMenuLabel	The text that should be shown for the menu
InToolTip	The tooltip that should be shown when the menu is hovered over
InMenuContentGenerator	Delegate that generates a widget for this pulldown menu's content. Called when the menu is summoned.

ApplyHook()

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

overrideprotectedvirtual

FMultiBoxBuilder interface

Implements FMultiBoxBuilder.

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
• Engine/Source/Runtime/Slate/Private/Framework/MultiBox/MultiBoxBuilder.cpp