Navigation
API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Framework > API/Runtime/Slate/Framework/MultiBox
Inheritance Hierarchy
- TSharedFromThis
- FMultiBox
References
| Module | Slate |
| Header | /Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBox.h |
| Include | #include "Framework/MultiBox/MultiBox.h" |
Syntax
class FMultiBox : public TSharedFromThis< FMultiBox >
Remarks
MultiBox. Contains a list of MultiBlocks that provide various functionality.
Variables
| Type | Name | Description | |
|---|---|---|---|
| bool | bHasSearchWidget | Whether the MultiBox has a search widget | |
| bool | bIsFocusable | Whether the MultiBox can be focused. | |
| FOnModifyBlockWidgetAfterMake | ModifyBlockWidgetAfterMake | Allow further modifications to the block's widget after it has been made | |
| TWeakObjectPtr< UToolMenuBase > | WeakToolMenu | Weak reference to tool menu that created this multibox |
Constructors
No constructors are accessible with public or protected access.
Destructors
| Type | Name | Description | |
|---|---|---|---|
~FMultiBox () |
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | AddMultiBlock
(
TSharedRef< const FMultiBlock > InBlock |
Adds a MultiBlock to this MultiBox, to the end of the list | |
| void | AddMultiBlockToFront
(
TSharedRef< const FMultiBlock > InBlock |
Adds a MultiBlock to this MultiBox, to the front of the list | |
| TSharedRef< FMultiBox > | Create
(
const EMultiBoxType InType, |
Creates a new multibox instance | |
| TSharedPtr< const FMultiBlock > | FindBlockFromNameAndType
(
const FName InName, |
Finds an existing block by name and type | |
| const TArray< TSharedRef< const FMultiBlock > > & | GetBlocks () |
Access this MultiBox's list of blocks | |
| FName | |||
| const TSharedPtr< const FUICommandList > | Returns the last command list used | ||
| int32 | GetSectionEditBounds
(
const int32 Index, |
Only callable during edit mode | |
| const FName & | GetStyleName () |
||
| const ISlateStyle * | GetStyleSet () |
||
| UToolMenuBase * | GetToolMenu () |
||
| const EMultiBoxType | GetType () |
Gets the type of this MultiBox | |
| void | InsertCustomMultiBlock
(
TSharedRef< const FMultiBlock > InBlock, |
Inserts a MultiBlock to the list for user customization | |
| bool | IsInEditMode () |
||
| TSharedPtr< FMultiBlock > | MakeMultiBlockFromCommand
(
TSharedPtr< const FUICommandInfo > Command, |
Creates a block from the provided command that is compatible with this box | |
| TSharedRef< class SMultiBoxWidget > | MakeWidget
(
bool bSearchable, |
Creates a MultiBox widget for this MultiBox | |
| const FEditSelectionChangedDelegate & | Delegate to call while editing when selected block has changed | ||
| FEditSelectionChangedDelegate & | Delegate to call while editing when selected block has changed | ||
| void | RemoveCustomMultiBlock
(
TSharedRef< const FMultiBlock > InBlock |
Removes a MultiBlock from the list for user customization | |
| void | SetStyle
(
const ISlateStyle* InStyleSet, |
Sets the style to use on the multibox widgets | |
| bool | Gets whether or not the window that contains this multibox should be destroyed after the user clicks on a menu item in this box |