#include <MultiBoxBuilder.h>

Inheritance diagram for FMultiBoxBuilder:

Public Member Functions
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 void	ApplyHook (FName InExtensionHook, EExtensionHook::Position HookPosition)=0

virtual void	ApplySectionBeginning ()

Protected Attributes
TSharedRef< class FMultiBox >	MultiBox

TArray< TSharedPtr< const FUICommandList > >	CommandListStack

TArray< TSharedPtr< class FExtender > >	ExtenderStack

FName	TutorialHighlightName

FName	MenuName

FName	CheckBoxStyle

bool	bExtendersEnabled

Detailed Description

MultiBox builder

Constructor & Destructor Documentation

◆ FMultiBoxBuilder()

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

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. This can be modified after the MultiBox is created by calling the PushCommandList() and PopCommandList() methods.
InTutorialHighlightName	Optional name to identify this widget and highlight during tutorials

◆ ~FMultiBoxBuilder()

virtual FMultiBoxBuilder::~FMultiBoxBuilder ( )

inlinevirtual

Member Function Documentation

◆ AddEditableText()

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

Adds an editable text entry

Parameters

InLabel	The label to display in the menu
InToolTip	The tool tip to display when the menu entry is hovered over
InIcon	The icon to display to the left of the label
InTextAttribute	The text string we're editing (often, a delegate will be bound to the attribute)
InOnTextCommitted	Called when the user commits their change to the editable text control
InOnTextChanged	Called when the text is changed interactively
bInReadOnly	Whether or not the text block is read only

◆ AddVerifiedEditableText()

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

Adds an editable text entry with a VerifyTextChanged delegate

Parameters

InLabel	The label to display in the menu
InToolTip	The tool tip to display when the menu entry is hovered over
InIcon	The icon to display to the left of the label
InTextAttribute	The text string we're editing (often, a delegate will be bound to the attribute)
InOnVerifyTextChanged	Called to verify when the text is changed interactively
InOnTextCommitted	Called when the user commits their change to the editable text control
InOnTextChanged	Called when the text is changed interactively
bInReadOnly	Whether or not the text block is read only

◆ ApplyHook()

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

protectedpure virtual

Applies any potential extension hooks at the current place

Implemented in FMenuBuilder, FMenuBarBuilder, FToolBarBuilder, and FButtonRowBuilder.

◆ ApplySectionBeginning()

virtual void FMultiBoxBuilder::ApplySectionBeginning ( )

inlineprotectedvirtual

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

Reimplemented in FMenuBuilder, and FToolBarBuilder.

◆ ExtendersEnabled()

bool FMultiBoxBuilder::ExtendersEnabled ( ) const

inline

Returns: True if extenders are enabled

◆ GetCustomization()

FMultiBoxCustomization FMultiBoxBuilder::GetCustomization ( ) const

Returns: The customization settings for the box being built

◆ GetMultiBox()

TSharedRef< class FMultiBox > FMultiBoxBuilder::GetMultiBox ( )

Get the multi-box being built.

Returns: The multi-box being built.

◆ GetStyleName()

const FName & FMultiBoxBuilder::GetStyleName ( ) const

Returns: The style name used by the multibox widgets

◆ GetStyleSet()

const ISlateStyle * FMultiBoxBuilder::GetStyleSet ( ) const

Returns: The style set used by the multibox widgets

◆ GetTopCommandList()

TSharedPtr< const FUICommandList > FMultiBoxBuilder::GetTopCommandList ( )

Returns: The top command list

◆ MakeWidget()

TSharedRef< class SWidget > FMultiBoxBuilder::MakeWidget ( FMultiBox::FOnMakeMultiBoxBuilderOverride * InMakeMultiBoxBuilderOverride = nullptr )

virtual

Creates a widget for this MultiBox

Returns: New widget object

Reimplemented in FMenuBuilder.

◆ PopCommandList()

void FMultiBoxBuilder::PopCommandList ( )

Pops the current command list.

◆ PopExtender()

void FMultiBoxBuilder::PopExtender ( )

Pops the current extender.

◆ PushCommandList()

void FMultiBoxBuilder::PushCommandList ( const TSharedRef< const FUICommandList > CommandList )

Pushes a new command list onto the stack. This command list will be used for all subsequently-added multiblocks, until the command-list is popped.

Parameters

CommandList The new command list to use

◆ PushExtender()

void FMultiBoxBuilder::PushExtender ( TSharedRef< FExtender > InExtender )

Pushes a new extender onto the stack. This extender will be used for all subsequently-added multiblocks, until the extender is popped.

Parameters

InExtender The new extender to use

◆ SetCheckBoxStyle()

void FMultiBoxBuilder::SetCheckBoxStyle ( FName InCheckBoxStyle )

the override for the checkbox style

◆ SetExtendersEnabled()

void FMultiBoxBuilder::SetExtendersEnabled ( bool bEnabled )

inline

Sets extender support

◆ SetLastSelectedCommandIndex()

void FMultiBoxBuilder::SetLastSelectedCommandIndex ( int32 InLastSelectedCommandIndex )

◆ SetStyle()

void FMultiBoxBuilder::SetStyle	(	const ISlateStyle *	InStyleSet,
		const FName &	InStyleName
	)

Sets the style to use on the multibox widgets

Member Data Documentation

◆ bExtendersEnabled

bool FMultiBoxBuilder::bExtendersEnabled

protected

If extenders are enabled

◆ CheckBoxStyle

FName FMultiBoxBuilder::CheckBoxStyle

protected

the override for the checkbox style for this menu

◆ CommandListStack

TArray< TSharedPtr< const FUICommandList > > FMultiBoxBuilder::CommandListStack

protected

A stack of command lists which map command infos to delegates that should be called. New multi blocks will always use the command-list at the top of the stack at the time they are added.

◆ ExtenderStack

TArray< TSharedPtr<class FExtender> > FMultiBoxBuilder::ExtenderStack

protected

The extender stack holding all the possible extensions for this menu builder

◆ MenuName

FName FMultiBoxBuilder::MenuName

protected

Name of the menu

◆ MultiBox

TSharedRef< class FMultiBox > FMultiBoxBuilder::MultiBox

protected

The MultiBox we're building up

◆ TutorialHighlightName

FName FMultiBoxBuilder::TutorialHighlightName

protected

Name to identify this widget and highlight during tutorials

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

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ FMultiBoxBuilder()

◆ ~FMultiBoxBuilder()

Member Function Documentation

◆ AddEditableText()

◆ AddVerifiedEditableText()

◆ ApplyHook()

◆ ApplySectionBeginning()

◆ ExtendersEnabled()

◆ GetCustomization()

◆ GetMultiBox()

◆ GetStyleName()

◆ GetStyleSet()

◆ GetTopCommandList()

◆ MakeWidget()

◆ PopCommandList()

◆ PopExtender()

◆ PushCommandList()

◆ PushExtender()

◆ SetCheckBoxStyle()

◆ SetExtendersEnabled()

◆ SetLastSelectedCommandIndex()

◆ SetStyle()

Member Data Documentation

◆ bExtendersEnabled

◆ CheckBoxStyle

◆ CommandListStack

◆ ExtenderStack

◆ MenuName

◆ MultiBox

◆ TutorialHighlightName