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 > SMultiBoxWidget

Light Theme

Dark Theme

SMultiBoxWidget

MultiBox Slate widget

Windows

MacOS

Linux

Inheritance Hierarchy

FSlateControlledConstruction

TSharedFromThis

SWidget

SCompoundWidget

SMenuOwner

SMultiBoxWidget

References

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

Syntax

class SMultiBoxWidget : public SMenuOwner

Remarks

MultiBox Slate widget

Functions

	Name	Description
void	AddSearchElement ( TSharedPtr< SWidget >, FText )	Adds a widget to SearchElement map, making the widget searchable
void	BuildMultiBoxWidget()	Builds this MultiBox widget up from the MultiBox associated with it
void	Construct ( const FArguments& InArgs )	Construct this widget
void	FilterMultiBoxEntries()	Changes visibility of widgets in the multibox
FReply	FocusNextWidget ( EUINavigation NavigationType )	Helper function used to transfer focus to the next/previous widget
TSharedRef< ...	GenerateTiles ( TSharedPtr< SWidget > Item, const TSharedRef< STableViewBase > ... )	Generates the tiles for an STileView for button rows
EVisibility	GetCustomizationBorderDragVisibility ( const FName InBlockName, const EMultiBlockType InBlockType, bool& bOutInsertAfter )
EVisibility	GetCustomizationVisibility ( TWeakPtr< const FMultiBlock > Block..., TWeakPtr< SWidget > BlockWidgetWeak... )
float	GetItemHeight()
float	GetItemWidth()	Gets the maximum item width and height of the consituent widgets
TSharedRef< ...	GetMultiBox()	Access the MultiBox associated with this widget
bool	GetSearchable()	Gets the searchable state of this multibox
FText	GetSearchText()	Get the text to search by
TSharedPtr< ...	GetSearchTextWidget()	Get the SSearchText widget holding the search text
const FName ...	GetStyleName()
const ISlate...	GetStyleSet()
bool	IsBlockBeingDragged ( TSharedPtr< const FMultiBlock > Blo... )
void	OnCustomCommandDragEnter ( TSharedRef< const FMultiBlock > Mul..., const FGeometry& MyGeometry, const FDragDropEvent& DragDropEven... )	Called when a user drags a UI command into a multiblock in this widget
void	OnCustomCommandDragged ( TSharedRef< const FMultiBlock > Mul..., const FGeometry& MyGeometry, const FDragDropEvent& DragDropEven... )	Called when a user drags a UI command within multiblock in this widget
void	OnCustomCommandDropped()	Called when a user drops a UI command in this widget
void	OnDropExternal()	Called after a drag was initiated from this box but was dropped elsewhere
TSharedRef< ...	OnWrapButtonClicked()	Event handler for clicking the wrap button
void	ReduceSearch()
void	ResetSearch()	Resets the search to be empty
void	SetContent ( TSharedRef< SWidget > InContent )	Sets new content for the SMultiBoxWidget
void	SetMaxHeight ( TAttribute< float > InMaxHeight )	Sets optional maximum height of widget
void	SetMultiBox ( TSharedRef< FMultiBox > InMultiBox )	Associates this widget with a MultiBox
void	SetSearchable ( bool bSearchable )	Sets the searchable state of this multibox
void	SetSearchBlockWidget ( TSharedPtr< SWidget > )	Set the block widget holding the search text
void	TypeChar ( const TCHAR InChar )
void	UpdateSearch ( const TCHAR )	Changes visibility of widgets in the multibox

Overridden from SWidget

	Name	Description
FReply	OnDragOver ( const FGeometry& MyGeometry, const FDragDropEvent& DragDropEven... )	SWidget interface
FReply	OnDrop ( const FGeometry& MyGeometry, const FDragDropEvent& DragDropEven... )	Called when the user is dropping something onto a widget; terminates drag and drop.
FReply	OnFocusReceived ( const FGeometry& MyGeometry, const FFocusEvent& InFocusEvent )	KEY INPUT Called when focus is given to this widget. This event does not bubble.
FReply	OnKeyChar ( const FGeometry& MyGeometry, const FCharacterEvent& InCharacter... )	Called after a character is entered while this widget has keyboard focus
FReply	OnKeyDown ( const FGeometry& MyGeometry, const FKeyEvent& InKeyEvent )	Called after a key is pressed when this widget has focus (this event bubbles if not handled)
bool	OnVisualizeTooltip ( const TSharedPtr< SWidget >& Toolt... )	Called when Slate wants to visualize tooltip.
bool	SupportsKeyboardFocus()	Checks to see if this widget supports keyboard focus. Override this in derived classes.

Classes

	Name	Description
	FArguments

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

Take our survey

Dismiss