Navigation
API > API/Runtime > API/Runtime/Slate
Tool bar button MultiBlock widget
| Name | SToolBarButtonBlock |
| Type | class |
| Header File | /Engine/Source/Runtime/Slate/Public/Framework/MultiBox/SToolBarButtonBlock.h |
| Include Path | #include "Framework/MultiBox/SToolBarButtonBlock.h" |
Syntax
class SToolBarButtonBlock : public SMultiBlockBaseWidget
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SCompoundWidget → SMultiBlockBaseWidget → SToolBarButtonBlock
- FSlateControlledConstruction → SWidget → SCompoundWidget → SMultiBlockBaseWidget → SToolBarButtonBlock
Implements Interfaces
Derived Classes
Structs
| Name | Remarks |
|---|---|
| FArguments |
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 | |
| ButtonBorder | TSharedPtr< SBorder > | Framework/MultiBox/SToolBarButtonBlock.h | ||
| LabelVisibility | TAttribute< EVisibility > | Controls the visibility of the of label, defaults to GetIconVisibility | Framework/MultiBox/SToolBarButtonBlock.h | |
| LabelVisibilityOverride | TOptional< EVisibility > | Overrides the visibility of the of label. This is used to set up the LabelVisibility attribute | Framework/MultiBox/SToolBarButtonBlock.h | |
| OptionsBorder | TSharedPtr< SBorder > | Framework/MultiBox/SToolBarButtonBlock.h | ||
| TutorialHighlightName | FName | Name to identify a widget for tutorials | Framework/MultiBox/SToolBarButtonBlock.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void Construct
(
const FArguments& InArgs |
Construct this widget | Framework/MultiBox/SToolBarButtonBlock.h |
Overridden from IMultiBlockBaseWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BuildMultiBlockWidget
(
const ISlateStyle* StyleSet, |
Builds this MultiBlock widget up from the MultiBlock associated with it | Framework/MultiBox/SToolBarButtonBlock.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
EVisibility GetBlockVisibility() |
Called by Slate to determine if this button is visible | Framework/MultiBox/SToolBarButtonBlock.h | |
ECheckBoxState GetCheckState() |
Called by slate to determine if this button should appear checked | Framework/MultiBox/SToolBarButtonBlock.h | |
bool IsEnabled() |
Called by Slate to determine if this button is enabled | Framework/MultiBox/SToolBarButtonBlock.h | |
void OnCheckStateChanged
(
const ECheckBoxState NewCheckedState |
Called by Slate when this tool bar check box button is toggled | Framework/MultiBox/SToolBarButtonBlock.h | |
FReply OnClicked() |
Called by Slate when this tool bar button's button is clicked | Framework/MultiBox/SToolBarButtonBlock.h |