1. Epic GamesDeveloper
  3. FMultiBoxBuilder

FMultiBoxBuilder

MultiBox builder

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/MultiBoxBuilder.h
Include #include "Framework/MultiBox/MultiBoxBuilder.h"

Syntax

class FMultiBoxBuilder

Remarks

MultiBox builder

Variables

  Type Name Description
Protected variable bool bExtendersEnabled If extenders are enabled
Protected variable FName CheckBoxStyle The override for the checkbox style for this menu
Protected variable TArray< TSharedPtr< const FUICommandList > > CommandListStack A stack of command lists which map command infos to delegates that should be called.
Protected variable TArray< TSharedPtr< class FExtender > > ExtenderStack The extender stack holding all the possible extensions for this menu builder
Protected variable FName MenuName Name of the menu
Protected variable TSharedRef< class FMultiBox > MultiBox The MultiBox we're building up
Protected variable FName TutorialHighlightName Name to identify this widget and highlight during tutorials

Constructors

  Type Name Description
Public function  

FMultiBoxBuilder ( const EMultiBoxType InType,
FMultiBoxCustomization InCustomization,
const bool bInShouldCloseWindowAfterMenuSelection,
const TSharedPtr< const FUICommandList >& InCommandList,
TSharedPtr< FExtender > InExtender,
FName InTutorialHighlightName,
FName InMenuName
)

 Constructor

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

AddEditableText ( const FText& InLabel,
const FText& InToolTip,
const FSlateIcon& InIcon,
const TAttribute< FText >& InTextAttribute,
const FOnTextCommitted& InOnTextCommitted,
const FOnTextChanged& InOnTextChanged,
bool bInReadOnly
)

 Adds an editable text entry
Public function void

AddVerifiedEditableText ( const FText& InLabel,
const FText& InToolTip,
const FSlateIcon& InIcon,
const TAttribute< FText >& InTextAttribute,
const FOnVerifyTextChanged& InOnVerifyTextChanged,
const FOnTextCommitted& InOnTextCommitted,
const FOnTextChanged& InOnTextChanged,
bool bInReadOnly
)

 Adds an editable text entry with a VerifyTextChanged delegate
Protected function void

ApplyHook ( FName InExtensionHook,
EExtensionHook::Position HookPosition
)

 Applies any potential extension hooks at the current place
Protected function Virtual void Applies the beginning of a section, including the header and relevant separator
Public function Const bool  
Public function Const FMultiBoxCustomization  
Public function TSharedRef< class FMultiBox > Get the multi-box being built.
Public function Const const FName &  
Public function Const const ISlateStyle *  
Public function TSharedPtr< const FUICommandList >  
Public function Virtual TSharedRef< class SWidget >

MakeWidget ( FMultiBox::FOnMakeMultiBoxBuilderOverride* InMakeMultiBoxBuilderOverride,
uint32 MaxHeight
)

 Creates a widget for this MultiBox
Public function void Pops the current command list.
Public function void Pops the current extender.
Public function void

PushCommandList ( const TSharedRef< const FUICommandList > CommandList
)

 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

SetCheckBoxStyle ( FName InCheckBoxStyle
)

 The override for the checkbox style
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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page