#include <MultiBoxBuilder.h>

Inheritance diagram for FBaseMenuBuilder:

Public Member Functions
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 Attributes
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

Additional Inherited Members
Protected Member Functions inherited from FMultiBoxBuilder
virtual void	ApplyHook (FName InExtensionHook, EExtensionHook::Position HookPosition)=0

virtual void	ApplySectionBeginning ()

Detailed Description

Base menu builder

Constructor & Destructor Documentation

◆ FBaseMenuBuilder()

FBaseMenuBuilder::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`
	)

Constructor

Parameters

InType	Type of MultiBox
bInShouldCloseWindowAfterMenuSelection	Sets whether or not the window that contains this multibox should be destroyed after the user clicks on a menu item in this box
InCommandList	The action list that maps command infos to delegates that should be called for each command associated with a multiblock widget
bInCloseSelfOnly	True if clicking on a menu entry closes itself only and its children but not the entire stack
InTutorialHighlightName	Optional name to identify this widget and highlight during tutorials

Member Function Documentation

◆ AddMenuEntry() [1/4]

void FBaseMenuBuilder::AddMenuEntry ( const FMenuEntryParams & InMenuEntryParams )

Adds a menu entry with given param struct

◆ AddMenuEntry() [2/4]

void FBaseMenuBuilder::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>()`
	)

Adds a menu entry with a custom widget

Parameters

UIAction	Actions to execute on this menu item.
Contents	Custom widget to display
InExtensionHook	The section hook. Can be NAME_None
InToolTip	Tool tip used when hovering over the menu entry
UserInterfaceActionType	Type of interface action
InTutorialHighlightName	Optional name to identify this widget and highlight during tutorials
InVisibility	Optional Visibility Override. Can be used to show/hide this entry dynamically.

◆ AddMenuEntry() [3/4]

void FBaseMenuBuilder::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>()`
	)

Adds a menu entry without the use of a command

Parameters

InLabel	Label to show in the menu entry
InToolTip	Tool tip used when hovering over the menu entry
InIcon	The icon to use
UIAction	Actions to execute on this menu item.
InExtensionHook	The section hook. Can be NAME_None
UserInterfaceActionType	Type of interface action
InTutorialHighlightName	Optional name to identify this widget and highlight during tutorials
InInputBindingOverride	Optional overridden input binding text for this menu entry. If not set, then the UI action's binding will be used if available.
InVisibility	Optional Visibility Override. Can be used to show/hide this entry dynamically.

◆ AddMenuEntry() [4/4]

void FBaseMenuBuilder::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>()`
	)

Adds a menu entry

Parameters

InCommand	The command associated with this menu entry
InExtensionHook	The section hook. Can be NAME_None
InLabelOverride	Optional label override. If omitted, then the action's label will be used instead.
InToolTipOverride	Optional tool tip override. If omitted, then the action's label will be used instead.
InIconOverride	Optional name of the slate brush to use for the tool bar image. If omitted, then the command's icon will be used instead.
InTutorialHighlightName	Optional name to identify this widget and highlight during tutorials
InVisibility	Optional Visibility Override. Can be used to show/hide this entry dynamically.

Member Data Documentation

◆ bCloseSelfOnly

bool FBaseMenuBuilder::bCloseSelfOnly

protected

True if clicking on a menu entry closes itself only and its children and not the entire stack

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBaseMenuBuilder()

Member Function Documentation

◆ AddMenuEntry() [1/4]

◆ AddMenuEntry() [2/4]

◆ AddMenuEntry() [3/4]

◆ AddMenuEntry() [4/4]

Member Data Documentation

◆ bCloseSelfOnly