UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
IMultiBlockBaseWidget Class Referenceabstract

#include <MultiBox.h>

+ Inheritance diagram for IMultiBlockBaseWidget:

Public Member Functions

virtual TSharedRef< SWidgetAsWidget ()=0
 
virtual TSharedRef< const SWidgetAsWidget () const =0
 
virtual void SetOwnerMultiBoxWidget (TSharedRef< SMultiBoxWidget > InOwnerMultiBoxWidget)=0
 
virtual void SetMultiBlock (TSharedRef< const FMultiBlock > InMultiBlock)=0
 
virtual void SetOptionsBlockWidget (TSharedPtr< SWidget > InOptionsBlockWidget)=0
 
virtual void BuildMultiBlockWidget (const ISlateStyle *StyleSet, const FName &StyleName)=0
 
virtual void SetMultiBlockLocation (EMultiBlockLocation::Type InLocation, bool bSectionContainsIcons)=0
 
virtual EMultiBlockLocation::Type GetMultiBlockLocation ()=0
 
virtual EMultiBlockLocation::Type GetMultiBlockLocation () const =0
 
virtual bool IsInEditMode () const =0
 

Detailed Description

MultiBlock Slate widget interface

Member Function Documentation

◆ AsWidget() [1/2]

virtual TSharedRef< const SWidget > IMultiBlockBaseWidget::AsWidget ( ) const
pure virtual

Interprets this object as a SWidget

Returns
Widget reference

Implemented in SMultiBlockBaseWidget.

◆ AsWidget() [2/2]

virtual TSharedRef< SWidget > IMultiBlockBaseWidget::AsWidget ( )
pure virtual

Interprets this object as a SWidget

Returns
Widget reference

Implemented in SMultiBlockBaseWidget.

◆ BuildMultiBlockWidget()

virtual void IMultiBlockBaseWidget::BuildMultiBlockWidget ( const ISlateStyle StyleSet,
const FName StyleName 
)
pure virtual

Builds this MultiBlock widget up from the MultiBlock associated with it

Parameters
StyleSetThe Slate style to use to build the widget
StyleNameThe style name to use from the StyleSet

Implemented in SCustomToolbarPreviewWidget, SButtonRowBlock, SEditableTextBlock, SGroupMarkerBlock, SHeadingBlock, SMenuEntryBlock, SMenuSeparatorBlock, SMenuSpacerBlock, SToolBarSeparatorBlock, SWidgetBlock, SToolBarButtonBlock, SToolBarComboButtonBlock, and SToolBarStackButtonBlock.

◆ GetMultiBlockLocation() [1/2]

virtual EMultiBlockLocation::Type IMultiBlockBaseWidget::GetMultiBlockLocation ( ) const
pure virtual

Returns this MultiBlocks location

Implemented in SMultiBlockBaseWidget.

◆ GetMultiBlockLocation() [2/2]

virtual EMultiBlockLocation::Type IMultiBlockBaseWidget::GetMultiBlockLocation ( )
pure virtual

Returns this MultiBlocks location

Implemented in SMultiBlockBaseWidget.

◆ IsInEditMode()

virtual bool IMultiBlockBaseWidget::IsInEditMode ( ) const
pure virtual

Returns true if editing this widget

Implemented in SMultiBlockBaseWidget.

◆ SetMultiBlock()

virtual void IMultiBlockBaseWidget::SetMultiBlock ( TSharedRef< const FMultiBlock InMultiBlock)
pure virtual

Associates this widget with a MultiBlock

Parameters
InMultiBlockThe MultiBlock we'll be associated with

Implemented in SMultiBlockBaseWidget.

◆ SetMultiBlockLocation()

virtual void IMultiBlockBaseWidget::SetMultiBlockLocation ( EMultiBlockLocation::Type  InLocation,
bool  bSectionContainsIcons 
)
pure virtual

Sets the blocks location relative to the other blocks

Parameters
InLocationThe MultiBlocks location
bSectionContainsIconsDoes the section contain icons?

Implemented in SMultiBlockBaseWidget.

◆ SetOptionsBlockWidget()

virtual void IMultiBlockBaseWidget::SetOptionsBlockWidget ( TSharedPtr< SWidget InOptionsBlockWidget)
pure virtual

Adds a dropdown widget for options associated with this widget. The usage of this is block specific

Parameters
InOptionsBlockWidgetThe options block to associate with this widget

Implemented in SMultiBlockBaseWidget.

◆ SetOwnerMultiBoxWidget()

virtual void IMultiBlockBaseWidget::SetOwnerMultiBoxWidget ( TSharedRef< SMultiBoxWidget InOwnerMultiBoxWidget)
pure virtual

Associates the owner MultiBox widget with this widget

Parameters
InOwnerMultiBoxWidgetThe MultiBox widget that owns us

Implemented in SMultiBlockBaseWidget.


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