FMultiBlock

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

Windows
MacOS
Linux

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

Name Description

Public function

FMultiBlock

(
    const TSharedPtr< const FUICommandI...,
    TSharedPtr< const FUICommandList > ...,
    FName InExtensionHook,
    EMultiBlockType InType,
    bool bInIsPartOfHeading
)

Constructor

Public function

FMultiBlock

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

Constructor

UI action delegates that should be used in place of UI commands (dynamic menu items)

Destructors

Name Description

Public function Virtual

~FMultiBlock()

Functions

Name Description

Public function Virtual Const

void

 

CreateMenuEntry

(
    FMenuBuilder& MenuBuilder
)

Creates a menu entry that is representative of this block

Public function Const

TSharedPtr< ...

 

GetAction()

Returns the action associated with this block

Public function Const

TSharedPtr< ...

 

GetActionList()

Returns the action list associated with this block

Public function Const

const FUIAct...

 

GetDirectActions()

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

Public function Const

FName

 

GetExtensionHook()

Gets the extension hook so users can see what hooks are where

Public function Const

bool

 

GetSearchable()

Gets the searchable state of this block

Public function Const

FName

 

GetTutorialHighlightName()

Get the tutorial highlight name for this menu entry

Public function Const

const EMulti...

 

GetType()

Gets the type of this MultiBox

Public function Virtual Const

bool

 

HasIcon()

Public function Virtual Const

bool

 

IsGroupEndBlock()

Public function Virtual Const

bool

 

IsGroupStartBlock()

Group blocks interface

Public function Const

bool

 

IsPartOfHeading()

Is this block a heading block or a block that belongs to a heading such as a separator

Public function Const

bool

 

IsSeparator()

Is this block a separator

Public function Const

TSharedRef< ...

 

MakeWidget

(
    TSharedRef< class SMultiBoxWidget >...,
    EMultiBlockLocation::Type InLocatio...,
    bool bSectionContainsIcons
)

Creates a MultiBlock widget for this MultiBlock

Public function

void

 

SetSearchable

(
    bool bSearchable
)

Sets the searchable state of this block

Public function

void

 

SetTutorialHighlightName

(
    FName InTutorialName
)

Set the tutorial highlight name for this menu entry

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss