FButtonRowBuilder Class Reference

#include <MultiBoxBuilder.h>

Inheritance diagram for FButtonRowBuilder:

Public Member Functions
	FButtonRowBuilder (TSharedPtr< const FUICommandList > InCommandList, TSharedPtr< FExtender > InExtender=TSharedPtr< FExtender >())
SLATE_API void	AddButton (const TSharedPtr< const FUICommandInfo > InCommand, const TAttribute< FText > &InLabelOverride=TAttribute< FText >(), const TAttribute< FText > &InToolTipOverride=TAttribute< FText >(), const FSlateIcon &InIconOverride=FSlateIcon())
SLATE_API void	AddButton (const FText &InLabel, const FText &InToolTip, const FUIAction &InUIAction, const FSlateIcon &InIcon=FSlateIcon(), const EUserInterfaceActionType InUserInterfaceActionType=EUserInterfaceActionType::Button)
Public Member Functions inherited from FMultiBoxBuilder
SLATE_API	FMultiBoxBuilder (const EMultiBoxType InType, FMultiBoxCustomization InCustomization, const bool bInShouldCloseWindowAfterMenuSelection, const TSharedPtr< const FUICommandList > &InCommandList, TSharedPtr< FExtender > InExtender=TSharedPtr< FExtender >(), FName InTutorialHighlightName=NAME_None, FName InMenuName=NAME_None)
virtual	~FMultiBoxBuilder ()
SLATE_API void	AddEditableText (const FText &InLabel, const FText &InToolTip, const FSlateIcon &InIcon, const TAttribute< FText > &InTextAttribute, const FOnTextCommitted &InOnTextCommitted=FOnTextCommitted(), const FOnTextChanged &InOnTextChanged=FOnTextChanged(), bool bInReadOnly=false)
SLATE_API void	AddVerifiedEditableText (const FText &InLabel, const FText &InToolTip, const FSlateIcon &InIcon, const TAttribute< FText > &InTextAttribute, const FOnVerifyTextChanged &InOnVerifyTextChanged, const FOnTextCommitted &InOnTextCommitted=FOnTextCommitted(), const FOnTextChanged &InOnTextChanged=FOnTextChanged(), bool bInReadOnly=false)
virtual SLATE_API TSharedRef< class SWidget >	MakeWidget (FMultiBox::FOnMakeMultiBoxBuilderOverride *InMakeMultiBoxBuilderOverride=nullptr)
SLATE_API TSharedRef< class FMultiBox >	GetMultiBox ()
SLATE_API void	PushCommandList (const TSharedRef< const FUICommandList > CommandList)
SLATE_API void	SetLastSelectedCommandIndex (int32 InLastSelectedCommandIndex)
SLATE_API void	PopCommandList ()
SLATE_API TSharedPtr< const FUICommandList >	GetTopCommandList ()
SLATE_API void	PushExtender (TSharedRef< FExtender > InExtender)
SLATE_API void	PopExtender ()
SLATE_API const ISlateStyle *	GetStyleSet () const
SLATE_API const FName &	GetStyleName () const
SLATE_API void	SetCheckBoxStyle (FName InCheckBoxStyle)
SLATE_API void	SetStyle (const ISlateStyle *InStyleSet, const FName &InStyleName)
SLATE_API FMultiBoxCustomization	GetCustomization () const
void	SetExtendersEnabled (bool bEnabled)
bool	ExtendersEnabled () const

Protected Member Functions
virtual void	ApplyHook (FName InExtensionHook, EExtensionHook::Position HookPosition) override
Protected Member Functions inherited from FMultiBoxBuilder
virtual void	ApplySectionBeginning ()

Additional Inherited Members
Protected Attributes inherited from FMultiBoxBuilder
TSharedRef< class FMultiBox >	MultiBox
TArray< TSharedPtr< const FUICommandList > >	CommandListStack
TArray< TSharedPtr< class FExtender > >	ExtenderStack
FName	TutorialHighlightName
FName	MenuName
FName	CheckBoxStyle
bool	bExtendersEnabled

Detailed Description

Button grid builder

Constructor & Destructor Documentation

FButtonRowBuilder()

FButtonRowBuilder::FButtonRowBuilder ( TSharedPtr< const FUICommandList >  InCommandList, TSharedPtr< FExtender >  InExtender = TSharedPtr<FExtender>()  )

inline

Constructor

Parameters

InCommandList

The action list that maps command infos to delegates that should be called for each command associated with a multiblock widget

Member Function Documentation

AddButton() [1/2]

void FButtonRowBuilder::AddButton	(	const FText &	InLabel,
		const FText &	InToolTip,
		const FUIAction &	InUIAction,
		const FSlateIcon &	InIcon = FSlateIcon(),
		const EUserInterfaceActionType	InUserInterfaceActionType = EUserInterfaceActionType::Button
	)

Adds a button to a row

Parameters

InLabel	The button label to display
InToolTip	The tooltip for the button
InUIAction	Action to execute when the button is clicked or when state should be checked
InIcon	The icon for the button
InUserInterfaceActionType	The style of button to display

AddButton() [2/2]

void FButtonRowBuilder::AddButton	(	const TSharedPtr< const FUICommandInfo >	InCommand,
		const TAttribute< FText > &	InLabelOverride = TAttribute<FText>(),
		const TAttribute< FText > &	InToolTipOverride = TAttribute<FText>(),
		const FSlateIcon &	InIconOverride = FSlateIcon()
	)

Adds a button to a row

Parameters

InCommand	The command associated with this tool bar 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.

ApplyHook()

virtual void FButtonRowBuilder::ApplyHook ( FName  InExtensionHook, EExtensionHook::Position  HookPosition  )

inlineoverrideprotectedvirtual

FMultiBoxBuilder interface

Implements FMultiBoxBuilder.

---

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

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