1. Epic GamesDeveloper
  3. FMultiBlock

FMultiBlock

MultiBlock (abstract). Wraps a "block" of useful UI functionality that can be added to a MultiBox.

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 FMultiBlock : public TSharedFromThis< FMultiBlock >

Remarks

MultiBlock (abstract). Wraps a "block" of useful UI functionality that can be added to a MultiBox.

Constructors

  Type Name Description
Public function  

FMultiBlock ( const FMultiBlockParams& InMultiBlockParams
)

 Constructor
Public function  

FMultiBlock ( const TSharedPtr< const FUICommandInfo > InCommand,
TSharedPtr< const FUICommandList > InCommandList,
FName InExtensionHook,
EMultiBlockType InType,
bool bInIsPartOfHeading
)

 Constructor
Public function  

FMultiBlock ( const FUIAction& InAction,
FName InExtensionHook,
EMultiBlockType InType,
bool bInIsPartOfHeading,
TSharedPtr< const FUICommandList > InCommandList
)

 Constructor

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual Const void

CreateMenuEntry ( FMenuBuilder& MenuBuilder
)

 Creates a menu entry that is representative of this block
Public function Const TSharedPtr< const FUICommandInfo > Returns the action associated with this block
Public function Const TSharedPtr< const FUICommandList > Returns the action list associated with this block
Public function Const const FUIAction & Returns the direct actions for this block. Delegates may be unbound if this block has a UICommand
Public function Const FName Gets the extension hook so users can see what hooks are where
Public function Const bool Gets the searchable state of this block
Public function Const FName Gets the style name which will be used for this block instead of the owning multibox's style
Public function Const FName Get the tutorial highlight name for this menu entry
Public function Const const EMultiBlockType

GetType ()

 Gets the type of this MultiBox
Public function Virtual Const bool

HasIcon ()

  
Public function Virtual Const bool  
Public function Virtual Const bool Group blocks interface
Public function Const bool Is this block a heading block or a block that belongs to a heading such as a separator
Public function Const bool Is this block a separator
Public function Const TSharedRef< class IMultiBlockBaseWidget >

MakeWidget ( TSharedRef< class SMultiBoxWidget > InOwnerMultiBoxWidget,
EMultiBlockLocation::Type InLocation,
bool bSectionContainsIcons,
TSharedPtr< SWidget > OptionsBlockWidget
)

 Creates a MultiBlock widget for this MultiBlock
Public function void

SetSearchable ( bool bSearchable
)

 Sets the searchable state of this block
Public function void

SetStyleNameOverride ( FName InStyleNameOverride
)

 Sets the style name which will be used for this block instead of the owning multibox's style
Public function void

SetTutorialHighlightName ( FName InTutorialName
)

 Set the tutorial highlight name for this menu entry

Classes

  Type Name Description
Public struct FMultiBlockParams    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page