FMultiBox Class Reference

#include <MultiBox.h>

Inheritance diagram for FMultiBox:

Public Member Functions
virtual SLATE_API	~FMultiBox ()
const EMultiBoxType	GetType () const
bool	ShouldCloseWindowAfterMenuSelection () const
int32	GetLastSelectedCommandIndex () const
void	SetLastSelectedCommandIndex (int32 LastSelectedCommandIndex)
SLATE_API void	AddMultiBlock (TSharedRef< const FMultiBlock > InBlock)
SLATE_API void	AddMultiBlockToFront (TSharedRef< const FMultiBlock > InBlock)
SLATE_API void	RemoveCustomMultiBlock (TSharedRef< const FMultiBlock > InBlock)
SLATE_API void	InsertCustomMultiBlock (TSharedRef< const FMultiBlock > InBlock, int32 Index)
	DECLARE_DELEGATE_TwoParams (FOnMakeMultiBoxBuilderOverride, const TSharedRef< FMultiBox > &, const TSharedRef< SMultiBoxWidget > &)
	DECLARE_DELEGATE_RetVal_ThreeParams (TSharedRef< SWidget >, FOnModifyBlockWidgetAfterMake, const TSharedRef< SMultiBoxWidget > &, const FMultiBlock &, const TSharedRef< SWidget > &)
SLATE_API TSharedRef< class SMultiBoxWidget >	MakeWidget (bool bSearchable, FOnMakeMultiBoxBuilderOverride *InMakeMultiBoxBuilderOverride=nullptr, TAttribute< float > InMaxHeight=TAttribute< float >())
const TArray< TSharedRef< const FMultiBlock > > &	GetBlocks () const
const ISlateStyle *	GetStyleSet () const
const FName &	GetStyleName () const
void	SetStyle (const ISlateStyle *InStyleSet, const FName &InStyleName)
SLATE_API FName	GetCustomizationName () const
SLATE_API TSharedPtr< FMultiBlock >	MakeMultiBlockFromCommand (TSharedPtr< const FUICommandInfo > Command, bool bCommandMustBeBound) const
SLATE_API TSharedPtr< const FMultiBlock >	FindBlockFromNameAndType (const FName InName, const EMultiBlockType InType) const
SLATE_API bool	IsInEditMode () const
SLATE_API UToolMenuBase *	GetToolMenu () const
SLATE_API int32	GetSectionEditBounds (const int32 Index, int32 &OutSectionEndIndex) const
	DECLARE_DELEGATE_OneParam (FEditSelectionChangedDelegate, TSharedRef< const FMultiBlock >)
const FEditSelectionChangedDelegate &	OnEditSelectionChanged () const
FEditSelectionChangedDelegate &	OnEditSelectionChanged ()
const TSharedPtr< const FUICommandList >	GetLastCommandList () const
Public Member Functions inherited from TSharedFromThis< FMultiBox >
TSharedRef< FMultiBox, Mode >	AsShared ()
TSharedRef< FMultiBox const, Mode >	AsShared () const
TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const
TWeakPtr< FMultiBox, Mode >	AsWeak ()
TWeakPtr< FMultiBox 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 TSharedRef< FMultiBox >	Create (const EMultiBoxType InType, FMultiBoxCustomization InCustomization, const bool bInShouldCloseWindowAfterMenuSelection)

Public Attributes
FOnModifyBlockWidgetAfterMake	ModifyBlockWidgetAfterMake
TWeakObjectPtr< UToolMenuBase >	WeakToolMenu
bool	bHasSearchWidget
bool	bIsFocusable
TOptional< bool >	bAllowWrapButton

Additional Inherited Members
Protected Member Functions inherited from TSharedFromThis< FMultiBox >
	TSharedFromThis ()
	TSharedFromThis (TSharedFromThis const &)
UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)
	~TSharedFromThis ()
Static Protected Member Functions inherited from TSharedFromThis< FMultiBox >
static UE_FORCEINLINE_HINT TSharedRef< OtherType, Mode >	SharedThis (OtherType *ThisPtr)
static UE_FORCEINLINE_HINT TSharedRef< OtherType const, Mode >	SharedThis (const OtherType *ThisPtr)

Detailed Description

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

Constructor & Destructor Documentation

~FMultiBox()

FMultiBox::~FMultiBox ( )

virtual

Member Function Documentation

AddMultiBlock()

void FMultiBox::AddMultiBlock

(

TSharedRef< const FMultiBlock >

InBlock

)

Adds a MultiBlock to this MultiBox, to the end of the list

AddMultiBlockToFront()

void FMultiBox::AddMultiBlockToFront

(

TSharedRef< const FMultiBlock >

InBlock

)

Adds a MultiBlock to this MultiBox, to the front of the list

Create()

TSharedRef< FMultiBox > FMultiBox::Create ( const EMultiBoxType  InType, FMultiBoxCustomization  InCustomization, const bool  bInShouldCloseWindowAfterMenuSelection  )

static

Creates a new multibox instance

DECLARE_DELEGATE_OneParam()

FMultiBox::DECLARE_DELEGATE_OneParam	(	FEditSelectionChangedDelegate	,
		TSharedRef< const FMultiBlock >
	)

DECLARE_DELEGATE_RetVal_ThreeParams()

FMultiBox::DECLARE_DELEGATE_RetVal_ThreeParams	(	TSharedRef< SWidget >	,
		FOnModifyBlockWidgetAfterMake	,
		const TSharedRef< SMultiBoxWidget > &	,
		const FMultiBlock &	,
		const TSharedRef< SWidget > &
	)

DECLARE_DELEGATE_TwoParams()

FMultiBox::DECLARE_DELEGATE_TwoParams	(	FOnMakeMultiBoxBuilderOverride	,
		const TSharedRef< FMultiBox > &	,
		const TSharedRef< SMultiBoxWidget > &
	)

FindBlockFromNameAndType()

TSharedPtr< const FMultiBlock > FMultiBox::FindBlockFromNameAndType	(	const FName	InName,
		const EMultiBlockType	InType
	)		const

Finds an existing block by name and type

Parameters

InName	The name to search for
InType	The type to match during the search

GetBlocks()

const TArray< TSharedRef< const FMultiBlock > > & FMultiBox::GetBlocks ( ) const

inline

Access this MultiBox's list of blocks

Returns

Our list of MultiBlocks

GetCustomizationName()

FName FMultiBox::GetCustomizationName

(

)

const

Returns

The customization name for this box

GetLastCommandList()

const TSharedPtr< const FUICommandList > FMultiBox::GetLastCommandList ( ) const

inline

GetLastSelectedCommandIndex()

int32 FMultiBox::GetLastSelectedCommandIndex

(

)

const

returns the index of the item which was last selected in this box

GetSectionEditBounds()

int32 FMultiBox::GetSectionEditBounds	(	const int32	Index,
		int32 &	OutSectionEndIndex
	)		const

Only callable during edit mode

Returns

Index of section heading or separator

GetStyleName()

const FName & FMultiBox::GetStyleName ( ) const

inline

Returns

The style name used by the multibox widgets

GetStyleSet()

const ISlateStyle * FMultiBox::GetStyleSet ( ) const

inline

Returns

The style set used by the multibox widgets

GetToolMenu()

UToolMenuBase * FMultiBox::GetToolMenu

(

)

const

Returns

The tool menu associated with this multi box

GetType()

const EMultiBoxType FMultiBox::GetType ( ) const

inline

Gets the type of this MultiBox

Returns

The MultiBox's type

InsertCustomMultiBlock()

void FMultiBox::InsertCustomMultiBlock	(	TSharedRef< const FMultiBlock >	InBlock,
		int32	Index
	)

Inserts a MultiBlock to the list for user customization

IsInEditMode()

bool FMultiBox::IsInEditMode

(

)

const

Returns

Is being editing

MakeMultiBlockFromCommand()

TSharedPtr< FMultiBlock > FMultiBox::MakeMultiBlockFromCommand	(	TSharedPtr< const FUICommandInfo >	Command,
		bool	bCommandMustBeBound
	)		const

Creates a block from the provided command that is compatible with this box

Parameters

Command

The UI command to create the block from

Returns

The created multi block. If null, this command could not be placed in this block

MakeWidget()

TSharedRef< SMultiBoxWidget > FMultiBox::MakeWidget	(	bool	bSearchable,
		FOnMakeMultiBoxBuilderOverride *	InMakeMultiBoxBuilderOverride = nullptr,
		TAttribute< float >	InMaxHeight = TAttribute<float>()
	)

Creates a MultiBox widget for this MultiBox

Returns

MultiBox widget object

OnEditSelectionChanged() [1/2]

FEditSelectionChangedDelegate & FMultiBox::OnEditSelectionChanged ( )

inline

Delegate to call while editing when selected block has changed

OnEditSelectionChanged() [2/2]

const FEditSelectionChangedDelegate & FMultiBox::OnEditSelectionChanged ( ) const

inline

Delegate to call while editing when selected block has changed

RemoveCustomMultiBlock()

void FMultiBox::RemoveCustomMultiBlock

(

TSharedRef< const FMultiBlock >

InBlock

)

Removes a MultiBlock from the list for user customization

SetLastSelectedCommandIndex()

void FMultiBox::SetLastSelectedCommandIndex

(

int32

LastSelectedCommandIndex

)

sets the index of the item which was last selected in this box

Parameters

LastSelectedCommandIndex

the index of the last command that was selected for this box

SetStyle()

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

inline

Sets the style to use on the multibox widgets

ShouldCloseWindowAfterMenuSelection()

bool FMultiBox::ShouldCloseWindowAfterMenuSelection ( ) const

inline

Gets whether or not the window that contains this multibox should be destroyed after the user clicks on a menu item in this box

Returns

True if window should be closed automatically when the user clicks on a menu item, otherwise false

Member Data Documentation

bAllowWrapButton

TOptional<bool> FMultiBox::bAllowWrapButton

Whether the WrapButton/Overflow can be shown (if applicable). Defaults to the style.

bHasSearchWidget

bool FMultiBox::bHasSearchWidget

bIsFocusable

bool FMultiBox::bIsFocusable

Whether the MultiBox can be focused.

ModifyBlockWidgetAfterMake

FOnModifyBlockWidgetAfterMake FMultiBox::ModifyBlockWidgetAfterMake

Allow further modifications to the block's widget after it has been made

WeakToolMenu

TWeakObjectPtr<UToolMenuBase> FMultiBox::WeakToolMenu

Weak reference to tool menu that created this 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