1. Epic GamesDeveloper
  3. FToolBarBuilder

FToolBarBuilder

Tool bar builder

API > API/Runtime > API/Runtime/Slate

Tool bar builder

   
Name FToolBarBuilder
Type class
Header File /Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h
Include Path #include "Framework/MultiBox/MultiBoxBuilder.h"

Syntax

class FToolBarBuilder : public FMultiBoxBuilder

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

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

   Framework/MultiBox/MultiBoxBuilder.h  

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

 Constructor Framework/MultiBox/MultiBoxBuilder.h  

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

   Framework/MultiBox/MultiBoxBuilder.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bForceSmallIcons bool Whether this toolbar should always use small icons, regardless of the current settings Framework/MultiBox/MultiBoxBuilder.h  
bIsFocusable bool Whether the buttons created can receive keyboard focus Framework/MultiBox/MultiBoxBuilder.h  
bSectionNeedsToBeApplied bool True if there is a pending section that needs to be applied Framework/MultiBox/MultiBoxBuilder.h  
bSectionShouldHaveSeparator bool Whether the current section should be preceded by a separator Framework/MultiBox/MultiBoxBuilder.h  
CurrentSectionExtensionHook FName Current extension hook name for sections to determine where sections begin and end Framework/MultiBox/MultiBoxBuilder.h  
CurrentSectionResizeParams TAttribute< FMenuEntryResizeParams > Resize parameters for the current section Framework/MultiBox/MultiBoxBuilder.h  
CurrentStyleOverride FName   Framework/MultiBox/MultiBoxBuilder.h  
LabelVisibility TOptional< EVisibility >   Framework/MultiBox/MultiBoxBuilder.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddComboButton ( const FUIAction& InAction,
const FOnGetContent& InMenuContentGenerator,
const TAttribute< FText >& InLabelOverride,
const TAttribute< FText >& InToolTipOverride,
const TAttribute< FSlateIcon >& InIconOverride,
bool bInSimpleComboBox,
FName InTutorialHighlightName,
TAttribute< EVisibility > InVisibilityOverride,
TAttribute< FText > InToolbarLabelOverride,
TAttribute< EMenuPlacement > InPlacementOverride,
const EUserInterfaceActionType InUserInterfaceActionType,
const TAttribute< FMenuEntryResizeParams >& InResizeParams
)

 Adds a combo button Framework/MultiBox/MultiBoxBuilder.h  

void AddSeparator ( FName InExtensionHook,
TAttribute< EVisibility > InVisibilityOverride,
const TAttribute< FMenuEntryResizeParams >& InResizeParams
)

 Adds a toolbar separator Framework/MultiBox/MultiBoxBuilder.h  

TSharedPtr< FToolBarButtonBlock > AddToolBarButton ( const FUIAction& InAction,
FName InExtensionHook,
const TAttribute< FText >& InLabelOverride,
const TAttribute< FText >& InToolTipOverride,
const TAttribute< FSlateIcon >& InIconOverride,
const EUserInterfaceActionType UserInterfaceActionType,
FName InTutorialHighlightName,
TAttribute< EVisibility > InVisibilityOverride,
TAttribute< FText > InToolbarLabelOverride,
const TAttribute< FMenuEntryResizeParams >& InResizeParams
)

 Adds a tool bar button Framework/MultiBox/MultiBoxBuilder.h  

TSharedPtr< FToolBarButtonBlock > AddToolBarButton ( const TSharedPtr< const FUICommandInfo > InCommand,
FName InExtensionHook,
const TAttribute< FText >& InLabelOverride,
const TAttribute< FText >& InToolTipOverride,
const TAttribute< FSlateIcon >& InIconOverride,
FName InTutorialHighlightName,
FNewMenuDelegate InCustomMenuDelegate,
TAttribute< EVisibility > InVisibilityOverride,
TAttribute< FText > InToolbarLabelOverride,
const TAttribute< FMenuEntryResizeParams >& InResizeParams
)

 Adds a tool bar button Framework/MultiBox/MultiBoxBuilder.h  

virtual void AddToolBarButton ( const FButtonArgs& ButtonArgs
)

 Adds a tool bar button Framework/MultiBox/MultiBoxBuilder.h  

void AddToolbarStackButton ( const TSharedPtr< const FUICommandInfo > InCommand,
FName InTutorialHighlightName
)

 Adds a tool bar stack button Framework/MultiBox/MultiBoxBuilder.h  

void AddToolBarWidget ( TSharedRef< SWidget > InWidget,
const TAttribute< FText >& InLabel,
FName InTutorialHighlightName,
bool bInSearchable,
const TAttribute< FText >& InToolTip
)

 Adds any widget to the toolbar Framework/MultiBox/MultiBoxBuilder.h  

void AddWidget ( TSharedRef< SWidget > InWidget,
const FMenuEntryStyleParams& InStyleParams,
FName InTutorialHighlightName,
bool bInSearchable,
FNewMenuDelegate InCustomMenuDelegate,
TAttribute< EVisibility > InVisibilityOverride,
const TAttribute< FMenuEntryResizeParams >& InResizeParams
)

 Adds any widget to the toolbar Framework/MultiBox/MultiBoxBuilder.h  

void AddWidget ( TSharedRef< SWidget > InWidget,
FName InTutorialHighlightName,
bool bInSearchable,
EHorizontalAlignment InAlignment,
FNewMenuDelegate InCustomMenuDelegate,
TAttribute< EVisibility > InVisibilityOverride
)

 Adds any widget to the toolbar Framework/MultiBox/MultiBoxBuilder.h  

void BeginBlockGroup()

 Starts a new Group block, must be used in conjunction with EndBlockGroup Framework/MultiBox/MultiBoxBuilder.h  

void BeginSection ( FName InExtensionHook,
bool bInSectionShouldHaveSeparator,
const TAttribute< FMenuEntryResizeParams >& InResizeParams
)

 Starts a section on to the extender section hook stack Framework/MultiBox/MultiBoxBuilder.h  

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 Framework/MultiBox/MultiBoxBuilder.h  

void EndBlockGroup()

 End a group block, must be used in conjunction with BeginBlockGroup. Framework/MultiBox/MultiBoxBuilder.h  

void EndSection()

 Ends the current section Framework/MultiBox/MultiBoxBuilder.h  

void EndStyleOverride()

   Framework/MultiBox/MultiBoxBuilder.h  

void SetAllowWrapButton ( const TOptional< bool >& bInAllowWrapButton
) const

 Whether to allow the wrap button/overflow menu, if applicable. Defaults to the style. Framework/MultiBox/MultiBoxBuilder.h  

void SetIsFocusable ( bool bInIsFocusable
)

   Framework/MultiBox/MultiBoxBuilder.h  

void SetLabelVisibility ( EVisibility InLabelVisibility
)

   Framework/MultiBox/MultiBoxBuilder.h  

Protected

Name Remarks Include Path Unreal Specifiers

void AddWidgetInternal ( TSharedRef< SWidget > InWidget,
const FMenuEntryStyleParams& InStyleParams,
FName InTutorialHighlightName,
bool bInSearchable,
FNewMenuDelegate InCustomMenuDelegate,
TAttribute< EVisibility > InVisibilityOverride,
const TAttribute< FMenuEntryResizeParams >& InResizeParams
)

 Handles AddWidget calls Framework/MultiBox/MultiBoxBuilder.h  

void InitializeToolBarButtonBlock ( TSharedPtr< FToolBarButtonBlock > ButtonRowBlock,
const FButtonArgs& ButtonArgs
)

   Framework/MultiBox/MultiBoxBuilder.h  

Overridden from FMultiBoxBuilder

Name Remarks Include Path Unreal Specifiers

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

 FMultiBoxBuilder interface Framework/MultiBox/MultiBoxBuilder.h  

virtual void ApplySectionBeginning()

 Applies the beginning of a section, including the header and relevant separator Framework/MultiBox/MultiBoxBuilder.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page