FMultiBoxBuilder

MultiBox builder

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Slate

Header

/Engine/Source/Runtime/Slate/Public/Framework/MultiBox/MultiBoxBuilder.h

Include

#include "Framework/MultiBox/MultiBoxBuilder.h"

Syntax

class FMultiBoxBuilder

Remarks

MultiBox builder

Variables

Name Description

Protected variable

bool

 

bExtendersEnabled

If extenders are enabled

Protected variable

TArray< TShared...

 

CommandListStack

A stack of command lists which map command infos to delegates that should be called.

Protected variable

TArray< TShared...

 

ExtenderStack

The extender stack holding all the possible extensions for this menu builder

Protected variable

FName

 

MenuName

Name of the menu

Protected variable

TSharedRef< cla...

 

MultiBox

The MultiBox we're building up

Protected variable

FName

 

TutorialHighlightName

Name to identify this widget and highlight during tutorials

Constructors

Name Description

Public function

FMultiBoxBuilder

(
    const EMultiBoxType InType,
    FMultiBoxCustomization InCustomizat...,
    const bool bInShouldCloseWindowAfte...,
    const TSharedPtr< const FUICommandL...,
    TSharedPtr< FExtender > InExtender,
    FName InTutorialHighlightName,
    FName InMenuName
)

Constructor

Destructors

Name Description

Public function Virtual

~FMultiBoxBuilder()

Functions

Name Description

Public function

void

 

AddEditableText

(
    const FText& InLabel,
    const FText& InToolTip,
    const FSlateIcon& InIcon,
    const TAttribute< FText >& InTextA...,
    const FOnTextCommitted& InOnTextCo...,
    const FOnTextChanged& InOnTextChan...,
    bool bInReadOnly
)

Adds an editable text entry

Protected function

void

 

ApplyHook

(
    FName InExtensionHook,
    EExtensionHook::Position HookPositi...
)

Applies any potential extension hooks at the current place

Protected function Virtual

void

 

ApplySectionBeginning()

Applies the beginning of a section, including the header and relevant separator

Public function Const

bool

 

ExtendersEnabled()

Public function Const

FMultiBoxCus...

 

GetCustomization()

Public function

TSharedRef< ...

 

GetMultiBox()

Get the multi-box being built.

Public function Const

const FName ...

 

GetStyleName()

Public function Const

const ISlate...

 

GetStyleSet()

Public function

TSharedPtr< ...

 

GetTopCommandList()

Public function Virtual

TSharedRef< ...

 

MakeWidget

(
    FMultiBox::FOnMakeMultiBoxBuilderOv...,
    uint32 MaxHeight
)

Creates a widget for this MultiBox

Public function

void

 

PopCommandList()

Pops the current command list.

Public function

void

 

PopExtender()

Pops the current extender.

Public function

void

 

PushCommandList

(
    const TSharedRef< const FUICommandL...
)

Pushes a new command list onto the stack.

Public function

void

 

PushExtender

(
    TSharedRef< FExtender > InExtender
)

Pushes a new extender onto the stack.

Public function

void

 

SetExtendersEnabled

(
    bool bEnabled
)

Sets extender support

Public function

void

 

SetStyle

(
    const ISlateStyle* InStyleSet,
    const FName& InStyleName
)

Sets the style to use on the multibox widgets

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