FMultiBlock Class Reference

#include <MultiBox.h>

Inheritance diagram for FMultiBlock:

Classes
struct	FMultiBlockParams

Public Member Functions
	FMultiBlock (const TSharedPtr< const FUICommandInfo > InCommand, TSharedPtr< const FUICommandList > InCommandList, FName InExtensionHook=NAME_None, EMultiBlockType InType=EMultiBlockType::None, bool bInIsPartOfHeading=false)
	FMultiBlock (const FUIAction &InAction, FName InExtensionHook=NAME_None, EMultiBlockType InType=EMultiBlockType::None, bool bInIsPartOfHeading=false, TSharedPtr< const FUICommandList > InCommandList=nullptr)
	FMultiBlock (const FMultiBlockParams &InMultiBlockParams)
virtual	~FMultiBlock ()
TSharedPtr< const FUICommandList >	GetActionList () const
TSharedPtr< const FUICommandInfo >	GetAction () const
const FUIAction &	GetDirectActions () const
virtual void	CreateMenuEntry (class FMenuBuilder &MenuBuilder) const
virtual bool	IsGroupStartBlock () const
virtual bool	IsGroupEndBlock () const
virtual bool	HasIcon () const
void	SetTutorialHighlightName (FName InTutorialName)
FName	GetTutorialHighlightName () const
void	SetStyleNameOverride (FName InStyleNameOverride)
FName	GetStyleNameOverride () const
SLATE_API TSharedRef< class IMultiBlockBaseWidget >	MakeWidget (TSharedRef< class SMultiBoxWidget > InOwnerMultiBoxWidget, EMultiBlockLocation::Type InLocation, bool bSectionContainsIcons, TSharedPtr< SWidget > OptionsBlockWidget) const
const EMultiBlockType	GetType () const
bool	IsSeparator () const
bool	IsPartOfHeading () const
SLATE_API void	SetSearchable (bool bSearchable)
SLATE_API bool	GetSearchable () const
FName	GetExtensionHook () const
TAttribute< EVisibility >	GetVisibilityOverride () const
void	SetVisibilityOverride (TAttribute< EVisibility > InVisibilityOverride)
const TAttribute< FMenuEntryResizeParams > &	GetResizeParams () const
void	SetResizeParams (const TAttribute< FMenuEntryResizeParams > &InResizeParams)
Public Member Functions inherited from TSharedFromThis< FMultiBlock >
TSharedRef< FMultiBlock, Mode >	AsShared ()
TSharedRef< FMultiBlock const, Mode >	AsShared () const
TSharedRef< SubobjectType, Mode >	AsSharedSubobject (SubobjectType *SubobjectPtr) const
TWeakPtr< FMultiBlock, Mode >	AsWeak ()
TWeakPtr< FMultiBlock 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

Friends
class	SMultiBoxWidget

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

Detailed Description

MultiBlock (abstract). Wraps a "block" of useful UI functionality that can be added to a MultiBox.

Constructor & Destructor Documentation

FMultiBlock() [1/3]

FMultiBlock::FMultiBlock ( const TSharedPtr< const FUICommandInfo >  InCommand, TSharedPtr< const FUICommandList >  InCommandList, FName  InExtensionHook = NAME_None, EMultiBlockType  InType = EMultiBlockType::None, bool  bInIsPartOfHeading = false  )

inline

Constructor

Parameters

InCommand	The command info that describes what action to take when this block is activated
InCommandList	The list of mappings from command info to delegates so we can find the delegates to process for the provided action

FMultiBlock() [2/3]

FMultiBlock::FMultiBlock ( const FUIAction &  InAction, FName  InExtensionHook = NAME_None, EMultiBlockType  InType = EMultiBlockType::None, bool  bInIsPartOfHeading = false, TSharedPtr< const FUICommandList >  InCommandList = nullptr  )

inline

Constructor

Parameters

InAction

UI action delegates that should be used in place of UI commands (dynamic menu items)

FMultiBlock() [3/3]

FMultiBlock::FMultiBlock ( const FMultiBlockParams &  InMultiBlockParams )

inline

Constructor

Parameters

InMultiBlockParams

Bundle of params for construction

~FMultiBlock()

virtual FMultiBlock::~FMultiBlock ( )

inlinevirtual

Member Function Documentation

CreateMenuEntry()

virtual void FMultiBlock::CreateMenuEntry ( class FMenuBuilder &  MenuBuilder ) const

inlinevirtual

Creates a menu entry that is representative of this block

Reimplemented in FMenuEntryBlock, FToolBarSeparatorBlock, FWidgetBlock, FToolBarButtonBlock, FToolBarComboButtonBlock, and FToolBarStackButtonBlock.

GetAction()

TSharedPtr< const FUICommandInfo > FMultiBlock::GetAction ( ) const

inline

Returns the action associated with this block

Returns

The action for this block or null if one does not exist

GetActionList()

TSharedPtr< const FUICommandList > FMultiBlock::GetActionList ( ) const

inline

Returns the action list associated with this block

Returns

The action list or null if one does not exist for this block

GetDirectActions()

const FUIAction & FMultiBlock::GetDirectActions ( ) const

inline

Returns the direct actions for this block. Delegates may be unbound if this block has a UICommand

Returns

DirectActions for this block

GetExtensionHook()

FName FMultiBlock::GetExtensionHook ( ) const

inline

Gets the extension hook so users can see what hooks are where

GetResizeParams()

const TAttribute< FMenuEntryResizeParams > & FMultiBlock::GetResizeParams

(

)

const

Get the resize parameters which determine how this block behaves during toolbar resizing.

GetSearchable()

bool FMultiBlock::GetSearchable

(

)

const

Gets the searchable state of this block

Returns

Whether this block is searchable

GetStyleNameOverride()

FName FMultiBlock::GetStyleNameOverride ( ) const

inline

Gets the style name which will be used for this block instead of the owning multibox's style

GetTutorialHighlightName()

FName FMultiBlock::GetTutorialHighlightName ( ) const

inline

Get the tutorial highlight name for this menu entry

GetType()

const EMultiBlockType FMultiBlock::GetType ( ) const

inline

Gets the type of this MultiBox

Returns

The MultiBlock's type

GetVisibilityOverride()

TAttribute< EVisibility > FMultiBlock::GetVisibilityOverride

(

)

const

Get the visibility override for this block.

HasIcon()

virtual bool FMultiBlock::HasIcon ( ) const

inlinevirtual

Reimplemented in FDropPreviewBlock, FButtonRowBlock, FEditableTextBlock, FMenuEntryBlock, FToolBarButtonBlock, and FToolBarComboButtonBlock.

IsGroupEndBlock()

virtual bool FMultiBlock::IsGroupEndBlock ( ) const

inlinevirtual

Reimplemented in FGroupEndBlock.

IsGroupStartBlock()

virtual bool FMultiBlock::IsGroupStartBlock ( ) const

inlinevirtual

Group blocks interface

Reimplemented in FGroupStartBlock.

IsPartOfHeading()

bool FMultiBlock::IsPartOfHeading ( ) const

inline

Is this block a heading block or a block that belongs to a heading such as a separator

Returns

True if block is part of a section heading's blocks

IsSeparator()

bool FMultiBlock::IsSeparator ( ) const

inline

Is this block a separator

Returns

True if block is a separator

MakeWidget()

TSharedRef< IMultiBlockBaseWidget > FMultiBlock::MakeWidget	(	TSharedRef< class SMultiBoxWidget >	InOwnerMultiBoxWidget,
		EMultiBlockLocation::Type	InLocation,
		bool	bSectionContainsIcons,
		TSharedPtr< SWidget >	OptionsBlockWidget
	)		const

Creates a MultiBlock widget for this MultiBlock

Parameters

InOwnerMultiBoxWidget	The widget that will own the new MultiBlock widget
InLocation	The location information for the MultiBlock widget

Returns

MultiBlock widget object

SetResizeParams()

void FMultiBlock::SetResizeParams

(

const TAttribute< FMenuEntryResizeParams > &

InResizeParams

)

Set the resize parameters which determine how this block behaves during toolbar resizing.

SetSearchable()

void FMultiBlock::SetSearchable

(

bool

bSearchable

)

Sets the searchable state of this block

Parameters

bSearchable

The searchable state to set

SetStyleNameOverride()

void FMultiBlock::SetStyleNameOverride ( FName  InStyleNameOverride )

inline

Sets the style name which will be used for this block instead of the owning multibox's style

SetTutorialHighlightName()

void FMultiBlock::SetTutorialHighlightName ( FName  InTutorialName )

inline

Set the tutorial highlight name for this menu entry

SetVisibilityOverride()

void FMultiBlock::SetVisibilityOverride

(

TAttribute< EVisibility >

InVisibilityOverride

)

Set the visibility override for this block.

Friends And Related Symbol Documentation

SMultiBoxWidget

friend class SMultiBoxWidget

friend

---

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