FUICommandList_Pinnable

Extended version of [FUICommandList](API\Runtime\Slate\Framework\Commands\FUICommandList) that allows:

Windows
MacOS
Linux

Inheritance Hierarchy

TSharedFromThis

FUICommandList

FUICommandList_Pinnable

References

Module

PinnedCommandList

Header

/Engine/Source/Editor/PinnedCommandList/Public/UICommandList_Pinnable.h

Include

#include "UICommandList_Pinnable.h"

Syntax

class FUICommandList_Pinnable : public FUICommandList

Remarks

Extended version of FUICommandList that allows:

  • Hooks into action dispatch, to allow commands to be forwarded for pinning

  • Indexing when mapping to provide a sort key

  • Optional grouping of actions

Variables

Name Description

Protected variable

TMap< FName, FN...

 

CommandGroupMap

Map providing a group for each command that was mapped via this command list

Protected variable

TMap< FName, in...

 

CommandIndexMap

Map providing an index for each command that was mapped via this command list

Protected variable

int32

 

CurrentActionIndex

Index used to provide a sort key for actions when mapped

Protected variable

FName

 

CurrentGroupName

Current group name

Protected variable

FOnCustomWidget...

 

OnCustomWidgetInteractionDelegate

Delegate called when a custom widget is interacted with

Protected variable

FOnExecuteActio...

 

OnExecuteActionDelegate

Delegate called when an action is executed

Constructors

Name Description

Public function

FUICommandList_Pinnable()

Functions

Name Description

Public function

void

 

BeginGroup

(
    FName InGroupName
)

Start a group scope.

Public function

void

 

EndGroup()

End a group scope.

Public function Const

FName

 

GetMappedCommandGroup

(
    FName InCommandName
)

Get the group this command was mapped into.

Public function Const

int32

 

GetMappedCommandIndex

(
    FName InCommandName
)

Get the index this command was mapped to.

Public function

FOnCustomWid...

 

OnCustomWidgetInteraction()

Delegate called when an custom widget is interacted with

Public function

FOnExecuteAc...

 

OnExecuteAction()

Delegate called when an action is executed

Public function Const

void

 

WidgetInteraction

(
    FName InCustomWidgetIdentifier
)

Mark that a custom widget was interacted with

Overridden from FUICommandList

Name Description

Public function Virtual Const

bool

 

ExecuteAction

(
    const TSharedRef< const FUICommandI...
)

FUICommandList interface

Public function Virtual

void

 

MapAction

(
    const TSharedPtr< const FUICommandI...,
    const FUIAction& InUIAction
)

Maps a command info to a series of delegates that are executed by a multibox or mouse/keyboard input

Typedefs

Name

Description

FOnCustomWidgetInteraction

Delegate called when a custom widget is interacted with

FOnExecuteAction

Delegate called when an action is executed

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