1. Epic GamesDeveloper
  3. FToolBarBuilder

FToolBarBuilder

Tool bar builder

API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Framework > API/Runtime/Slate/Framework/MultiBox

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

  Type Name Description
Public function  

FToolBarBuilder ( TSharedPtr< const FUICommandList > InCommandList,
FMultiBoxCustomization InCustomization,
TSharedPtr< FExtender > InExtender,
const bool InForceSmallIcons
)

 Constructor
Protected function  

FToolBarBuilder ( EMultiBoxType InType,
TSharedPtr< const FUICommandList > InCommandList,
FMultiBoxCustomization InCustomization,
TSharedPtr< FExtender > InExtender,
const bool InForceSmallIcons
)

  
Public function  

FToolBarBuilder ( TSharedPtr< const FUICommandList > InCommandList,
FMultiBoxCustomization InCustomization,
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

  Type Name Description
Public function void

AddComboButton ( const FUIAction& InAction,
const FOnGetContent& InMenuContentGenerator,
const TAttribute< FText >& InLabelOverride,
const TAttribute< FText >& InToolTipOverride,
const TAttribute< FSlateIcon >& InIconOverride,
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 >& InLabelOverride,
const TAttribute< FText >& InToolTipOverride,
const TAttribute< FSlateIcon >& InIconOverride,
const EUserInterfaceActionType UserInterfaceActionType,
FName InTutorialHighlightName
)

 Adds a tool bar button
Public function void

AddToolBarButton ( const TSharedPtr< const FUICommandInfo > InCommand,
FName InExtensionHook,
const TAttribute< FText >& InLabelOverride,
const TAttribute< FText >& InToolTipOverride,
const TAttribute< FSlateIcon >& InIconOverride,
FName InTutorialHighlightName,
FNewMenuDelegate InCustomMenuDelegate
)

 Adds a tool bar button
Public function Virtual void

AddToolBarButton ( FButtonArgs& ButtonArgs
)

 Adds a tool bar button
Public function void

AddToolbarStackButton ( const TSharedPtr< const FUICommandInfo > InCommand,
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 InCustomMenuDelegate
)

 Adds any widget to the toolbar
Public function void 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 End a group block, must be used in conjunction with BeginBlockGroup.
Public function void Ends the current section
Public function void  
Protected function void  
Public function void

SetIsFocusable ( bool bInIsFocusable
)

  
Public function void

SetLabelVisibility ( EVisibility InLabelVisibility
)

  

Overridden from FMultiBoxBuilder

  Type Name Description
Protected function Virtual void

ApplyHook ( FName InExtensionHook,
EExtensionHook::Position HookPosition
)

 FMultiBoxBuilder interface
Protected function Virtual void Applies the beginning of a section, including the header and relevant separator

Deprecated Functions

  Type Name Description
Public function  

FToolBarBuilder ( TSharedPtr< const FUICommandList > InCommandList,
FMultiBoxCustomization InCustomization,
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.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page