1. Epic GamesDeveloper
  3. SMultiBoxWidget

SMultiBoxWidget

MultiBox Slate widget

API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Framework > API/Runtime/Slate/Framework/MultiBox

Inheritance Hierarchy

References

   
Module Slate
Header /Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBox.h
Include #include "Framework/MultiBox/MultiBox.h"

Syntax

class SMultiBoxWidget : public SMenuOwner

Remarks

MultiBox Slate widget

Functions

  Type Name Description
Public function 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
Public function void

BeginSearch ( const TCHAR InChar
)

 Starts a search and makes the search box visible
Public function void Builds this MultiBox widget up from the MultiBox associated with it
Public function void

Construct ( const FArguments& InArgs
)

 Construct this widget
Public function void Changes visibility of widgets in the multibox
Public function Static FReply

FocusNextWidget ( EUINavigation NavigationType
)

 Helper function used to transfer focus to the next/previous widget
Public function TSharedRef< ITableRow >

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

 Generates the tiles for an STileView for button rows
Public function Const EVisibility

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

  
Public function Const EVisibility

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

  
Public function Const float  
Public function Const float Gets the maximum item width and height of the consituent widgets
Public function TSharedRef< FLinkedBoxManager >  
Public function Const TSharedRef< const FMultiBox > Access the MultiBox associated with this widget
Public function Const bool Gets the searchable state of this multibox
Public function Const FText Get the text to search by
Public function TSharedPtr< SWidget > Get the SSearchText widget holding the search text
Public function Const const FName &  
Public function Const const ISlateStyle *  
Public function Const double  
Public function Const bool  
Public function 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
Public function 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
Public function void Called when a user drops a UI command in this widget
Public function void Called after a drag was initiated from this box but was dropped elsewhere
Public function TSharedRef< SWidget > Event handler for clicking the wrap button
Public function void Resets the search to be empty
Public function void

SetContent ( TSharedRef< SWidget > InContent
)

 Sets new content for the SMultiBoxWidget
Public function void

SetMaxHeight ( TAttribute< float > InMaxHeight
)

 Sets optional maximum height of widget
Public function void

SetMultiBox ( TSharedRef< FMultiBox > InMultiBox
)

 Associates this widget with a MultiBox
Public function void

SetSearchable ( bool bSearchable
)

 Sets the searchable state of this multibox
Public function void Set the block widget holding the search text
Public function void

SetSummonedMenuTime ( double InSummonedMenuTime
)

 Records the time that the multibox last summoned a menu

Overridden from SWidget

  Type Name Description
Public function Virtual FReply

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

 SWidget interface
Public function Virtual FReply

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

 Called when the user is dropping something onto a widget; terminates drag and drop.
Public function Virtual FReply

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

 KEY INPUT Called when focus is given to this widget. This event does not bubble.
Public function Virtual FReply

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

 Called after a character is entered while this widget has keyboard focus
Public function Virtual FReply

OnKeyDown ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

 Called after a key is pressed when this widget has focus (this event bubbles if not handled)
Public function Virtual bool

OnVisualizeTooltip ( const TSharedPtr< SWidget >& TooltipContent
)

 Called when Slate wants to visualize tooltip.
Public function Virtual Const bool Checks to see if this widget supports keyboard focus. Override this in derived classes.

Classes

  Type Name Description
Public struct FArguments    

Deprecated Functions

  Type Name Description
Public function void AddSearchElement is deprecated as non-searchable elements also need to be stored, use AddElement instead

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page