FToolBarComboButtonBlock Class Reference

#include <SToolBarComboButtonBlock.h>

Inheritance diagram for FToolBarComboButtonBlock:

Public Member Functions
	FToolBarComboButtonBlock (const FUIAction &InAction, const FOnGetContent &InMenuContentGenerator, const TAttribute< FText > &InLabel=TAttribute< FText >(), const TAttribute< FText > &InToolTip=TAttribute< FText >(), const TAttribute< FSlateIcon > &InIcon=TAttribute< FSlateIcon >(), bool bInSimpleComboBox=false, TAttribute< FText > InToolbarLabelOverride=TAttribute< FText >(), TAttribute< EMenuPlacement > InPlacementOverride=MenuPlacement_ComboBox, const EUserInterfaceActionType InUserInterfaceActionType=EUserInterfaceActionType::Button)
virtual void	CreateMenuEntry (class FMenuBuilder &MenuBuilder) const override
virtual bool	HasIcon () const override
void	SetLabelVisibility (EVisibility InLabelVisibility)
void	SetForceSmallIcons (const bool InForceSmallIcons)
bool	IsSimpleComboBox () const
Public Member Functions inherited from FMultiBlock
	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 bool	IsGroupStartBlock () const
virtual bool	IsGroupEndBlock () 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	SToolBarComboButtonBlock

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

Tool bar combo button MultiBlock

Constructor & Destructor Documentation

FToolBarComboButtonBlock()

FToolBarComboButtonBlock::FToolBarComboButtonBlock	(	const FUIAction &	InAction,
		const FOnGetContent &	InMenuContentGenerator,
		const TAttribute< FText > &	InLabel = TAttribute<FText>(),
		const TAttribute< FText > &	InToolTip = TAttribute<FText>(),
		const TAttribute< FSlateIcon > &	InIcon = TAttribute<FSlateIcon>(),
		bool	bInSimpleComboBox = false,
		TAttribute< FText >	InToolbarLabelOverride = TAttribute<FText>(),
		TAttribute< EMenuPlacement >	InPlacementOverride = MenuPlacement_ComboBox,
		const EUserInterfaceActionType	InUserInterfaceActionType = EUserInterfaceActionType::Button
	)

Constructor

Parameters

InAction	UI action that sets the enabled state for this combo button
InMenuContentGenerator	Delegate that generates a widget for this combo button's menu content. Called when the menu is summoned.
InLabel	Optional label for this combo button.
InToolTip	Tool tip string (required!)
InIcon	Optional icon to use for the tool bar image
bInSimpleComboBox	If true, the icon and label won't be displayed
InToolbarLabelOverride	Optional label to use when the block appears in a toolbar. If omitted, then the label override or command name will be used instead.
InPlacementOverride	Optional override placement to customize menu placement once opened via e.g. a toolbar menu button.
InUserInterfaceActionType	Optional type of user interface action to use. If a command is bound, the user interface action type associated with the command will be used instead.

Member Function Documentation

CreateMenuEntry()

void FToolBarComboButtonBlock::CreateMenuEntry ( class FMenuBuilder &  MenuBuilder ) const

overridevirtual

FMultiBlock interface

Reimplemented from FMultiBlock.

HasIcon()

bool FToolBarComboButtonBlock::HasIcon ( ) const

overridevirtual

Reimplemented from FMultiBlock.

IsSimpleComboBox()

bool FToolBarComboButtonBlock::IsSimpleComboBox ( ) const

inline

SetForceSmallIcons()

void FToolBarComboButtonBlock::SetForceSmallIcons ( const bool  InForceSmallIcons )

inline

Set whether this toolbar should always use small icons, regardless of the current settings

SetLabelVisibility()

void FToolBarComboButtonBlock::SetLabelVisibility ( EVisibility  InLabelVisibility )

inline

Sets the visibility of the blocks label

Parameters

InLabelVisibility

Visibility setting to use for the label

Friends And Related Symbol Documentation

SToolBarComboButtonBlock

friend class SToolBarComboButtonBlock

friend

---

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

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