IPinnedCommandList

A list of commands that were 'pinned' by the user, for easy re-use To use the a command list:

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

PinnedCommandList

Header

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

Include

#include "IPinnedCommandList.h"

Syntax

class IPinnedCommandList : public SCompoundWidget

Remarks

A list of commands that were 'pinned' by the user, for easy re-use To use the a command list:

Construct it using CreatePinnedCommandList (using a valid context if you want to persist settings). Optionally call SetStyle after construction to style your widget for its context. Styles are the same concatenated named styles given to menu button items.

Bind one or more command lists to the widget via BindCommandList. This should be done after commands are registered to the FUICommandlist to allow commands to be correctly re-created from persistent settings.

Register one or more custom widgets via RegisterCustomWidget.

If using the FUICommandList_Pinnable, commands should be automatically forwarded to the pinned commands list widget when executed. If not, then the user needs to manually add commands via AddCommand.

If using FUICommandList_Pinnable custom widget interactions will be automatically forwarded to the pinned commands list, but FUICommandList_Pinnable::OnCustomWidgetInteractiondoes need to be called when widgets are interacted with to automatically add the custom widget to the pinned commands list.

Functions

Name Description

Public function

void

 

AddCommand

(
    const TSharedRef< const FUICommandI...,
    const TSharedRef< const FUICommandL...
)

Add a command to the pinned list.

Public function

void

 

AddCustomWidget

(
    FName InCustomWidgetIdentifier
)

Add a previously registered custom widget to the pinned list.

Public function

void

 

BindCommandList

(
    const TSharedRef< const FUICommandL...
)

Bind a command list to this widget.

Public function

void

 

BindCommandList

(
    const TSharedRef< FUICommandList_Pi...
)

Bind a pinnable command list to this widget.

Public function Const

bool

 

HasAnyCommands()

Public function

void

 

RegisterCustomWidget

(
    FOnGenerateCustomWidget InOnGenerat...,
    FName InCustomWidgetIdentifier,
    TAttribute< FText > InCustomWidgetD...,
    FMargin InCustomWidgetPadding,
    bool bInShowLabel
)

Register a custom widget.

Public function

void

 

RemoveAllCommands()

Removes all commands in the list

Public function

void

 

RemoveCommand

(
    const TSharedRef< const FUICommandI...
)

Remove a command from the pinned list.

Public function

void

 

RemoveCustomWidget

(
    FName InCustomWidgetIdentifier
)

Remove a custom widget from the pinned list

Public function

void

 

SetStyle

(
    const ISlateStyle* InStyleSet,
    const FName& InStyleName
)

Set a menu style to use when building command widgets.

Typedefs

Name

Description

FOnGenerateCustomWidget

Delegate used to generate custom 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