Navigation
API > API/Runtime > API/Runtime/Slate
Tool bar button MultiBlock
| Name | FToolBarButtonBlock |
| Type | class |
| Header File | /Engine/Source/Runtime/Slate/Public/Framework/MultiBox/SToolBarButtonBlock.h |
| Include Path | #include "Framework/MultiBox/SToolBarButtonBlock.h" |
Syntax
class FToolBarButtonBlock : public FMultiBlock
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FMultiBlock → FToolBarButtonBlock
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FToolBarButtonBlock
(
FButtonArgs ButtonArgs |
Framework/MultiBox/SToolBarButtonBlock.h | ||
FToolBarButtonBlock
(
const TSharedPtr< const FUICommandInfo > InCommand, |
Constructor | Framework/MultiBox/SToolBarButtonBlock.h | |
FToolBarButtonBlock
(
const TAttribute< FText >& InLabel, |
Constructor | Framework/MultiBox/SToolBarButtonBlock.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/SToolBarButtonBlock.h | |
| bIsFocusable | bool | Whether ToolBar will have Focusable buttons | Framework/MultiBox/SToolBarButtonBlock.h | |
| BorderBrushName | TAttribute< FName > | The name of the border brush style, if present | Framework/MultiBox/SToolBarButtonBlock.h | |
| CustomMenuDelegate | FNewMenuDelegate | Optional delegate to customize when a menu appears instead of the widget, such as in toolbars | Framework/MultiBox/SToolBarButtonBlock.h | |
| GetDecoratedButtonDelegate | FGetDecoratedButtonDelegate | Delegate that takes the default toolbar button created by this as a parameter, adds any decorator needed and returns the new widget | Framework/MultiBox/SToolBarButtonBlock.h | |
| IconOverride | TAttribute< FSlateIcon > | Optional overridden icon for this tool bar button. | Framework/MultiBox/SToolBarButtonBlock.h | |
| LabelOverride | TAttribute< FText > | Optional overridden text label for this tool bar button. | Framework/MultiBox/SToolBarButtonBlock.h | |
| LabelVisibility | TOptional< EVisibility > | Framework/MultiBox/SToolBarButtonBlock.h | ||
| OnGetMenuContent | FOnGetContent | Delegate to execute to get the menu content of this button | Framework/MultiBox/SToolBarButtonBlock.h | |
| ToolbarLabelOverride | TAttribute< FText > | Optional overridden text label for when this tool bar button appears in a toolbar. | Framework/MultiBox/SToolBarButtonBlock.h | |
| ToolTipOverride | TAttribute< FText > | Optional overridden tool tip for this tool bar button. | Framework/MultiBox/SToolBarButtonBlock.h | |
| UserInterfaceActionType | EUserInterfaceActionType | In the case where a command is not bound, the user interface action type to use. | Framework/MultiBox/SToolBarButtonBlock.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void SetBorderBrushName
(
const FName InBorderBrushName |
Set the border brush for this toolbar button block | Framework/MultiBox/SToolBarButtonBlock.h | |
void SetCustomMenuDelegate
(
const FNewMenuDelegate& InOnFillMenuDelegate |
Set optional delegate to customize when a menu appears instead of the widget, such as in toolbars | Framework/MultiBox/SToolBarButtonBlock.h | |
void SetForceSmallIcons
(
const bool InForceSmallIcons |
Set whether this toolbar should always use small icons, regardless of the current settings | Framework/MultiBox/SToolBarButtonBlock.h | |
void SetGetDecoratedButtonDelegate
(
const FGetDecoratedButtonDelegate& InGetDecoratedButtonDelegate |
Delegate that takes the default toolbar button created by this as a parameter, adds any decorator needed and returns the new widget | Framework/MultiBox/SToolBarButtonBlock.h | |
void SetIsFocusable
(
bool bInIsFocusable |
Framework/MultiBox/SToolBarButtonBlock.h | ||
void SetLabelVisibility
(
EVisibility InLabelVisibility |
Framework/MultiBox/SToolBarButtonBlock.h | ||
void SetOnGetMenuContent
(
const FOnGetContent& OnGetMenuContent |
Framework/MultiBox/SToolBarButtonBlock.h |
Overridden from FMultiBlock
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CreateMenuEntry
(
FMenuBuilder& MenuBuilder |
FMultiBlock interface | Framework/MultiBox/SToolBarButtonBlock.h | |
virtual bool HasIcon() |
Framework/MultiBox/SToolBarButtonBlock.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool GetIsFocusable() |
Framework/MultiBox/SToolBarButtonBlock.h |