UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
FToolBarStackButtonBlock Class Reference

#include <SToolBarStackButtonBlock.h>

+ Inheritance diagram for FToolBarStackButtonBlock:

Public Member Functions

 FToolBarStackButtonBlock (const TSharedRef< const FUICommandInfo > InCommand, TSharedPtr< const FUICommandList > InCommandList, bool bInSimpleStackBox=false)
 
virtual void CreateMenuEntry (class FMenuBuilder &MenuBuilder) const override
 
void SetLabelVisibility (EVisibility InLabelVisibility)
 
void SetForceSmallIcons (const bool InForceSmallIcons)
 
- 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
 
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
 

Protected Member Functions

virtual TSharedRef< class IMultiBlockBaseWidget > ConstructWidget () const override
 
const TSharedPtr< FUIIdentifierContext > GetStackIdentifier () const
 
const TSharedPtr< FUIContentContext > GetStackContent () const
 
- Protected Member Functions inherited from TSharedFromThis< FMultiBlock >
 TSharedFromThis ()
 
 TSharedFromThis (TSharedFromThis const &)
 
UE_FORCEINLINE_HINT TSharedFromThis & operator= (TSharedFromThis const &)
 
 ~TSharedFromThis ()
 

Protected Attributes

FOnGetContent MenuContentGenerator
 
TOptional< EVisibility > LabelVisibility
 
bool bSimpleComboBox
 
bool bForceSmallIcons
 
TWeakPtr< FUIIdentifierContext > CachedStackIdentifier
 
TWeakPtr< FUIContentContext > CachedStackContent
 

Friends

class SToolBarStackButtonBlock
 

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 combo button MultiBlock, but toggleable. Right & long-press clicks spawn menu. Designed to hold a stack of tools in one block.

Constructor & Destructor Documentation

◆ FToolBarStackButtonBlock()

FToolBarStackButtonBlock::FToolBarStackButtonBlock ( const TSharedRef< const FUICommandInfo >  InCommand,
TSharedPtr< const FUICommandList >  InCommandList,
bool  bInSimpleStackBox = false 
)

Constructor

Parameters
InCommandThe command associated with this tool bar button
InCommandListThe list of commands that are mapped to delegates so that we know what to execute for this button
bInSimpleStackBoxIf true, the icon and label won't be displayed

Member Function Documentation

◆ ConstructWidget()

TSharedRef< class IMultiBlockBaseWidget > FToolBarStackButtonBlock::ConstructWidget ( ) const
overrideprotectedvirtual

Allocates a widget for this type of MultiBlock. Override this in derived classes.

Returns
MultiBlock widget object

Implements FMultiBlock.

◆ CreateMenuEntry()

void FToolBarStackButtonBlock::CreateMenuEntry ( class FMenuBuilder &  MenuBuilder) const
overridevirtual

FMultiBlock interface

Reimplemented from FMultiBlock.

◆ GetStackContent()

const TSharedPtr< FUIContentContext > FToolBarStackButtonBlock::GetStackContent ( ) const
protected

Provides context menu content stack, caches on get

◆ GetStackIdentifier()

const TSharedPtr< FUIIdentifierContext > FToolBarStackButtonBlock::GetStackIdentifier ( ) const
protected

Provides dynamic, icons, labels, & descriptions for this stack, caches on get

◆ SetForceSmallIcons()

void FToolBarStackButtonBlock::SetForceSmallIcons ( const bool  InForceSmallIcons)
inline

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

◆ SetLabelVisibility()

void FToolBarStackButtonBlock::SetLabelVisibility ( EVisibility  InLabelVisibility)
inline

Sets the visibility of the blocks label

Parameters
InLabelVisibilityVisibility setting to use for the label

Friends And Related Symbol Documentation

◆ SToolBarStackButtonBlock

friend class SToolBarStackButtonBlock
friend

Member Data Documentation

◆ bForceSmallIcons

bool FToolBarStackButtonBlock::bForceSmallIcons
protected

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

◆ bSimpleComboBox

bool FToolBarStackButtonBlock::bSimpleComboBox
protected

If true, the icon and label won't be displayed

◆ CachedStackContent

TWeakPtr<FUIContentContext> FToolBarStackButtonBlock::CachedStackContent
mutableprotected

To avoid re-searching the FUICommandList, we cache the last content context

◆ CachedStackIdentifier

TWeakPtr<FUIIdentifierContext> FToolBarStackButtonBlock::CachedStackIdentifier
mutableprotected

To avoid re-searching the FUICommandList, we cache the last identifier context

◆ LabelVisibility

TOptional< EVisibility > FToolBarStackButtonBlock::LabelVisibility
protected

Controls the Labels visibility, defaults to GetIconVisibility if no override is provided

◆ MenuContentGenerator

FOnGetContent FToolBarStackButtonBlock::MenuContentGenerator
protected

Delegate that generates a widget for this combo button's menu content. Called when the menu is summoned.

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