Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Slate > Framework > MultiBox > FMultiBox

Light Theme

Dark Theme

FMultiBox

MultiBox. Contains a list of MultiBlocks that provide various functionality.

Windows

MacOS

Linux

Inheritance Hierarchy

TSharedFromThis

FMultiBox

References

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

Syntax

class FMultiBox : public TSharedFromThis< FMultiBox >

Remarks

Contains a list of MultiBlocks that provide various functionality.

Variables

	Name	Description
bool	bHasSearchWidget	Whether the MultiBox has a search widget
FOnModifyBlockW...	ModifyBlockWidgetAfterMake	Allow further modifications to the block's widget after it has been made
TWeakObjectPtr<...	WeakToolMenu	Weak reference to tool menu that created this multibox

Constructors

No constructors are accessible with public or protected access.

Destructors

	Name	Description
	~FMultiBox()

Functions

	Name	Description
void	AddMultiBlock ( TSharedRef< const FMultiBlock > InB... )	Adds a MultiBlock to this MultiBox, to the end of the list
void	AddMultiBlockToFront ( TSharedRef< const FMultiBlock > InB... )	Adds a MultiBlock to this MultiBox, to the front of the list
TSharedRef< ...	Create ( const EMultiBoxType InType, FMultiBoxCustomization InCustomizat..., const bool bInShouldCloseWindowAfte... )	Creates a new multibox instance
TSharedPtr< ...	FindBlockFromNameAndType ( const FName InName, const EMultiBlockType InType )	Finds an existing block by name and type
const TArray...	GetBlocks()	Access this MultiBox's list of blocks
FName	GetCustomizationName()
int32	GetSectionEditBounds ( const int32 Index, int32& OutSectionEndIndex )	Only callable during edit mode
const FName ...	GetStyleName()
const ISlate...	GetStyleSet()
UToolMenuBas...	GetToolMenu()
const EMulti...	GetType()	Gets the type of this MultiBox
void	InsertCustomMultiBlock ( TSharedRef< const FMultiBlock > InB..., int32 Index )	Inserts a MultiBlock to the list for user customization
bool	IsInEditMode()
TSharedPtr< ...	MakeMultiBlockFromCommand ( TSharedPtr< const FUICommandInfo > ..., bool bCommandMustBeBound )	Creates a block from the provided command that is compatible with this box
TSharedRef< ...	MakeWidget ( bool bSearchable, FOnMakeMultiBoxBuilderOverride*..., TAttribute< float > InMaxHeight )	Creates a MultiBox widget for this MultiBox
const FEditS...	OnEditSelectionChanged()	Delegate to call while editing when selected block has changed
FEditSelecti...	OnEditSelectionChanged()	Delegate to call while editing when selected block has changed
void	RemoveCustomMultiBlock ( TSharedRef< const FMultiBlock > InB... )	Removes a MultiBlock from the list for user customization
void	SetStyle ( const ISlateStyle* InStyleSet, const FName& InStyleName )	Sets the style to use on the multibox widgets
bool	ShouldCloseWindowAfterMenuSelection()	Gets whether or not the window that contains this multibox should be destroyed after the user clicks on a menu item in this box

Typedefs

Name	Description
FEditSelectionChangedDelegate
FOnMakeMultiBoxBuilderOverride
FOnModifyBlockWidgetAfterMake

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss