Navigation
API > API/Editor > API/Editor/PinnedCommandList
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
| Name | FUICommandList_Pinnable |
| Type | class |
| Header File | /Engine/Source/Editor/PinnedCommandList/Public/UICommandList_Pinnable.h |
| Include Path | #include "UICommandList_Pinnable.h" |
Syntax
class FUICommandList_Pinnable : public FUICommandList
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FUICommandList → FUICommandList_Pinnable
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FUICommandList_Pinnable() |
UICommandList_Pinnable.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnCustomWidgetInteraction | TMulticastDelegate_TwoParams< void, FName, const TSharedRef< const FUICommandList_Pinnable > & > | Delegate called when a custom widget is interacted with | UICommandList_Pinnable.h |
| FOnExecuteAction | TMulticastDelegate_TwoParams< void, const TSharedRef< const FUICommandInfo > &, const TSharedRef< const FUICommandList_Pinnable > & > | Delegate called when an action is executed | UICommandList_Pinnable.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BeginGroup
(
FName InGroupName |
Start a group scope. | UICommandList_Pinnable.h | |
void EndGroup () |
End a group scope. | UICommandList_Pinnable.h | |
virtual bool ExecuteAction
(
const TSharedRef< const FUICommandInfo > InUICommandInfo |
FUICommandList interface | UICommandList_Pinnable.h | |
FName GetMappedCommandGroup
(
FName InCommandName |
Get the group this command was mapped into. | UICommandList_Pinnable.h | |
int32 GetMappedCommandIndex
(
FName InCommandName |
Get the index this command was mapped to. | UICommandList_Pinnable.h | |
virtual void MapAction
(
const TSharedPtr< const FUICommandInfo > InUICommandInfo, |
UICommandList_Pinnable.h | ||
FOnCustomWidgetInteraction & OnCustomWidgetInteraction() |
Delegate called when an custom widget is interacted with | UICommandList_Pinnable.h | |
FOnExecuteAction & OnExecuteAction() |
Delegate called when an action is executed | UICommandList_Pinnable.h | |
void WidgetInteraction
(
FName InCustomWidgetIdentifier |
Mark that a custom widget was interacted with | UICommandList_Pinnable.h |