UICommandList.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "InputCoreTypes.h"
#include "Layout/Visibility.h"
#include "Framework/Commands/UIAction.h"
#include "Framework/Commands/UICommandInfo.h"
 
struct FKeyEvent;
struct FPointerEvent;
 
class FUICommandList
    : public TSharedFromThis<FUICommandList>
{
public:
 
    virtual ~FUICommandList() {}
 
    DECLARE_DELEGATE_RetVal_OneParam(bool, FCanProduceActionForCommand, const TSharedRef<const FUICommandInfo>& /*Command*/);
 
    SLATE_API void MapAction( const TSharedPtr< const FUICommandInfo > InUICommandInfo, FExecuteAction ExecuteAction, EUIActionRepeatMode RepeatMode = EUIActionRepeatMode::RepeatDisabled );
 
    SLATE_API void MapAction( const TSharedPtr< const FUICommandInfo > InUICommandInfo, FExecuteAction ExecuteAction, FCanExecuteAction CanExecuteAction, EUIActionRepeatMode RepeatMode = EUIActionRepeatMode::RepeatDisabled );
 
    SLATE_API void MapAction( const TSharedPtr< const FUICommandInfo > InUICommandInfo, FExecuteAction ExecuteAction, FCanExecuteAction CanExecuteAction, FIsActionChecked IsCheckedDelegate, EUIActionRepeatMode RepeatMode = EUIActionRepeatMode::RepeatDisabled );
 
    SLATE_API void MapAction( const TSharedPtr< const FUICommandInfo > InUICommandInfo, FExecuteAction ExecuteAction, FCanExecuteAction CanExecuteAction, FGetActionCheckState GetActionCheckState, EUIActionRepeatMode RepeatMode = EUIActionRepeatMode::RepeatDisabled );
 
    SLATE_API void MapAction( const TSharedPtr< const FUICommandInfo > InUICommandInfo, FExecuteAction ExecuteAction, FCanExecuteAction CanExecuteAction, FIsActionChecked IsCheckedDelegate, FIsActionButtonVisible IsVisibleDelegate, EUIActionRepeatMode RepeatMode = EUIActionRepeatMode::RepeatDisabled );
 
    SLATE_API void MapAction( const TSharedPtr< const FUICommandInfo > InUICommandInfo, FExecuteAction ExecuteAction, FCanExecuteAction CanExecuteAction, FGetActionCheckState GetActionCheckState, FIsActionButtonVisible IsVisibleDelegate, EUIActionRepeatMode RepeatMode = EUIActionRepeatMode::RepeatDisabled );
 
    SLATE_API virtual void MapAction( const TSharedPtr< const FUICommandInfo > InUICommandInfo, const FUIAction& InUIAction );
 
    SLATE_API virtual void MapAction(const TSharedPtr< const FUICommandInfo > InUICommandInfo, const FUIAction& InUIAction, const FUIActionContext& InUIActionContext);
 
    SLATE_API void Append( const TSharedRef<FUICommandList>& InCommandsToAppend );
 
    SLATE_API void UnmapAction( const TSharedPtr< const FUICommandInfo > InUICommandInfo );
 
    SLATE_API bool IsActionMapped( const TSharedPtr< const FUICommandInfo > InUICommandInfo ) const;
 
    SLATE_API virtual bool ExecuteAction( const TSharedRef< const FUICommandInfo > InUICommandInfo ) const;
 
    SLATE_API bool CanExecuteAction( const TSharedRef< const FUICommandInfo > InUICommandInfo ) const;
 
    SLATE_API bool TryExecuteAction( const TSharedRef< const FUICommandInfo > InUICommandInfo ) const;
 
    SLATE_API EVisibility GetVisibility( const TSharedRef< const FUICommandInfo > InUICommandInfo ) const;
 
    SLATE_API ECheckBoxState GetCheckState( const TSharedRef< const FUICommandInfo > InUICommandInfo ) const;
 
    SLATE_API bool ProcessCommandBindings( const FKeyEvent& InKeyEvent ) const;
 
    SLATE_API bool ProcessCommandBindings( const FPointerEvent& InMouseEvent ) const;
 
    SLATE_API bool ProcessCommandBindings( const FKey Key, const FModifierKeysState& ModifierKeysState, const bool bRepeat ) const;
 
    void SetCanProduceActionForCommand( const FCanProduceActionForCommand& NewCanProduceActionForCommand ) { CanProduceActionForCommand = NewCanProduceActionForCommand; }
 
    SLATE_API const FUIAction* GetActionForCommand(TSharedPtr<const FUICommandInfo> Command) const;
 
    SLATE_API const FUIActionContext* GetContextForCommand(TSharedPtr<const FUICommandInfo> Command) const;
 
protected:
 
    SLATE_API bool ConditionalProcessCommandBindings( const FKey Key, bool bCtrl, bool bAlt, bool bShift, bool bCmd, bool bRepeat ) const;
 
    SLATE_API const FUIAction* GetActionForCommandRecursively(const TSharedRef<const FUICommandInfo>& Command, bool bIncludeChildren, bool bIncludeParents, TSet<TSharedRef<const FUICommandList>>& InOutVisitedLists) const;
 
    SLATE_API const FUIActionContext* GetContextForCommandRecursively(const TSharedRef<const FUICommandInfo>& Command, bool bIncludeChildren, bool bIncludeParents, TSet<TSharedRef<const FUICommandList>>& InOutVisitedLists) const;
 
    SLATE_API void GatherContextsForList(TSet<FName>& OutAllContexts) const;
 
    SLATE_API void GatherContextsForListRecursively(TSet<FName>& OutAllContexts, TSet<TSharedRef<const FUICommandList>>& InOutVisitedLists) const;
 
private:
 
    using FUIBindingMap = TMap<const TSharedPtr<const FUICommandInfo>, FUIAction>;
    using FUIContextMap = TMap<const TSharedPtr<const FUICommandInfo>, FUIActionContext>;
    
    TSet<FName> ContextsInList;
 
    FUIBindingMap UICommandBindingMap;
 
    FUIContextMap UICommandContextMap;
 
    TArray<TWeakPtr<FUICommandList>> ParentUICommandLists;
    TArray<TWeakPtr<FUICommandList>> ChildUICommandLists;
 
    FCanProduceActionForCommand CanProduceActionForCommand;
 
    friend struct RecursiveCommandDataGetter;
};