FToolBarButtonBlock Class Reference

#include <SToolBarButtonBlock.h>

Inheritance diagram for FToolBarButtonBlock:

Public Member Functions
SLATE_API	FToolBarButtonBlock (FButtonArgs ButtonArgs)
SLATE_API	FToolBarButtonBlock (const TSharedPtr< const FUICommandInfo > InCommand, TSharedPtr< const FUICommandList > InCommandList, const TAttribute< FText > &InLabelOverride=TAttribute< FText >(), const TAttribute< FText > &InToolTipOverride=TAttribute< FText >(), const TAttribute< FSlateIcon > &InIconOverride=TAttribute< FSlateIcon >(), TAttribute< FText > InToolbarLabelOverride=TAttribute< FText >())
SLATE_API	FToolBarButtonBlock (const TAttribute< FText > &InLabel, const TAttribute< FText > &InToolTip, const TAttribute< FSlateIcon > &InIcon, const FUIAction &InUIAction, const EUserInterfaceActionType InUserInterfaceActionType, TAttribute< FText > InToolbarLabelOverride=TAttribute< FText >())
void	SetLabelVisibility (EVisibility InLabelVisibility)
void	SetIsFocusable (bool bInIsFocusable)
void	SetForceSmallIcons (const bool InForceSmallIcons)
void	SetBorderBrushName (const FName InBorderBrushName)
virtual SLATE_API void	CreateMenuEntry (class FMenuBuilder &MenuBuilder) const override
virtual SLATE_API bool	HasIcon () const override
SLATE_API void	SetCustomMenuDelegate (const FNewMenuDelegate &InOnFillMenuDelegate)
SLATE_API void	SetCustomWidget (const TSharedPtr< SWidget > &InCustomWidget)
SLATE_API void	SetOnGetMenuContent (const FOnGetContent &OnGetMenuContent)
void	SetGetDecoratedButtonDelegate (const FGetDecoratedButtonDelegate &InGetDecoratedButtonDelegate)
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

Protected Member Functions
SLATE_API bool	GetIsFocusable () const
Protected Member Functions inherited from TSharedFromThis< FMultiBlock >
	TSharedFromThis ()
	TSharedFromThis (TSharedFromThis const &)
UE_FORCEINLINE_HINT TSharedFromThis &	operator= (TSharedFromThis const &)
	~TSharedFromThis ()

Friends
class	SToolBarButtonBlock

Additional Inherited Members
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 button MultiBlock

Constructor & Destructor Documentation

FToolBarButtonBlock() [1/3]

FToolBarButtonBlock::FToolBarButtonBlock

(

FButtonArgs

ButtonArgs

)

FToolBarButtonBlock() [2/3]

FToolBarButtonBlock::FToolBarButtonBlock	(	const TSharedPtr< const FUICommandInfo >	InCommand,
		TSharedPtr< const FUICommandList >	InCommandList,
		const TAttribute< FText > &	InLabelOverride = TAttribute<FText>(),
		const TAttribute< FText > &	InToolTipOverride = TAttribute<FText>(),
		const TAttribute< FSlateIcon > &	InIconOverride = TAttribute<FSlateIcon>(),
		TAttribute< FText >	InToolbarLabelOverride = TAttribute<FText>()
	)

Constructor

Parameters

InCommand	The command associated with this tool bar button
InCommandList	The list of commands that are mapped to delegates so that we know what to execute for this button
InLabelOverride	Optional label override. If omitted, then the action's label will be used instead.
InToolTipOverride	Optional tool tip override. If omitted, then the action's label will be used instead.
InIconOverride	Optional icon to use for the tool bar image. If omitted, then the action's icon will be used instead.
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.

FToolBarButtonBlock() [3/3]

FToolBarButtonBlock::FToolBarButtonBlock	(	const TAttribute< FText > &	InLabel,
		const TAttribute< FText > &	InToolTip,
		const TAttribute< FSlateIcon > &	InIcon,
		const FUIAction &	InUIAction,
		const EUserInterfaceActionType	InUserInterfaceActionType,
		TAttribute< FText >	InToolbarLabelOverride = TAttribute<FText>()
	)

Constructor

Parameters

InLabel	The label to display in the menu
InToolTip	The tool tip to display when the menu entry is hovered over
InIcon	The icon to display to the left of the label
InUIAction	UI action to take when this menu item is clicked as well as to determine if the menu entry can be executed or appears "checked"
InUserInterfaceActionType	Type of interface action
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.

Member Function Documentation

CreateMenuEntry()

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

overridevirtual

FMultiBlock interface

Reimplemented from FMultiBlock.

GetIsFocusable()

bool FToolBarButtonBlock::GetIsFocusable ( ) const

protected

HasIcon()

bool FToolBarButtonBlock::HasIcon ( ) const

overridevirtual

Reimplemented from FMultiBlock.

SetBorderBrushName()

void FToolBarButtonBlock::SetBorderBrushName ( const FName  InBorderBrushName )

inline

Set the border brush for this toolbar button block

SetCustomMenuDelegate()

void FToolBarButtonBlock::SetCustomMenuDelegate

(

const FNewMenuDelegate &

InOnFillMenuDelegate

)

Set optional delegate to customize when a menu appears instead of the widget, such as in toolbars

SetCustomWidget()

void FToolBarButtonBlock::SetCustomWidget

(

const TSharedPtr< SWidget > &

InCustomWidget

)

SetForceSmallIcons()

void FToolBarButtonBlock::SetForceSmallIcons ( const bool  InForceSmallIcons )

inline

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

SetGetDecoratedButtonDelegate()

void FToolBarButtonBlock::SetGetDecoratedButtonDelegate

(

const FGetDecoratedButtonDelegate &

InGetDecoratedButtonDelegate

)

Delegate that takes the default toolbar button created by this as a parameter, adds any decorator needed and returns the new widget

Parameters

InGetDecoratedButtonDelegate

the delegate that handles decorating the button

SetIsFocusable()

void FToolBarButtonBlock::SetIsFocusable ( bool  bInIsFocusable )

inline

SetLabelVisibility()

void FToolBarButtonBlock::SetLabelVisibility ( EVisibility  InLabelVisibility )

inline

SetOnGetMenuContent()

void FToolBarButtonBlock::SetOnGetMenuContent

(

const FOnGetContent &

OnGetMenuContent

)

Friends And Related Symbol Documentation

SToolBarButtonBlock

friend class SToolBarButtonBlock

friend

---

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

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