FUICommandList

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

Slate

Header

/Engine/Source/Runtime/Slate/Public/Framework/Commands/UICommandList.h

Include

#include "Framework/Commands/UICommandList.h"

Syntax

class FUICommandList : public TSharedFromThis< FUICommandList >

Destructors

Name Description

Public function Virtual

~FUICommandList()

Virtual destructor

Functions

Name Description

Public function

void

 

Append

(
    const TSharedRef< FUICommandList >& InCommandsToAppend
)

Append commands in InCommandsToAppend to this command list.

Public function Const

bool

 

CanExecuteAction

(
    const TSharedRef< const FUICommandInfo > InUICommandInfo
)

Calls the CanExecuteAction associated with the provided command info to see if ExecuteAction can be called

Protected function Const

bool

 

ConditionalProcessCommandBindings

(
    const FKey Key,
    bool bCtrl,
    bool bAlt,
    bool bShift,
    bool bCmd,
    bool bRepeat
)

Helper function to execute delegate or exec command associated with a command (if valid)

Public function Virtual Const

bool

 

ExecuteAction

(
    const TSharedRef< const FUICommandInfo > InUICommandInfo
)

Executes the action associated with the provided command info Note: It is assumed at this point that CanExecuteAction was already checked

Protected function Const

void

 

GatherContextsForList

(
    TSet< FName >& OutAllContexts
)

Returns all contexts associated with this list.

Protected function Const

void

 

GatherContextsForListRecursively

(
    TSet< FName >& OutAllContexts,
    TSet< TSharedRef< const FUICommandList >>& InOutVisitedLists
)

Returns all contexts associated with this list.

Public function Const

const FUIAction *

 

GetActionForCommand

(
    TSharedPtr< const FUICommandInfo > Command
)

Attempts to find an action for the specified command in the current UICommandList.

Protected function Const

const FUIAction *

 

GetActionForCommandRecursively

(
    const TSharedRef< const FUICommandInfo >& Command,
    bool bIncludeChildren,
    bool bIncludeParents,
    TSet< TSharedRef< const FUICommandList >>& InOutVisitedLists
)

Attempts to find an action for the specified command in the current UICommandList.

Public function Const

ECheckBoxState

 

GetCheckState

(
    const TSharedRef< const FUICommandInfo > InUICommandInfo
)

Calls the GetCheckState delegate to see if the visualization of this command in a multibox should appear checked

Public function Const

EVisibility

 

GetVisibility

(
    const TSharedRef< const FUICommandInfo > InUICommandInfo
)

Calls the IsVisible delegate associated with the provided command info to see if the command should be visible in a toolbar

Public function Const

bool

 

IsActionMapped

(
    const TSharedPtr< const FUICommandInfo > InUICommandInfo
)

Checks if an action is already mapped

Public function

void

 

MapAction

(
    const TSharedPtr< const FUICommandInfo > InUICommandInfo,
    FExecuteAction ExecuteAction,
    FCanExecuteAction CanExecuteAction,
    FGetActionCheckState GetActionCheckState,
    FIsActionButtonVisible IsVisibleDelegate,
    EUIActionRepeatMode RepeatMode
)

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

Public function

void

 

MapAction

(
    const TSharedPtr< const FUICommandInfo > InUICommandInfo,
    FExecuteAction ExecuteAction,
    FCanExecuteAction CanExecuteAction,
    FIsActionChecked IsCheckedDelegate,
    FIsActionButtonVisible IsVisibleDelegate,
    EUIActionRepeatMode RepeatMode
)

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

Public function Virtual

void

 

MapAction

(
    const TSharedPtr< const FUICommandInfo > InUICommandInfo,
    const FUIAction& InUIAction
)

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

Public function

void

 

MapAction

(
    const TSharedPtr< const FUICommandInfo > InUICommandInfo,
    FExecuteAction ExecuteAction,
    EUIActionRepeatMode RepeatMode
)

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

Public function

void

 

MapAction

(
    const TSharedPtr< const FUICommandInfo > InUICommandInfo,
    FExecuteAction ExecuteAction,
    FCanExecuteAction CanExecuteAction,
    EUIActionRepeatMode RepeatMode
)

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

Public function

void

 

MapAction

(
    const TSharedPtr< const FUICommandInfo > InUICommandInfo,
    FExecuteAction ExecuteAction,
    FCanExecuteAction CanExecuteAction,
    FIsActionChecked IsCheckedDelegate,
    EUIActionRepeatMode RepeatMode
)

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

Public function

void

 

MapAction

(
    const TSharedPtr< const FUICommandInfo > InUICommandInfo,
    FExecuteAction ExecuteAction,
    FCanExecuteAction CanExecuteAction,
    FGetActionCheckState GetActionCheckState,
    EUIActionRepeatMode RepeatMode
)

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

Public function Const

bool

 

ProcessCommandBindings

(
    const FKeyEvent& InKeyEvent
)

Processes any UI commands which are activated by the specified key event

Public function Const

bool

 

ProcessCommandBindings

(
    const FKey Key,
    const FModifierKeysState& ModifierKeysState,
    const bool bRepeat
)

Processes any UI commands which are activated by the specified key, modifier keys state and input event

Public function Const

bool

 

ProcessCommandBindings

(
    const FPointerEvent& InMouseEvent
)

Processes any UI commands which are activated by the specified mouse event

Public function

void

 

SetCanProduceActionForCommand

(
    const FCanProduceActionForCommand& NewCanProduceActionForCommand
)

Sets the delegate that determines if this UICommandList is capable of producing an action for the supplied command

Public function Const

bool

 

TryExecuteAction

(
    const TSharedRef< const FUICommandInfo > InUICommandInfo
)

Attempts to execute the action associated with the provided command info Note: This will check if the action can be executed before finally executing the action

Public function

void

 

UnmapAction

(
    const TSharedPtr< const FUICommandInfo > InUICommandInfo
)

Unmaps a command info that was previously mapped

Typedefs

Name

Description

FCanProduceActionForCommand

Determines if this UICommandList is capable of producing an action for the supplied command

FUIBindingMap

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback