![]() |
UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
|
#include <MultiBoxBuilder.h>
Inheritance diagram for FToolBarBuilder:Protected Member Functions | |
| FToolBarBuilder (EMultiBoxType InType, TSharedPtr< const FUICommandList > InCommandList, FMultiBoxCustomization InCustomization, TSharedPtr< FExtender > InExtender=TSharedPtr< FExtender >(), const bool InForceSmallIcons=false) | |
| virtual SLATE_API void | ApplyHook (FName InExtensionHook, EExtensionHook::Position HookPosition) override |
| virtual SLATE_API void | ApplySectionBeginning () override |
| SLATE_API void | InitializeToolBarButtonBlock (TSharedPtr< FToolBarButtonBlock > ButtonRowBlock, const FButtonArgs &ButtonArgs) |
| void | AddWidgetInternal (TSharedRef< SWidget > InWidget, const FMenuEntryStyleParams &InStyleParams, FName InTutorialHighlightName=NAME_None, bool bInSearchable=true, FNewMenuDelegate InCustomMenuDelegate=FNewMenuDelegate(), TAttribute< EVisibility > InVisibilityOverride=TAttribute< EVisibility >(), const TAttribute< FMenuEntryResizeParams > &InResizeParams=TAttribute< FMenuEntryResizeParams >()) |
Friends | |
| class | UToolMenus |
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 |
Tool bar builder
|
inline |
|
inline |
Constructor
| InCommandList | The action list that maps command infos to delegates that should be called for each command associated with a multiblock widget |
|
inlineprotected |
| void FToolBarBuilder::AddComboButton | ( | const FUIAction & | InAction, |
| const FOnGetContent & | InMenuContentGenerator, | ||
| const TAttribute< FText > & | InLabelOverride = TAttribute<FText>(), |
||
| const TAttribute< FText > & | InToolTipOverride = TAttribute<FText>(), |
||
| const TAttribute< FSlateIcon > & | InIconOverride = TAttribute<FSlateIcon>(), |
||
| bool | bInSimpleComboBox = false, |
||
| FName | InTutorialHighlightName = NAME_None, |
||
| TAttribute< EVisibility > | InVisibilityOverride = TAttribute<EVisibility>(), |
||
| TAttribute< FText > | InToolbarLabelOverride = TAttribute<FText>(), |
||
| TAttribute< EMenuPlacement > | InPlacementOverride = TAttribute<EMenuPlacement>(), |
||
| const EUserInterfaceActionType | InUserInterfaceActionType = EUserInterfaceActionType::Button, |
||
| const TAttribute< FMenuEntryResizeParams > & | InResizeParams = TAttribute<FMenuEntryResizeParams>() |
||
| ) |
Adds a combo button
| InAction | UI action that sets the enabled state for this combo button |
| InMenuContentGenerator | Delegate that generates a widget for this combo button's menu content. Called when the menu is summoned. |
| 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. |
| bInSimpleComboBox | If true, the icon and label won't be displayed |
| InTutorialHighlightName | Name to identify this widget and highlight during tutorials |
| InVisibilityOverride | Optional visibility override which, if set and returning anything but Visible, overrides the visibility of the combo button. |
| InToolbarLabelOverride | Optional label override for when this block appears in a toolbar. If omitted, then the action's label will be used instead. |
| InPlacementOverride | Optional override placement to customize menu placement once opened via e.g. a toolbar menu button. |
| InUserInterfaceActionType | Optional user interface action type to use if a command isn't bound. If a command is bound, we use the action type associated with the command instead. |
| InResizeParams | Optional resize parameters to control how this entry behaves during toolbar resizing. |
| void FToolBarBuilder::AddSeparator | ( | FName | InExtensionHook = NAME_None, |
| TAttribute< EVisibility > | InVisibilityOverride = TAttribute<EVisibility>(), |
||
| const TAttribute< FMenuEntryResizeParams > & | InResizeParams = TAttribute<FMenuEntryResizeParams>() |
||
| ) |
Adds a toolbar separator
| InExtensionHook | Optional extensibility hook. |
| InVisibilityOverride | Optional visibility override which, if set and returning anything but Visible, overrides the visibility of the separator. |
| InResizeParams | Optional resize parameters to control how this entry behaves during toolbar resizing. |
|
virtual |
Adds a tool bar button
| ButtonArgs | The Parameters object which will provide the data to initialize the button |
Reimplemented in FSlimHorizontalUniformToolBarBuilder.
| TSharedPtr< FToolBarButtonBlock > FToolBarBuilder::AddToolBarButton | ( | const FUIAction & | InAction, |
| FName | InExtensionHook = NAME_None, |
||
| const TAttribute< FText > & | InLabelOverride = TAttribute<FText>(), |
||
| const TAttribute< FText > & | InToolTipOverride = TAttribute<FText>(), |
||
| const TAttribute< FSlateIcon > & | InIconOverride = TAttribute<FSlateIcon>(), |
||
| const EUserInterfaceActionType | UserInterfaceActionType = EUserInterfaceActionType::Button, |
||
| FName | InTutorialHighlightName = NAME_None, |
||
| TAttribute< EVisibility > | InVisibilityOverride = TAttribute<EVisibility>(), |
||
| TAttribute< FText > | InToolbarLabelOverride = TAttribute<FText>(), |
||
| const TAttribute< FMenuEntryResizeParams > & | InResizeParams = TAttribute<FMenuEntryResizeParams>() |
||
| ) |
Adds a tool bar button
| InAction | Actions to execute on this menu item. |
| InExtensionHook | The section hook. Can be NAME_None. |
| 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. |
| UserInterfaceActionType | Type of interface action |
| InTutorialHighlightName | Name to identify this widget and highlight during tutorials |
| InVisibilityOverride | Optional visibility override which, if set and returning anything but Visible, overrides the visibility of the toolbar button. |
| InToolbarLabelOverride | Optional label override for when this block appears in a toolbar. If omitted, then the action's label will be used instead. |
| InResizeParams | Optional resize parameters to control how this entry behaves during toolbar resizing. |
| TSharedPtr< FToolBarButtonBlock > FToolBarBuilder::AddToolBarButton | ( | const TSharedPtr< const FUICommandInfo > | InCommand, |
| FName | InExtensionHook = NAME_None, |
||
| const TAttribute< FText > & | InLabelOverride = TAttribute<FText>(), |
||
| const TAttribute< FText > & | InToolTipOverride = TAttribute<FText>(), |
||
| const TAttribute< FSlateIcon > & | InIconOverride = TAttribute<FSlateIcon>(), |
||
| FName | InTutorialHighlightName = NAME_None, |
||
| FNewMenuDelegate | InCustomMenuDelegate = FNewMenuDelegate(), |
||
| TAttribute< EVisibility > | InVisibilityOverride = TAttribute<EVisibility>(), |
||
| TAttribute< FText > | InToolbarLabelOverride = TAttribute<FText>(), |
||
| const TAttribute< FMenuEntryResizeParams > & | InResizeParams = TAttribute<FMenuEntryResizeParams>() |
||
| ) |
Adds a tool bar button
| InCommand | The command associated with this tool bar button |
| InExtensionHook | The section hook. Can be NAME_None. |
| 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 name of the slate brush to use for the tool bar image. If omitted, then the action's icon will be used instead. |
| InTutorialHighlightName | Name to identify this widget and highlight during tutorials |
| InCustomMenuDelegate | Optional custom menu delegate for cases where the toolbar is compressed into a menu |
| InVisibilityOverride | Optional visibility override which, if set and returning anything but Visible, overrides the visibility of the toolbar button. |
| InToolbarLabelOverride | Optional label override for when this block appears in a toolbar. If omitted, then the action's label will be used instead. |
| InResizeParams | Optional resize parameters to control how this entry behaves during toolbar resizing. |
| void FToolBarBuilder::AddToolbarStackButton | ( | const TSharedPtr< const FUICommandInfo > | InCommand, |
| FName | InTutorialHighlightName = NAME_None |
||
| ) |
Adds a tool bar stack button
| InCommand | The command associated with this tool bar button |
| InTutorialHighlightName | Name to identify this widget and highlight during tutorials |
| void FToolBarBuilder::AddToolBarWidget | ( | TSharedRef< SWidget > | InWidget, |
| const TAttribute< FText > & | InLabel = TAttribute<FText>(), |
||
| FName | InTutorialHighlightName = NAME_None, |
||
| bool | bInSearchable = true, |
||
| const TAttribute< FText > & | InToolTip = TAttribute<FText>() |
||
| ) |
Adds any widget to the toolbar
| InWidget | The widget that should be shown in the toolbar |
| InLabel | Optional Label. |
| InTutorialHighlightName | Name to identify this widget and highlight during tutorials |
| bInSearchable | If true, widget will be searchable (default == true) |
| InToolTip | Optional tool tip |
| void FToolBarBuilder::AddWidget | ( | TSharedRef< SWidget > | InWidget, |
| const FMenuEntryStyleParams & | InStyleParams, | ||
| FName | InTutorialHighlightName = NAME_None, |
||
| bool | bInSearchable = true, |
||
| FNewMenuDelegate | InCustomMenuDelegate = FNewMenuDelegate(), |
||
| TAttribute< EVisibility > | InVisibilityOverride = TAttribute<EVisibility>(), |
||
| const TAttribute< FMenuEntryResizeParams > & | InResizeParams = TAttribute<FMenuEntryResizeParams>() |
||
| ) |
Adds any widget to the toolbar
| InWidget | The widget that should be shown in the toolbar |
| InStyleParams | Style parameters for the widget inside the toolbar |
| InTutorialHighlightName | Name to identify this widget and highlight during tutorials |
| bInSearchable | If true, widget will be searchable (default == true) |
| InCustomMenuDelegate | Optional custom menu delegate for cases where the toolbar is compressed into a menu |
| InVisibilityOverride | Optional visibility override which, if set and returning anything but Visible, overrides the visibility of the widget. |
| InResizeParams | Optional resize parameters to control how this entry behaves during toolbar resizing. |
| void FToolBarBuilder::AddWidget | ( | TSharedRef< SWidget > | InWidget, |
| FName | InTutorialHighlightName = NAME_None, |
||
| bool | bInSearchable = true, |
||
| EHorizontalAlignment | InAlignment = HAlign_Fill, |
||
| FNewMenuDelegate | InCustomMenuDelegate = FNewMenuDelegate(), |
||
| TAttribute< EVisibility > | InVisibilityOverride = TAttribute<EVisibility>() |
||
| ) |
Adds any widget to the toolbar
| InWidget | The widget that should be shown in the toolbar |
| InTutorialHighlightName | Name to identify this widget and highlight during tutorials |
| bInSearchable | If true, widget will be searchable (default == true) |
| InAlignment | Horizontal alignment for the widget inside the toolbar |
| InCustomMenuDelegate | Optional custom menu delegate for cases where the toolbar is compressed into a menu |
| InVisibilityOverride | Optional visibility override which, if set and returning anything but Visible, overrides the visibility of the widget. |
|
protected |
Handles AddWidget calls
|
overrideprotectedvirtual |
FMultiBoxBuilder interface
Implements FMultiBoxBuilder.
|
overrideprotectedvirtual |
Applies the beginning of a section, including the header and relevant separator
Reimplemented from FMultiBoxBuilder.
| void FToolBarBuilder::BeginBlockGroup | ( | ) |
Starts a new Group block, must be used in conjunction with EndBlockGroup
| void FToolBarBuilder::BeginSection | ( | FName | InExtensionHook, |
| bool | bInSectionShouldHaveSeparator = true, |
||
| const TAttribute< FMenuEntryResizeParams > & | InResizeParams = TAttribute<FMenuEntryResizeParams>() |
||
| ) |
Starts a section on to the extender section hook stack
| InExtensionHook | The section hook. Can be NAME_None |
| bInSectionShouldHaveSeparator | Whether this section should have a separator to its left (this doesn't apply |
| InResizeParams | Optional resize parameters to control how this section behaves during toolbar resizing. Note that this currently only supports wrapping options. to the first section added, because that never gets a separator). |
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
| void FToolBarBuilder::EndBlockGroup | ( | ) |
End a group block, must be used in conjunction with BeginBlockGroup.
| void FToolBarBuilder::EndSection | ( | ) |
Ends the current section
| void FToolBarBuilder::EndStyleOverride | ( | ) |
|
protected |
Whether to allow the wrap button/overflow menu, if applicable. Defaults to the style.
|
inline |
|
friend |