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

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

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

Syntax

class FMultiBlock : public TSharedFromThis< FMultiBlock >

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

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

 Constructor Framework/MultiBox/MultiBox.h  

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

 Constructor Framework/MultiBox/MultiBox.h  

FMultiBlock ( const FMultiBlockParams& InMultiBlockParams
)

 Constructor Framework/MultiBox/MultiBox.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FMultiBlock()

   Framework/MultiBox/MultiBox.h  

Structs

Name Remarks
FMultiBlockParams  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
Action const TSharedPtr< const FUICommandInfo > The action associated with this block (can be null for some actions) Framework/MultiBox/MultiBox.h  
ActionList const TSharedPtr< const FUICommandList > The list of mappings from command info to delegates that should be called. Framework/MultiBox/MultiBox.h  
bIsPartOfHeading bool Whether this block is part of the heading blocks for a section Framework/MultiBox/MultiBox.h  
bSearchable bool Whether this block can be searched Framework/MultiBox/MultiBox.h  
DirectActions FUIAction Direct processing of actions. Framework/MultiBox/MultiBox.h  
ExtensionHook FName Optional extension hook which is used for debug display purposes, so users can see what hooks are where Framework/MultiBox/MultiBox.h  
ResizeParams TAttribute< FMenuEntryResizeParams > Resize parameters which determine how this block behaves during toolbar resizing. Framework/MultiBox/MultiBox.h  
StyleNameOverride FName   Framework/MultiBox/MultiBox.h  
TutorialHighlightName FName Name to identify a widget for tutorials Framework/MultiBox/MultiBox.h  
Type EMultiBlockType Type of MultiBlock Framework/MultiBox/MultiBox.h  
VisibilityOverride TAttribute< EVisibility > Visibility override which, if set and returning anything but Visible, takes priority over other methods of determining visibility. Framework/MultiBox/MultiBox.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void CreateMenuEntry ( FMenuBuilder& MenuBuilder
) const

 Creates a menu entry that is representative of this block Framework/MultiBox/MultiBox.h  

TSharedPtr< const FUICommandInfo > GetAction()

 Returns the action associated with this block Framework/MultiBox/MultiBox.h  

TSharedPtr< const FUICommandList > GetActionList()

 Returns the action list associated with this block Framework/MultiBox/MultiBox.h  

const FUIAction & GetDirectActions()

 Returns the direct actions for this block. Delegates may be unbound if this block has a UICommand Framework/MultiBox/MultiBox.h  

FName GetExtensionHook()

 Gets the extension hook so users can see what hooks are where Framework/MultiBox/MultiBox.h  

const TAttribute< FMenuEntryResizeParams > & GetResizeParams()

 Get the resize parameters which determine how this block behaves during toolbar resizing. Framework/MultiBox/MultiBox.h  

bool GetSearchable()

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

FName GetStyleNameOverride()

 Gets the style name which will be used for this block instead of the owning multibox's style Framework/MultiBox/MultiBox.h  

FName GetTutorialHighlightName()

 Get the tutorial highlight name for this menu entry Framework/MultiBox/MultiBox.h  

const EMultiBlockType GetType()

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

TAttribute< EVisibility > GetVisibilityOverride()

 Get the visibility override for this block. Framework/MultiBox/MultiBox.h  

virtual bool HasIcon()

   Framework/MultiBox/MultiBox.h  

virtual bool IsGroupEndBlock()

   Framework/MultiBox/MultiBox.h  

virtual bool IsGroupStartBlock()

 Group blocks interface Framework/MultiBox/MultiBox.h  

bool IsPartOfHeading()

 Is this block a heading block or a block that belongs to a heading such as a separator Framework/MultiBox/MultiBox.h  

bool IsSeparator()

 Is this block a separator Framework/MultiBox/MultiBox.h  

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

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

void SetResizeParams ( const TAttribute< FMenuEntryResizeParams >& InResizeParams
)

 Set the resize parameters which determine how this block behaves during toolbar resizing. Framework/MultiBox/MultiBox.h  

void SetSearchable ( bool bSearchable
)

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

void SetStyleNameOverride ( FName InStyleNameOverride
)

 Sets the style name which will be used for this block instead of the owning multibox's style Framework/MultiBox/MultiBox.h  

void SetTutorialHighlightName ( FName InTutorialName
)

 Set the tutorial highlight name for this menu entry Framework/MultiBox/MultiBox.h  

void SetVisibilityOverride ( TAttribute< EVisibility > InVisibilityOverride
)

 Set the visibility override for this block. 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