#include <MultiBox.h>

Inheritance diagram for SMultiBoxWidget:

Public Member Functions
	SLATE_BEGIN_ARGS (SMultiBoxWidget)

SLATE_API void	Construct (const FArguments &InArgs)

void	SetMultiBox (TSharedRef< FMultiBox > InMultiBox)

void	SetContent (TSharedRef< SWidget > InContent)

TSharedRef< const FMultiBox >	GetMultiBox () const

SLATE_API void	SetSearchable (bool bSearchable)

SLATE_API bool	GetSearchable () const

TSharedRef< FLinkedBoxManager >	GetLinkedBoxManager ()

void	SetMaxHeight (TAttribute< float > InMaxHeight)

SLATE_API void	BuildMultiBoxWidget ()

SLATE_API void	UpdateMultiBoxWidget (TSharedRef< FMultiBox > InMultiBox)

SLATE_API TSharedRef< ITableRow >	GenerateTiles (TSharedPtr< SWidget > Item, const TSharedRef< STableViewBase > &OwnerTable)

SLATE_API float	GetItemWidth () const

SLATE_API float	GetItemHeight () const

SLATE_API TSharedRef< SWidget >	OnWrapButtonClicked ()

const ISlateStyle *	GetStyleSet () const

const FName &	GetStyleName () const

SLATE_API void	OnCustomCommandDragEnter (TSharedRef< const FMultiBlock > MultiBlock, const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent)

SLATE_API void	OnCustomCommandDragged (TSharedRef< const FMultiBlock > MultiBlock, const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent)

SLATE_API void	OnCustomCommandDropped ()

SLATE_API void	OnDropExternal ()

virtual SLATE_API FReply	OnDragOver (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent) override

virtual SLATE_API FReply	OnDrop (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent) override

virtual SLATE_API bool	SupportsKeyboardFocus () const override

virtual SLATE_API FReply	OnFocusReceived (const FGeometry &MyGeometry, const FFocusEvent &InFocusEvent) override

virtual SLATE_API void	OnFocusChanging (const FWeakWidgetPath &PreviousFocusPath, const FWidgetPath &NewWidgetPath, const FFocusEvent &InFocusEvent) override

virtual SLATE_API FReply	OnKeyDown (const FGeometry &MyGeometry, const FKeyEvent &KeyEvent) override

virtual SLATE_API FReply	OnKeyChar (const FGeometry &MyGeometry, const FCharacterEvent &InCharacterEvent) override

virtual SLATE_API bool	OnVisualizeTooltip (const TSharedPtr< SWidget > &TooltipContent) override

SLATE_API void	BeginSearch (const TCHAR InChar)

SLATE_API void	ResetSearch ()

SLATE_API void	FilterMultiBoxEntries ()

SLATE_API FText	GetSearchText () const

SLATE_API TSharedPtr< SWidget >	GetSearchTextWidget ()

SLATE_API void	SetSearchBlockWidget (TSharedPtr< SWidget >)

SLATE_API void	AddSearchElement (TSharedPtr< SWidget >, FText)

SLATE_API void	AddElement (TSharedPtr< SWidget > BlockWidget, FText BlockDisplayText, bool bInSearchable=true)

SLATE_API bool	IsBlockBeingDragged (TSharedPtr< const FMultiBlock > Block) const

SLATE_API EVisibility	GetCustomizationVisibility (TWeakPtr< const FMultiBlock > BlockWeakPtr, TWeakPtr< SWidget > BlockWidgetWeakPtr) const

SLATE_API EVisibility	GetCustomizationBorderDragVisibility (const FName InBlockName, const EMultiBlockType InBlockType, bool &bOutInsertAfter) const

SLATE_API void	SetSummonedMenuTime (double InSummonedMenuTime)

SLATE_API double	GetSummonedMenuTime () const

bool	ShouldShowMenuSearchField () const

Public Member Functions inherited from SMenuOwner
	SLATE_BEGIN_ARGS (SMenuOwner)

SLATE_API void	Construct (const FArguments &InArgs)

SLATE_API void	SetSummonedMenu (TSharedRef< SMenuAnchor > InMenuAnchor)

SLATE_API TSharedPtr< const SMenuAnchor >	GetOpenMenu () const

SLATE_API void	CloseSummonedMenus ()

Public Member Functions inherited from SCompoundWidget
const FVector2D	GetContentScale () const

void	SetContentScale (TAttribute< FVector2D > InContentScale)

FLinearColor	GetColorAndOpacity () const

void	SetColorAndOpacity (TAttribute< FLinearColor > InColorAndOpacity)

void	SetForegroundColor (TAttribute< FSlateColor > InForegroundColor)

virtual SLATECORE_API int32	OnPaint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const override

virtual SLATECORE_API FChildren *	GetChildren () override

virtual SLATECORE_API void	OnArrangeChildren (const FGeometry &AllottedGeometry, FArrangedChildren &ArrangedChildren) const override

virtual SLATECORE_API FSlateColor	GetForegroundColor () const override

virtual SLATECORE_API void	SetVisibility (TAttribute< EVisibility > InVisibility) override final

Public Member Functions inherited from SWidget
SLATECORE_API int32	Paint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const

virtual SLATECORE_API void	Tick (const FGeometry &AllottedGeometry, const double InCurrentTime, const float InDeltaTime)

virtual SLATECORE_API void	OnFocusLost (const FFocusEvent &InFocusEvent)

virtual SLATECORE_API FReply	OnPreviewKeyDown (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent)

virtual SLATECORE_API FReply	OnKeyUp (const FGeometry &MyGeometry, const FKeyEvent &InKeyEvent)

virtual SLATECORE_API FReply	OnAnalogValueChanged (const FGeometry &MyGeometry, const FAnalogInputEvent &InAnalogInputEvent)

virtual SLATECORE_API FReply	OnMouseButtonDown (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)

virtual SLATECORE_API FReply	OnPreviewMouseButtonDown (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)

virtual SLATECORE_API FReply	OnMouseButtonUp (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)

virtual SLATECORE_API FReply	OnMouseMove (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)

virtual SLATECORE_API void	OnMouseEnter (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)

virtual SLATECORE_API void	OnMouseLeave (const FPointerEvent &MouseEvent)

virtual SLATECORE_API FReply	OnMouseWheel (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)

virtual SLATECORE_API FCursorReply	OnCursorQuery (const FGeometry &MyGeometry, const FPointerEvent &CursorEvent) const

virtual SLATECORE_API TOptional< TSharedRef< SWidget > >	OnMapCursor (const FCursorReply &CursorReply) const

virtual SLATECORE_API FReply	OnMouseButtonDoubleClick (const FGeometry &InMyGeometry, const FPointerEvent &InMouseEvent)

virtual SLATECORE_API TSharedPtr< FPopupLayer >	OnVisualizePopup (const TSharedRef< SWidget > &PopupContent)

virtual SLATECORE_API FReply	OnDragDetected (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent)

virtual SLATECORE_API void	OnDragEnter (const FGeometry &MyGeometry, const FDragDropEvent &DragDropEvent)

virtual SLATECORE_API void	OnDragLeave (const FDragDropEvent &DragDropEvent)

virtual SLATECORE_API FReply	OnTouchGesture (const FGeometry &MyGeometry, const FPointerEvent &GestureEvent)

virtual SLATECORE_API FReply	OnTouchStarted (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)

virtual SLATECORE_API FReply	OnTouchMoved (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)

virtual SLATECORE_API FReply	OnTouchEnded (const FGeometry &MyGeometry, const FPointerEvent &InTouchEvent)

virtual SLATECORE_API FReply	OnTouchForceChanged (const FGeometry &MyGeometry, const FPointerEvent &TouchEvent)

virtual SLATECORE_API FReply	OnTouchFirstMove (const FGeometry &MyGeometry, const FPointerEvent &TouchEvent)

virtual SLATECORE_API FReply	OnMotionDetected (const FGeometry &MyGeometry, const FMotionEvent &InMotionEvent)

virtual SLATECORE_API TOptional< bool >	OnQueryShowFocus (const EFocusCause InFocusCause) const

virtual SLATECORE_API FPopupMethodReply	OnQueryPopupMethod () const

virtual SLATECORE_API TOptional< FVirtualPointerPosition >	TranslateMouseCoordinateForCustomHitTestChild (const SWidget &ChildWidget, const FGeometry &MyGeometry, const FVector2D ScreenSpaceMouseCoordinate, const FVector2D LastScreenSpaceMouseCoordinate) const

virtual SLATECORE_API void	OnFinishedPointerInput ()

virtual SLATECORE_API void	OnFinishedKeyInput ()

virtual SLATECORE_API FNavigationReply	OnNavigation (const FGeometry &MyGeometry, const FNavigationEvent &InNavigationEvent)

virtual SLATECORE_API EWindowZone::Type	GetWindowZoneOverride () const

bool	NeedsPrepass () const

SLATECORE_API void	SlatePrepass ()

SLATECORE_API void	SlatePrepass (float InLayoutScaleMultiplier)

void	SetCanTick (bool bInCanTick)

bool	GetCanTick () const

bool	HasRegisteredSlateAttribute () const

bool	IsAttributesUpdatesEnabled () const

const FSlateWidgetPersistentState &	GetPersistentState () const

const FWidgetProxyHandle	GetProxyHandle () const

SLATECORE_API UE::Slate::FDeprecateVector2DResult	GetDesiredSize () const

SLATECORE_API void	AssignParentWidget (TSharedPtr< SWidget > InParent)

SLATECORE_API bool	ConditionallyDetatchParentWidget (SWidget *InExpectedParent)

virtual bool	ValidatePathToChild (SWidget *InChild)

bool	IsParentValid () const

TSharedPtr< SWidget >	GetParentWidget () const

TSharedPtr< SWidget >	Advanced_GetPaintParentWidget () const

SLATECORE_API FSlateRect	CalculateCullingAndClippingRules (const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, bool &bClipToBounds, bool &bAlwaysClip, bool &bIntersectClipBounds) const

bool	HasAnyUpdateFlags (EWidgetUpdateFlags FlagsToCheck) const

TStatId	GetStatID (bool bForDeferredUse=false) const

virtual SLATECORE_API float	GetRelativeLayoutScale (const int32 ChildIndex, float LayoutScaleMultiplier) const

SLATECORE_API void	ArrangeChildren (const FGeometry &AllottedGeometry, FArrangedChildren &ArrangedChildren, bool bUpdateAttributes=false) const

virtual FChildren *	GetAllChildren ()

virtual SLATECORE_API bool	HasKeyboardFocus () const

SLATECORE_API TOptional< EFocusCause >	HasUserFocus (int32 UserIndex) const

SLATECORE_API TOptional< EFocusCause >	HasAnyUserFocus () const

SLATECORE_API bool	HasUserFocusedDescendants (int32 UserIndex) const

SLATECORE_API bool	HasFocusedDescendants () const

SLATECORE_API bool	HasAnyUserFocusOrFocusedDescendants () const

SLATECORE_API bool	HasMouseCapture () const

SLATECORE_API bool	HasMouseCaptureByUser (int32 UserIndex, TOptional< int32 > PointerIndex=TOptional< int32 >()) const

virtual SLATECORE_API void	OnMouseCaptureLost (const FCaptureLostEvent &CaptureLostEvent)

void	SetEnabled (TAttribute< bool > InEnabledState)

bool	IsEnabled () const

virtual bool	IsInteractable () const

virtual SLATECORE_API TSharedPtr< IToolTip >	GetToolTip ()

virtual SLATECORE_API void	OnToolTipClosing ()

SLATECORE_API void	EnableToolTipForceField (const bool bEnableForceField)

bool	HasToolTipForceField () const

bool	IsHovered () const

SLATECORE_API bool	IsDirectlyHovered () const

EVisibility	GetVisibility () const

bool	IsVolatile () const

bool	IsVolatileIndirectly () const

void	ForceVolatile (bool bForce)

bool	ShouldInvalidatePrepassDueToVolatility ()

SLATECORE_API void	Invalidate (EInvalidateWidgetReason InvalidateReason)

void	CacheVolatility ()

void	MarkPrepassAsDirty ()

float	GetRenderOpacity () const

void	SetRenderOpacity (float InRenderOpacity)

void	SetTag (FName InTag)

const TOptional< FSlateRenderTransform > &	GetRenderTransform () const

TOptional< FSlateRenderTransform >	GetRenderTransformWithRespectToFlowDirection () const

UE::Slate::FDeprecateVector2DResult	GetRenderTransformPivotWithRespectToFlowDirection () const

void	SetRenderTransform (TAttribute< TOptional< FSlateRenderTransform > > InTransform)

UE::Slate::FDeprecateVector2DResult	GetRenderTransformPivot () const

void	SetRenderTransformPivot (TAttribute< FVector2D > InTransformPivot)

SLATECORE_API void	SetClipping (EWidgetClipping InClipping)

EWidgetClipping	GetClipping () const

SLATECORE_API void	SetPixelSnapping (EWidgetPixelSnapping InPixelSnappingMethod)

EWidgetPixelSnapping	GetPixelSnapping () const

void	SetCullingBoundsExtension (const FMargin &InCullingBoundsExtension)

FMargin	GetCullingBoundsExtension () const

void	SetFlowDirectionPreference (EFlowDirectionPreference InFlowDirectionPreference)

EFlowDirectionPreference	GetFlowDirectionPreference () const

SLATECORE_API void	SetToolTipText (const TAttribute< FText > &ToolTipText)

SLATECORE_API void	SetToolTipText (const FText &InToolTipText)

SLATECORE_API void	SetToolTip (const TAttribute< TSharedPtr< IToolTip > > &InToolTip)

SLATECORE_API void	SetCursor (const TAttribute< TOptional< EMouseCursor::Type > > &InCursor)

template<typename MetaDataType >
TSharedPtr< MetaDataType >	GetMetaData () const

template<typename MetaDataType >
TArray< TSharedRef< MetaDataType > >	GetAllMetaData () const

template<typename MetaDataType >
void	AddMetadata (const TSharedRef< MetaDataType > &AddMe)

template<typename MetaDataType >
int32	RemoveMetaData (const TSharedRef< MetaDataType > &RemoveMe)

SLATECORE_API void	SetOnMouseButtonDown (FPointerEventHandler EventHandler)

SLATECORE_API void	SetOnMouseButtonUp (FPointerEventHandler EventHandler)

SLATECORE_API void	SetOnMouseMove (FPointerEventHandler EventHandler)

SLATECORE_API void	SetOnMouseDoubleClick (FPointerEventHandler EventHandler)

SLATECORE_API void	SetOnMouseEnter (FNoReplyPointerEventHandler EventHandler)

SLATECORE_API void	SetOnMouseLeave (FSimpleNoReplyPointerEventHandler EventHandler)

virtual SLATECORE_API FString	ToString () const

SLATECORE_API FString	GetTypeAsString () const

SLATECORE_API FName	GetType () const

virtual SLATECORE_API FString	GetReadableLocation () const

SLATECORE_API FName	GetCreatedInLocation () const

virtual SLATECORE_API FName	GetTag () const

virtual SLATECORE_API FSlateColor	GetDisabledForegroundColor () const

SLATECORE_API const FGeometry &	GetCachedGeometry () const

SLATECORE_API const FGeometry &	GetTickSpaceGeometry () const

SLATECORE_API const FGeometry &	GetPaintSpaceGeometry () const

const TOptional< FSlateClippingState > &	GetCurrentClippingState () const

virtual bool	Advanced_IsWindow () const

virtual bool	Advanced_IsInvalidationRoot () const

virtual const FSlateInvalidationRoot *	Advanced_AsInvalidationRoot () const

SLATECORE_API TSharedRef< FActiveTimerHandle >	RegisterActiveTimer (float TickPeriod, FWidgetActiveTimerDelegate TickFunction)

SLATECORE_API void	UnRegisterActiveTimer (const TSharedRef< FActiveTimerHandle > &ActiveTimerHandle)

bool	HasActiveTimers () const

Public Member Functions inherited from FSlateControlledConstruction
	FSlateControlledConstruction ()=default

virtual	~FSlateControlledConstruction ()=default

virtual const FSlateWidgetClassData &	GetWidgetClass () const =0

void	operator delete (void *mem)

Public Member Functions inherited from TSharedFromThis< SWidget >
TSharedRef< SWidget, Mode >	AsShared ()

TSharedRef< SWidget const, Mode >	AsShared () const

TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const

TWeakPtr< SWidget, Mode >	AsWeak ()

TWeakPtr< SWidget const, Mode >	AsWeak () const

TWeakPtr< SubobjectType, Mode >	AsWeakSubobject (SubobjectType *SubobjectPtr) const

void	UpdateWeakReferenceInternal (TSharedPtr< SharedPtrType, SharedPtrMode > const InSharedPtr, OtherType InObject) const

void	UpdateWeakReferenceInternal (TSharedRef< SharedRefType, SharedPtrMode > const InSharedRef, OtherType InObject) const

UE_FORCEINLINE_HINT bool	DoesSharedInstanceExist () const

Static Public Member Functions
static SLATE_API FReply	FocusNextWidget (EUINavigation NavigationType)

Static Public Member Functions inherited from FSlateControlledConstruction
static const FSlateWidgetClassData &	StaticWidgetClass ()

Additional Inherited Members
Protected Member Functions inherited from SCompoundWidget
virtual SLATECORE_API FVector2D	ComputeDesiredSize (float) const override

TSlateAttributeRef< FVector2D >	GetContentScaleAttribute () const

TSlateAttributeRef< FLinearColor >	GetColorAndOpacityAttribute () const

TSlateAttributeRef< FSlateColor >	GetForegroundColorAttribute () const

SLATECORE_API	SCompoundWidget ()

virtual SLATECORE_API	~SCompoundWidget ()

Protected Member Functions inherited from SWidget
void	SetVolatilePrepass (bool bVolatile)

virtual bool	CustomPrepass (float LayoutScaleMultiplier)

virtual SLATECORE_API void	CacheDesiredSize (float InLayoutScaleMultiplier)

void	SetHover (TAttribute< bool > InHovered)

bool	IsChildWidgetCulled (const FSlateRect &, const FArrangedWidget &) const

SLATECORE_API void	InvalidateChildRemovedFromTree (SWidget &Child)

bool	Advanced_InvalidateVolatility ()

EFlowDirection	ComputeFlowDirection () const

SLATECORE_API void	SetDebugInfo (const ANSICHAR InType, const ANSICHAR InFile, int32 OnLine, size_t InAllocSize)

virtual SLATECORE_API TOptional< EMouseCursor::Type >	GetCursor () const

SLATECORE_API	SWidget ()

SLATECORE_API void	SWidgetConstruct (const FSlateBaseNamedArgs &Args)

bool	IsConstructed () const

SLATECORE_API bool	FindChildGeometries (const FGeometry &MyGeometry, const TSet< TSharedRef< SWidget > > &WidgetsToFind, TMap< TSharedRef< SWidget >, FArrangedWidget > &OutResult) const

SLATECORE_API void	FindChildGeometries_Helper (const FGeometry &MyGeometry, const TSet< TSharedRef< SWidget > > &WidgetsToFind, TMap< TSharedRef< SWidget >, FArrangedWidget > &OutResult) const

SLATECORE_API FGeometry	FindChildGeometry (const FGeometry &MyGeometry, TSharedRef< SWidget > WidgetToFind) const

bool	ShouldBeEnabled (bool InParentEnabled) const

virtual SLATECORE_API const FSlateBrush *	GetFocusBrush () const

virtual bool	ComputeVolatility () const

virtual SLATECORE_API void	OnClippingChanged ()

float	GetPrepassLayoutScaleMultiplier () const

SLATECORE_API void	Prepass_ChildLoop (float InLayoutScaleMultiplier, FChildren *MyChildren)

template<typename TargetValueType , typename SourceValueType >
bool	SetAttribute (TAttribute< TargetValueType > &TargetValue, const TAttribute< SourceValueType > &SourceValue, EInvalidateWidgetReason BaseInvalidationReason)

TSlateAttributeRef< bool >	GetEnabledStateAttribute () const

TSlateAttributeRef< bool >	GetHoveredAttribute () const

TSlateAttributeRef< EVisibility >	GetVisibilityAttribute () const

TSlateAttributeRef< TOptional< FSlateRenderTransform > >	GetRenderTransformAttribute () const

TSlateAttributeRef< FVector2D >	GetRenderTransformPivotAttribute () const

virtual SLATECORE_API	~SWidget ()

Protected Member Functions inherited from TSharedFromThis< SWidget >
	TSharedFromThis ()

	TSharedFromThis (TSharedFromThis const &)

UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)

	~TSharedFromThis ()

Static Protected Member Functions inherited from SWidget
static SLATECORE_API int32	FindChildUnderMouse (const FArrangedChildren &Children, const FPointerEvent &MouseEvent)

static SLATECORE_API int32	FindChildUnderPosition (const FArrangedChildren &Children, const UE::Slate::FDeprecateVector2DParameter &ArrangedSpacePosition)

static TAttribute< EVisibility >	AccessWidgetVisibilityAttribute (const TSharedRef< SWidget > &Widget)

Static Protected Member Functions inherited from TSharedFromThis< SWidget >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)

static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Protected Attributes inherited from SMenuOwner
TWeakPtr< SMenuAnchor >	SummonedMenuAnchor

Protected Attributes inherited from SCompoundWidget
FCompoundWidgetOneChildSlot	ChildSlot

Protected Attributes inherited from SWidget
uint8	bCanSupportFocus: 1

uint8	bCanHaveChildren: 1

uint8	bClippingProxy: 1

uint8	bHasCustomPrepass: 1

uint8	bHasRelativeLayoutScale: 1

uint8	bVolatilityAlwaysInvalidatesPrepass: 1

EWidgetClipping	Clipping

EWidgetPixelSnapping	PixelSnappingMethod

FMargin	CullingBoundsExtension

float	RenderOpacity

Detailed Description

MultiBox Slate widget

Member Function Documentation

◆ AddElement()

void SMultiBoxWidget::AddElement	(	TSharedPtr< SWidget >	BlockWidget,
		FText	BlockDisplayText,
		bool	bInSearchable = `true`
	)

Adds a widget to MultiBoxWidgets map, to access and modify its visibility based on search filters

Parameters

BlockWidget	The widget to add
BlockDisplayText	The display text of the widget to search by
bSearchable	Whether the text is searchable

◆ AddSearchElement()

void SMultiBoxWidget::AddSearchElement	(	TSharedPtr< SWidget >	BlockWidget,
		FText	BlockDisplayText
	)

Adds a widget to SearchElement map, making the widget searchable

Parameters

BlockWidget	The widget to add
BlockDisplayText	The display text of the widget to search by

◆ BeginSearch()

void SMultiBoxWidget::BeginSearch ( const TCHAR InChar )

Starts a search and makes the search box visible

Parameters

InChar The first character typed in

◆ BuildMultiBoxWidget()

void SMultiBoxWidget::BuildMultiBoxWidget ( )

Builds this MultiBox widget up from the MultiBox associated with it

The current row of buttons for if the multibox type is a button row

◆ Construct()

void SMultiBoxWidget::Construct ( const FArguments & InArgs )

Content scaling factor Construct this widget

Parameters

InArgs The declaration data for this widget

◆ FilterMultiBoxEntries()

void SMultiBoxWidget::FilterMultiBoxEntries ( )

Changes visibility of widgets in the multibox

◆ FocusNextWidget()

FReply SMultiBoxWidget::FocusNextWidget ( EUINavigation NavigationType )

static

Helper function used to transfer focus to the next/previous widget

◆ GenerateTiles()

TSharedRef< ITableRow > SMultiBoxWidget::GenerateTiles	(	TSharedPtr< SWidget >	Item,
		const TSharedRef< STableViewBase > &	OwnerTable
	)

Generates the tiles for an STileView for button rows

◆ GetCustomizationBorderDragVisibility()

EVisibility SMultiBoxWidget::GetCustomizationBorderDragVisibility	(	const FName	InBlockName,
		const EMultiBlockType	InBlockType,
		bool &	bOutInsertAfter
	)		const

Returns: The visibility of the drop location indicator of a drag and drop for a block

◆ GetCustomizationVisibility()

EVisibility SMultiBoxWidget::GetCustomizationVisibility	(	TWeakPtr< const FMultiBlock >	BlockWeakPtr,
		TWeakPtr< SWidget >	BlockWidgetWeakPtr
	)		const

Returns: The visibility of customization widgets for a block

◆ GetItemHeight()

float SMultiBoxWidget::GetItemHeight ( ) const

◆ GetItemWidth()

float SMultiBoxWidget::GetItemWidth ( ) const

Gets the maximum item width and height of the consituent widgets

◆ GetLinkedBoxManager()

TSharedRef< FLinkedBoxManager > SMultiBoxWidget::GetLinkedBoxManager ( )

inline

Returns: the the LinkedBoxManager

◆ GetMultiBox()

TSharedRef< const FMultiBox > SMultiBoxWidget::GetMultiBox ( ) const

inline

Access the MultiBox associated with this widget

◆ GetSearchable()

bool SMultiBoxWidget::GetSearchable ( ) const

Gets the searchable state of this multibox

Returns: Whether this block is searchable

◆ GetSearchText()

FText SMultiBoxWidget::GetSearchText ( ) const

Get the text to search by

Returns: The text currently being searched

◆ GetSearchTextWidget()

TSharedPtr< SWidget > SMultiBoxWidget::GetSearchTextWidget ( )

Get the SSearchText widget holding the search text

Returns: The widget to get

◆ GetStyleName()

const FName & SMultiBoxWidget::GetStyleName ( ) const

inline

◆ GetStyleSet()

const ISlateStyle * SMultiBoxWidget::GetStyleSet ( ) const

inline

◆ GetSummonedMenuTime()

double SMultiBoxWidget::GetSummonedMenuTime ( ) const

Returns: The last recorded time that the multibox summoned a menu

◆ IsBlockBeingDragged()

bool SMultiBoxWidget::IsBlockBeingDragged ( TSharedPtr< const FMultiBlock > Block ) const

Returns: True if the passed in block is being dragged

◆ OnCustomCommandDragEnter()

void SMultiBoxWidget::OnCustomCommandDragEnter	(	TSharedRef< const FMultiBlock >	MultiBlock,
		const FGeometry &	MyGeometry,
		const FDragDropEvent &	DragDropEvent
	)

Called when a user drags a UI command into a multiblock in this widget

◆ OnCustomCommandDragged()

void SMultiBoxWidget::OnCustomCommandDragged	(	TSharedRef< const FMultiBlock >	MultiBlock,
		const FGeometry &	MyGeometry,
		const FDragDropEvent &	DragDropEvent
	)

Called when a user drags a UI command within multiblock in this widget

◆ OnCustomCommandDropped()

void SMultiBoxWidget::OnCustomCommandDropped ( )

Called when a user drops a UI command in this widget

◆ OnDragOver()

FReply SMultiBoxWidget::OnDragOver	(	const FGeometry &	MyGeometry,
		const FDragDropEvent &	DragDropEvent
	)

overridevirtual

SWidget interface

Reimplemented from SWidget.

◆ OnDrop()

FReply SMultiBoxWidget::OnDrop	(	const FGeometry &	MyGeometry,
		const FDragDropEvent &	DragDropEvent
	)

overridevirtual

Called when the user is dropping something onto a widget; terminates drag and drop.

Parameters

MyGeometry	The geometry of the widget receiving the event.
DragDropEvent	The drag and drop event.

Returns: A reply that indicated whether this event was handled.

Reimplemented from SWidget.

◆ OnDropExternal()

void SMultiBoxWidget::OnDropExternal ( )

Called after a drag was initiated from this box but was dropped elsewhere

◆ OnFocusChanging()

void SMultiBoxWidget::OnFocusChanging	(	const FWeakWidgetPath &	PreviousFocusPath,
		const FWidgetPath &	NewWidgetPath,
		const FFocusEvent &	InFocusEvent
	)

overridevirtual

Called whenever a focus path is changing on all the widgets within the old and new focus paths

Reimplemented from SWidget.

◆ OnFocusReceived()

FReply SMultiBoxWidget::OnFocusReceived	(	const FGeometry &	MyGeometry,
		const FFocusEvent &	InFocusEvent
	)

overridevirtual

Called when focus is given to this widget. This event does not bubble.

Parameters

MyGeometry	The Geometry of the widget receiving the event
InFocusEvent	The FocusEvent

Returns: Returns whether the event was handled, along with other possible actions

Reimplemented from SWidget.

◆ OnKeyChar()

FReply SMultiBoxWidget::OnKeyChar	(	const FGeometry &	MyGeometry,
		const FCharacterEvent &	InCharacterEvent
	)

overridevirtual

Called after a character is entered while this widget has keyboard focus

Parameters

MyGeometry	The Geometry of the widget receiving the event
InCharacterEvent	Character event

Returns: Returns whether the event was handled, along with other possible actions

Reimplemented from SWidget.

◆ OnKeyDown()

FReply SMultiBoxWidget::OnKeyDown	(	const FGeometry &	MyGeometry,
		const FKeyEvent &	InKeyEvent
	)

overridevirtual

Called after a key is pressed when this widget has focus (this event bubbles if not handled)

Parameters

MyGeometry	The Geometry of the widget receiving the event
InKeyEvent	Key event

Returns: Returns whether the event was handled, along with other possible actions

Reimplemented from SWidget.

◆ OnVisualizeTooltip()

bool SMultiBoxWidget::OnVisualizeTooltip ( const TSharedPtr< SWidget > & TooltipContent )

overridevirtual

Called when Slate wants to visualize tooltip. If nobody handles this event, Slate will use default tooltip visualization. If you override this event, you should probably return true.

Parameters

TooltipContent The TooltipContent that I may want to visualize.

Returns: true if this widget visualized the tooltip content; i.e., the event is handled.

Reimplemented from SWidget.

◆ OnWrapButtonClicked()

TSharedRef< SWidget > SMultiBoxWidget::OnWrapButtonClicked ( )

Event handler for clicking the wrap button

◆ ResetSearch()

void SMultiBoxWidget::ResetSearch ( )

Resets the search to be empty

◆ SetContent()

void SMultiBoxWidget::SetContent ( TSharedRef< SWidget > InContent )

inline

Sets new content for the SMultiBoxWidget

Parameters

InContent The new content to place in the ChildSlot

◆ SetMaxHeight()

void SMultiBoxWidget::SetMaxHeight ( TAttribute< float > InMaxHeight )

inline

Sets optional maximum height of widget

◆ SetMultiBox()

void SMultiBoxWidget::SetMultiBox ( TSharedRef< FMultiBox > InMultiBox )

inline

Associates this widget with a MultiBox

Parameters

InMultiBox The MultiBox we'll be associated with

◆ SetSearchable()

void SMultiBoxWidget::SetSearchable ( bool bSearchable )

Sets the searchable state of this multibox

Parameters

bSearchable The searchable state to set

◆ SetSearchBlockWidget()

void SMultiBoxWidget::SetSearchBlockWidget ( TSharedPtr< SWidget > InWidget )

Set the block widget holding the search text

Parameters

BlockWidget The widget to set

◆ SetSummonedMenuTime()

void SMultiBoxWidget::SetSummonedMenuTime ( double InSummonedMenuTime )

Records the time that the multibox last summoned a menu

◆ ShouldShowMenuSearchField()

bool SMultiBoxWidget::ShouldShowMenuSearchField ( ) const

◆ SLATE_BEGIN_ARGS()

SMultiBoxWidget::SLATE_BEGIN_ARGS ( SMultiBoxWidget )

inline

◆ SupportsKeyboardFocus()

bool SMultiBoxWidget::SupportsKeyboardFocus ( ) const

overridevirtual

Checks to see if this widget supports keyboard focus. Override this in derived classes.

Returns: True if this widget can take keyboard focus

Reimplemented from SWidget.

◆ UpdateMultiBoxWidget()

void SMultiBoxWidget::UpdateMultiBoxWidget ( TSharedRef< FMultiBox > InMultiBox )

Rebuilds this MultiBox widget using the input MultiBox

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

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

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AddElement()

◆ AddSearchElement()

◆ BeginSearch()

◆ BuildMultiBoxWidget()

◆ Construct()

◆ FilterMultiBoxEntries()

◆ FocusNextWidget()

◆ GenerateTiles()

◆ GetCustomizationBorderDragVisibility()

◆ GetCustomizationVisibility()

◆ GetItemHeight()

◆ GetItemWidth()

◆ GetLinkedBoxManager()

◆ GetMultiBox()

◆ GetSearchable()

◆ GetSearchText()

◆ GetSearchTextWidget()

◆ GetStyleName()

◆ GetStyleSet()

◆ GetSummonedMenuTime()

◆ IsBlockBeingDragged()

◆ OnCustomCommandDragEnter()

◆ OnCustomCommandDragged()

◆ OnCustomCommandDropped()

◆ OnDragOver()

◆ OnDrop()

◆ OnDropExternal()

◆ OnFocusChanging()

◆ OnFocusReceived()

◆ OnKeyChar()

◆ OnKeyDown()

◆ OnVisualizeTooltip()

◆ OnWrapButtonClicked()

◆ ResetSearch()

◆ SetContent()

◆ SetMaxHeight()

◆ SetMultiBox()

◆ SetSearchable()

◆ SetSearchBlockWidget()

◆ SetSummonedMenuTime()

◆ ShouldShowMenuSearchField()

◆ SLATE_BEGIN_ARGS()

◆ SupportsKeyboardFocus()

◆ UpdateMultiBoxWidget()