Navigation
API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/FToolBarBuilder
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void AddToolBarButton
(
const FButtonArgs& ButtonArgs |
Adds a tool bar button | Framework/MultiBox/MultiBoxBuilder.h | |
TSharedPtr< FToolBarButtonBlock > AddToolBarButton
(
const TSharedPtr< const FUICommandInfo > InCommand, |
Adds a tool bar button | Framework/MultiBox/MultiBoxBuilder.h | |
TSharedPtr< FToolBarButtonBlock > AddToolBarButton
(
const FUIAction& InAction, |
Adds a tool bar button | Framework/MultiBox/MultiBoxBuilder.h |
AddToolBarButton(const FButtonArgs &)
Description
Adds a tool bar button
| Name | AddToolBarButton |
| Type | function |
| Header File | /Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h |
| Include Path | #include "Framework/MultiBox/MultiBoxBuilder.h" |
| Source | /Engine/Source/Runtime/Slate/Private/Framework/MultiBox/MultiBoxBuilder.cpp |
virtual void AddToolBarButton
(
const FButtonArgs & ButtonArgs
)
Parameters
| Name | Remarks |
|---|---|
| ButtonArgs | The Parameters object which will provide the data to initialize the button |
AddToolBarButton(const TSharedPtr< const FUICommandInfo >, FName, const TAttribute< FText > &, const TAttribute< FText > &, const TAttribute< FSlateIcon > &, FName, FNewMenuDelegate, TAttribute< EVisibility >, TAttribute< FText >, const TAttribute< FMenuEntryResizeParams > &)
Description
Adds a tool bar button
| Name | AddToolBarButton |
| Type | function |
| Header File | /Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h |
| Include Path | #include "Framework/MultiBox/MultiBoxBuilder.h" |
| Source | /Engine/Source/Runtime/Slate/Private/Framework/MultiBox/MultiBoxBuilder.cpp |
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
)
Parameters
| Name | Remarks |
|---|---|
| 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. |
AddToolBarButton(const FUIAction &, FName, const TAttribute< FText > &, const TAttribute< FText > &, const TAttribute< FSlateIcon > &, const EUserInterfaceActionType, FName, TAttribute< EVisibility >, TAttribute< FText >, const TAttribute< FMenuEntryResizeParams > &)
Description
Adds a tool bar button
| Name | AddToolBarButton |
| Type | function |
| Header File | /Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h |
| Include Path | #include "Framework/MultiBox/MultiBoxBuilder.h" |
| Source | /Engine/Source/Runtime/Slate/Private/Framework/MultiBox/MultiBoxBuilder.cpp |
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
)
Parameters
| Name | Remarks |
|---|---|
| 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. |