1. Epic GamesDeveloper
  3. SMultiBoxWidget

SMultiBoxWidget

MultiBox Slate widget

API > API/Runtime > API/Runtime/Slate

MultiBox Slate widget

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

Syntax

class SMultiBoxWidget : public SMenuOwner

Inheritance Hierarchy

Structs

Name Remarks
FArguments  
FDraggedMultiBlockPreview A preview of a block being dragged
FFlattenSearchableBlockInfo Contains information about sub-menu block widgets that were pulled and flatten in the parent menu to enable searching the entire menu tree from the top.

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bDidFlattenSearchableBlocks bool Whether the set in FlattenSearchableBlocks has already been populated. Framework/MultiBox/MultiBox.h  
bSearchable bool Whether this multibox can be searched Framework/MultiBox/MultiBox.h  
ClippedHorizontalBox TSharedPtr< class SClippingHorizontalBox > Specialized box widget to handle clipping of toolbars and menubars Framework/MultiBox/MultiBox.h  
ClippedVerticalBox TSharedPtr< class SClippingVerticalBox > Specialized box widget to handle clipping of vertical toolbars Framework/MultiBox/MultiBox.h  
DragPreview FDraggedMultiBlockPreview A preview of a block being dragged inside this box Framework/MultiBox/MultiBox.h  
FinalMultiBoxWidgets TMap< TSharedPtr< SWidget >, TSharedPtr< const FMultiBlock > > The final multibox widgets as they were added to the UI, linked to their original MultiBlocks. Framework/MultiBox/MultiBox.h  
FlattenSearchableBlocks TMap< TSharedPtr< const FMultiBlock >, TSharedPtr< FFlattenSearchableBlockInfo > > The set of searchable blocks found in this multibox sub-menus that were collected and flatten in this multibox to support recursively searching this multibox hierarchy. Framework/MultiBox/MultiBox.h  
FlattenSearchableWidgets TMap< TSharedPtr< SWidget >, TSharedPtr< FFlattenSearchableBlockInfo > > The set of searchable blocks widgets that were added from the list of flatten blocks collecteto display search results from this multibox hierarchy. Framework/MultiBox/MultiBox.h  
LinkedBoxManager TSharedPtr< FLinkedBoxManager > Allows Menu Elementes to size properly Framework/MultiBox/MultiBox.h  
MainHorizontalBox TSharedPtr< SHorizontalBox > Box panel used for horizontally-oriented boxes, e.g., horizontal toolbar or menu bar Framework/MultiBox/MultiBox.h  
MainPanelBox TSharedPtr< SPanel > Box panel used for other boxes, e.g., horizontal wrapping toolbar Framework/MultiBox/MultiBox.h  
MainVerticalBox TSharedPtr< SVerticalBox > Box panel used for vertically-oriented boxes, e.g., vertical toolbar or menu Framework/MultiBox/MultiBox.h  
MaxHeight TAttribute< float > Optional maximum height of widget Framework/MultiBox/MultiBox.h  
MultiBox TSharedPtr< FMultiBox > The MultiBox we're associated with Framework/MultiBox/MultiBox.h  
MultiBoxWidgets TMap< TSharedPtr< SWidget >, TArray< FText > > The multibox widgets that are contained, linked to their searchable text hierarchies. Framework/MultiBox/MultiBox.h  
SearchBlockWidget TSharedPtr< SWidget > The search widget to be displayed at the top of the multibox Framework/MultiBox/MultiBox.h  
SearchText FText The text being searched for Framework/MultiBox/MultiBox.h  
SearchTextWidget TSharedPtr< SSearchBox > The search widget to be displayed at the top of the multibox Framework/MultiBox/MultiBox.h  
SummonedMenuTime double The time when the multibox last summoned a menu Framework/MultiBox/MultiBox.h  
TileViewWidgets TArray< TSharedPtr< SWidget > > An array of widgets used for an STileView if used Framework/MultiBox/MultiBox.h  
UniformToolbarPanel TSharedPtr< SUniformWrapPanel > Specialized box widget to handle clipping of toolbars and menubars Framework/MultiBox/MultiBox.h  
VisibleFlattenHierarchyTips TSet< FString > The list of visible hierarchy tips text (associated with flatten search widgets) in the search result. Framework/MultiBox/MultiBox.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddElement ( TSharedPtr< SWidget > BlockWidget,
FText BlockDisplayText,
bool bInSearchable
)

 Adds a widget to MultiBoxWidgets map, to access and modify its visibility based on search filters Framework/MultiBox/MultiBox.h  

void AddSearchElement ( TSharedPtr< SWidget >,
FText
)

 Adds a widget to SearchElement map, making the widget searchable Framework/MultiBox/MultiBox.h  

void BeginSearch ( const TCHAR InChar
)

 Starts a search and makes the search box visible Framework/MultiBox/MultiBox.h  

void BuildMultiBoxWidget()

 Builds this MultiBox widget up from the MultiBox associated with it Framework/MultiBox/MultiBox.h  

void Construct ( const FArguments& InArgs
)

 Construct this widget Framework/MultiBox/MultiBox.h  

void FilterMultiBoxEntries()

 Changes visibility of widgets in the multibox Framework/MultiBox/MultiBox.h  

TSharedRef< ITableRow > GenerateTiles ( TSharedPtr< SWidget > Item,
const TSharedRef< STableViewBase >& OwnerTable
)

 Generates the tiles for an STileView for button rows Framework/MultiBox/MultiBox.h  

EVisibility GetCustomizationBorderDragVisibility ( const FName InBlockName,
const EMultiBlockType InBlockType,
bool& bOutInsertAfter
) const

   Framework/MultiBox/MultiBox.h  

EVisibility GetCustomizationVisibility ( TWeakPtr< const FMultiBlock > BlockWeakPtr,
TWeakPtr< SWidget > BlockWidgetWeakPtr
) const

   Framework/MultiBox/MultiBox.h  

float GetItemHeight()

   Framework/MultiBox/MultiBox.h  

float GetItemWidth()

 Gets the maximum item width and height of the consituent widgets Framework/MultiBox/MultiBox.h  

TSharedRef< FLinkedBoxManager > GetLinkedBoxManager()

   Framework/MultiBox/MultiBox.h  

TSharedRef< const FMultiBox > GetMultiBox()

 Access the MultiBox associated with this widget Framework/MultiBox/MultiBox.h  

bool GetSearchable()

 Gets the searchable state of this multibox Framework/MultiBox/MultiBox.h  

FText GetSearchText()

 Get the text to search by Framework/MultiBox/MultiBox.h  

TSharedPtr< SWidget > GetSearchTextWidget()

 Get the SSearchText widget holding the search text Framework/MultiBox/MultiBox.h  

const FName & GetStyleName()

   Framework/MultiBox/MultiBox.h  

const ISlateStyle * GetStyleSet()

   Framework/MultiBox/MultiBox.h  

double GetSummonedMenuTime()

   Framework/MultiBox/MultiBox.h  

bool IsBlockBeingDragged ( TSharedPtr< const FMultiBlock > Block
) const

   Framework/MultiBox/MultiBox.h  

void OnCustomCommandDragEnter ( TSharedRef< const FMultiBlock > MultiBlock,
const FGeometry& MyGeometry,
const FDragDropEvent& DragDropEvent
)

 Called when a user drags a UI command into a multiblock in this widget Framework/MultiBox/MultiBox.h  

void OnCustomCommandDragged ( TSharedRef< const FMultiBlock > MultiBlock,
const FGeometry& MyGeometry,
const FDragDropEvent& DragDropEvent
)

 Called when a user drags a UI command within multiblock in this widget Framework/MultiBox/MultiBox.h  

void OnCustomCommandDropped()

 Called when a user drops a UI command in this widget Framework/MultiBox/MultiBox.h  

void OnDropExternal()

 Called after a drag was initiated from this box but was dropped elsewhere Framework/MultiBox/MultiBox.h  

TSharedRef< SWidget > OnWrapButtonClicked()

 Event handler for clicking the wrap button Framework/MultiBox/MultiBox.h  

void ResetSearch()

 Resets the search to be empty Framework/MultiBox/MultiBox.h  

void SetContent ( TSharedRef< SWidget > InContent
)

 Sets new content for the SMultiBoxWidget Framework/MultiBox/MultiBox.h  

void SetMaxHeight ( TAttribute< float > InMaxHeight
)

 Sets optional maximum height of widget Framework/MultiBox/MultiBox.h  

void SetMultiBox ( TSharedRef< FMultiBox > InMultiBox
)

 Associates this widget with a MultiBox Framework/MultiBox/MultiBox.h  

void SetSearchable ( bool bSearchable
)

 Sets the searchable state of this multibox Framework/MultiBox/MultiBox.h  

void SetSearchBlockWidget ( TSharedPtr< SWidget >
)

 Set the block widget holding the search text Framework/MultiBox/MultiBox.h  

void SetSummonedMenuTime ( double InSummonedMenuTime
)

 Records the time that the multibox last summoned a menu Framework/MultiBox/MultiBox.h  

bool ShouldShowMenuSearchField()

   Framework/MultiBox/MultiBox.h  

void UpdateMultiBoxWidget ( TSharedRef< FMultiBox > InMultiBox
)

 Rebuilds this MultiBox widget using the input MultiBox Framework/MultiBox/MultiBox.h  

Overridden from SWidget

Name Remarks Include Path Unreal Specifiers

virtual FReply OnDragOver ( const FGeometry& MyGeometry,
const FDragDropEvent& DragDropEvent
)

 SWidget interface Framework/MultiBox/MultiBox.h  

virtual FReply OnDrop ( const FGeometry& MyGeometry,
const FDragDropEvent& DragDropEvent
)

   Framework/MultiBox/MultiBox.h  

virtual void OnFocusChanging ( const FWeakWidgetPath& PreviousFocusPath,
const FWidgetPath& NewWidgetPath,
const FFocusEvent& InFocusEvent
)

   Framework/MultiBox/MultiBox.h  

virtual FReply OnFocusReceived ( const FGeometry& MyGeometry,
const FFocusEvent& InFocusEvent
)

   Framework/MultiBox/MultiBox.h  

virtual FReply OnKeyChar ( const FGeometry& MyGeometry,
const FCharacterEvent& InCharacterEvent
)

   Framework/MultiBox/MultiBox.h  

virtual FReply OnKeyDown ( const FGeometry& MyGeometry,
const FKeyEvent& KeyEvent
)

   Framework/MultiBox/MultiBox.h  

virtual bool OnVisualizeTooltip ( const TSharedPtr< SWidget >& TooltipContent
)

   Framework/MultiBox/MultiBox.h  

virtual bool SupportsKeyboardFocus()

   Framework/MultiBox/MultiBox.h  

Static

Name Remarks Include Path Unreal Specifiers

static FReply FocusNextWidget ( EUINavigation NavigationType
)

 Helper function used to transfer focus to the next/previous widget 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