FToolBarBuilder

Tool bar builder

Inheritance Hierarchy

References

Module

Slate

Header

/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h

Include

#include "Framework/MultiBox/MultiBoxBuilder.h"

Syntax

class FToolBarBuilder : public FMultiBoxBuilder

Remarks

Tool bar builder

Constructors

Name Description

Public function

FToolBarBuilder

(
    TSharedPtr< const FUICommandList > ...,
    FMultiBoxCustomization InCustomizat...,
    TSharedPtr< FExtender > InExtender,
    const bool InForceSmallIcons
)

Constructor

Protected function

FToolBarBuilder

(
    EMultiBoxType InType,
    TSharedPtr< const FUICommandList > ...,
    FMultiBoxCustomization InCustomizat...,
    TSharedPtr< FExtender > InExtender,
    const bool InForceSmallIcons
)

Public function

FToolBarBuilder

(
    TSharedPtr< const FUICommandList > ...,
    FMultiBoxCustomization InCustomizat...,
    TSharedPtr< FExtender > InExtender,
    EOrientation Orientation,
    const bool InForceSmallIcons,
    const bool bUniform
)

FToolBarBuilder constructor that takes in an EOrientation is deprecated. Use one of the specific per-type FToolbarBuilder overrides instead.

Functions

Name Description

Public function

void

 

AddComboButton

(
    const FUIAction& InAction,
    const FOnGetContent& InMenuContent...,
    const TAttribute< FText >& InLabel...,
    const TAttribute< FText >& InToolT...,
    const TAttribute< FSlateIcon >& In...,
    bool bInSimpleComboBox,
    FName InTutorialHighlightName
)

Adds a combo button

Public function

void

 

AddSeparator

(
    FName InExtensionHook
)

Adds a toolbar separator

Public function

void

 

AddToolBarButton

(
    const FUIAction& InAction,
    FName InExtensionHook,
    const TAttribute< FText >& InLabel...,
    const TAttribute< FText >& InToolT...,
    const TAttribute< FSlateIcon >& In...,
    const EUserInterfaceActionType User...,
    FName InTutorialHighlightName
)

Adds a tool bar button

Public function

void

 

AddToolBarButton

(
    const TSharedPtr< const FUICommandI...,
    FName InExtensionHook,
    const TAttribute< FText >& InLabel...,
    const TAttribute< FText >& InToolT...,
    const TAttribute< FSlateIcon >& In...,
    FName InTutorialHighlightName,
    FNewMenuDelegate InCustomMenuDelega...
)

Adds a tool bar button

Public function

void

 

AddToolbarStackButton

(
    const TSharedPtr< const FUICommandI...,
    FName InTutorialHighlightName
)

Adds a tool bar stack button

Public function

void

 

AddToolBarWidget

(
    TSharedRef< SWidget > InWidget,
    const TAttribute< FText >& InLabel,
    FName InTutorialHighlightName,
    bool bSearchable
)

Adds any widget to the toolbar

Public function

void

 

AddWidget

(
    TSharedRef< SWidget > InWidget,
    FName InTutorialHighlightName,
    bool bSearchable,
    EHorizontalAlignment Alignment,
    FNewMenuDelegate InCustomMenuDelega...
)

Adds any widget to the toolbar

Public function

void

 

BeginBlockGroup()

Starts a new Group block, must be used in conjunction with EndBlockGroup

Public function

void

 

BeginSection

(
    FName InExtensionHook
)

Starts a section on to the extender section hook stack

Public function

void

 

BeginStyleOverride

(
    FName StyleOverrideName
)

Overrides the style being used by this toolbar with a different one for the The override will be used for any added blocks until EndStyleOverride is called

Public function

void

 

EndBlockGroup()

End a group block, must be used in conjunction with BeginBlockGroup.

Public function

void

 

EndSection()

Ends the current section

Public function

void

 

EndStyleOverride()

Public function

void

 

SetIsFocusable

(
    bool bInIsFocusable
)

Public function

void

 

SetLabelVisibility

(
    EVisibility InLabelVisibility
)

Overridden from FMultiBoxBuilder

Name Description

Protected function Virtual

void

 

ApplyHook

(
    FName InExtensionHook,
    EExtensionHook::Position HookPositi...
)

FMultiBoxBuilder interface

Protected function Virtual

void

 

ApplySectionBeginning()

Applies the beginning of a section, including the header and relevant separator

Deprecated Functions

Name Description

Public function

 

FToolBarBuilder

(
    TSharedPtr< const FUICommandList > ...,
    FMultiBoxCustomization InCustomizat...,
    TSharedPtr< FExtender > InExtender,
    EOrientation Orientation,
    const bool InForceSmallIcons,
    const bool bUniform
)

FToolBarBuilder constructor that takes in an EOrientation is deprecated. Use one of the specific per-type FToolbarBuilder overrides instead.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Cancel