1. Epic GamesDeveloper
  3. FMultiBox

FMultiBox

MultiBox. Contains a list of MultiBlocks that provide various functionality.

API > API/Runtime > API/Runtime/Slate

MultiBox. Contains a list of MultiBlocks that provide various functionality.

   
Name FMultiBox
Type class
Header File /Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBox.h
Include Path #include "Framework/MultiBox/MultiBox.h"

Syntax

class FMultiBox : public TSharedFromThis< FMultiBox >

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FMultiBox ( const EMultiBoxType InType,
FMultiBoxCustomization InCustomization,
const bool bInShouldCloseWindowAfterMenuSelection
)

 Constructor Framework/MultiBox/MultiBox.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FMultiBox()

   Framework/MultiBox/MultiBox.h  

Typedefs

Name Type Remarks Include Path
FEditSelectionChangedDelegate TBaseDelegate_OneParam< void, TSharedRef< const FMultiBlock > >   Framework/MultiBox/MultiBox.h
FOnMakeMultiBoxBuilderOverride TBaseDelegate_TwoParams< void, const TSharedRef< FMultiBox > &, const TSharedRef< SMultiBoxWidget > & >   Framework/MultiBox/MultiBox.h
FOnModifyBlockWidgetAfterMake TBaseDelegate_ThreeParams< TSharedRef< SWidget >, const TSharedRef< SMultiBoxWidget > &, const FMultiBlock &, const TSharedRef< SWidget > & >   Framework/MultiBox/MultiBox.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bAllowWrapButton TOptional< bool > Whether the WrapButton/Overflow can be shown (if applicable). Defaults to the style. Framework/MultiBox/MultiBox.h  
bHasSearchWidget bool Whether the MultiBox has a search widget Framework/MultiBox/MultiBox.h  
bIsFocusable bool Whether the MultiBox can be focused. Framework/MultiBox/MultiBox.h  
ModifyBlockWidgetAfterMake FOnModifyBlockWidgetAfterMake Allow further modifications to the block's widget after it has been made Framework/MultiBox/MultiBox.h  
WeakToolMenu TWeakObjectPtr< UToolMenuBase > Weak reference to tool menu that created this multibox Framework/MultiBox/MultiBox.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
Blocks TArray< TSharedRef< const FMultiBlock > > Ordered list of blocks Framework/MultiBox/MultiBox.h  
bShouldCloseWindowAfterMenuSelection bool True if window that owns any widgets created from this multibox should be closed automatically after the user commits to a menu choice Framework/MultiBox/MultiBox.h  
CommandLists TArray< TSharedPtr< const FUICommandList > > All command lists in this box Framework/MultiBox/MultiBox.h  
EditSelectionChanged FEditSelectionChangedDelegate Delegate to call while editing when selected block has changed Framework/MultiBox/MultiBox.h  
LastSelectedCommandIndex int32 The Last selected command index. If unset this has a value of INDEX_NONE Framework/MultiBox/MultiBox.h  
StyleName FName The style name to use with the widgets in the MultiBox Framework/MultiBox/MultiBox.h  
StyleSet const ISlateStyle * The style set to use with the widgets in the MultiBox Framework/MultiBox/MultiBox.h  
Type EMultiBoxType Type of MultiBox Framework/MultiBox/MultiBox.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddMultiBlock ( TSharedRef< const FMultiBlock > InBlock
)

 Adds a MultiBlock to this MultiBox, to the end of the list Framework/MultiBox/MultiBox.h  

void AddMultiBlockToFront ( TSharedRef< const FMultiBlock > InBlock
)

 Adds a MultiBlock to this MultiBox, to the front of the list Framework/MultiBox/MultiBox.h  

TSharedPtr< const FMultiBlock > FindBlockFromNameAndType ( const FName InName,
const EMultiBlockType InType
) const

 Finds an existing block by name and type Framework/MultiBox/MultiBox.h  

const TArray< TSharedRef< const FMultiBlock > > & GetBlocks()

 Access this MultiBox's list of blocks Framework/MultiBox/MultiBox.h  

FName GetCustomizationName()

   Framework/MultiBox/MultiBox.h  

const TSharedPtr< const FUICommandList > GetLastCommandList()

 Returns the last command list used Framework/MultiBox/MultiBox.h  

int32 GetLastSelectedCommandIndex()

 Returns the index of the item which was last selected in this box Framework/MultiBox/MultiBox.h  

int32 GetSectionEditBounds ( const int32 Index,
int32& OutSectionEndIndex
) const

 Only callable during edit mode Framework/MultiBox/MultiBox.h  

const FName & GetStyleName()

   Framework/MultiBox/MultiBox.h  

const ISlateStyle * GetStyleSet()

   Framework/MultiBox/MultiBox.h  

UToolMenuBase * GetToolMenu()

   Framework/MultiBox/MultiBox.h  

const EMultiBoxType GetType()

 Gets the type of this MultiBox Framework/MultiBox/MultiBox.h  

void InsertCustomMultiBlock ( TSharedRef< const FMultiBlock > InBlock,
int32 Index
)

 Inserts a MultiBlock to the list for user customization Framework/MultiBox/MultiBox.h  

bool IsInEditMode()

   Framework/MultiBox/MultiBox.h  

TSharedPtr< FMultiBlock > MakeMultiBlockFromCommand ( TSharedPtr< const FUICommandInfo > Command,
bool bCommandMustBeBound
) const

 Creates a block from the provided command that is compatible with this box Framework/MultiBox/MultiBox.h  

TSharedRef< class SMultiBoxWidget > MakeWidget ( bool bSearchable,
FOnMakeMultiBoxBuilderOverride* InMakeMultiBoxBuilderOverride,
TAttribute< float > InMaxHeight
)

 Creates a MultiBox widget for this MultiBox Framework/MultiBox/MultiBox.h  

const FEditSelectionChangedDelegate & OnEditSelectionChanged ()

 Delegate to call while editing when selected block has changed Framework/MultiBox/MultiBox.h  

FEditSelectionChangedDelegate & OnEditSelectionChanged ()

 Delegate to call while editing when selected block has changed Framework/MultiBox/MultiBox.h  

void RemoveCustomMultiBlock ( TSharedRef< const FMultiBlock > InBlock
)

 Removes a MultiBlock from the list for user customization Framework/MultiBox/MultiBox.h  

void SetLastSelectedCommandIndex ( int32 LastSelectedCommandIndex
)

 Sets the index of the item which was last selected in this box Framework/MultiBox/MultiBox.h  

void SetStyle ( const ISlateStyle* InStyleSet,
const FName& InStyleName
)

 Sets the style to use on the multibox widgets Framework/MultiBox/MultiBox.h  

bool ShouldCloseWindowAfterMenuSelection()

 Gets whether or not the window that contains this multibox should be destroyed after the user clicks on a menu item in this box Framework/MultiBox/MultiBox.h  

Static

Name Remarks Include Path Unreal Specifiers

static TSharedRef< FMultiBox > Create ( const EMultiBoxType InType,
FMultiBoxCustomization InCustomization,
const bool bInShouldCloseWindowAfterMenuSelection
)

 Creates a new multibox instance Framework/MultiBox/MultiBox.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page