UICommandInfo.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Misc/Attribute.h"
#include "InputCoreTypes.h"
#include "Layout/Visibility.h"
#include "Textures/SlateIcon.h"
#include "Trace/SlateMemoryTags.h"
#include "Framework/Commands/InputChord.h"
#include "UICommandInfo.generated.h"
 
class FBindingContext;
class FUICommandInfo;
 
UENUM(BlueprintType)
enum class EUserInterfaceActionType : uint8
{
    None,
 
    Button,
 
    ToggleButton,
        
    RadioButton,
 
    Check,
 
    CollapsedButton
};
 
UENUM()
enum class EMultipleKeyBindingIndex : uint8
{
    Primary = 0,
    Secondary,
    NumChords
};
 
class FUICommandInfo;
 
 
class FUICommandInfoDecl
{
    friend class FBindingContext;
 
public:
 
    SLATE_API FUICommandInfoDecl& DefaultChord( const FInputChord& InDefaultChord, const EMultipleKeyBindingIndex InChordIndex = EMultipleKeyBindingIndex::Primary);
    SLATE_API FUICommandInfoDecl& UserInterfaceType( EUserInterfaceActionType InType );
    SLATE_API FUICommandInfoDecl& Icon( const FSlateIcon& InIcon );
    SLATE_API FUICommandInfoDecl& Description( const FText& InDesc );
 
    SLATE_API operator TSharedPtr<FUICommandInfo>() const;
    SLATE_API operator TSharedRef<FUICommandInfo>() const;
 
public:
 
    SLATE_API FUICommandInfoDecl( const TSharedRef<class FBindingContext>& InContext, const FName InCommandName, const FText& InLabel, const FText& InDesc, const FName InBundle = NAME_None);
 
private:
 
    TSharedPtr<class FUICommandInfo> Info;
    const TSharedRef<FBindingContext>& Context;
};
 
DECLARE_MULTICAST_DELEGATE_OneParam(FOnBindingContextChanged, const FBindingContext&);
 
class FBindingContext
    : public TSharedFromThis<FBindingContext>
{
public:
    FBindingContext( const FName InContextName, const FText& InContextDesc, const FName InContextParent, const FName InStyleSetName )
        : ContextName( InContextName )
        , ContextParent( InContextParent )
        , ContextDesc( InContextDesc )
        , StyleSetName( InStyleSetName )
    {
        check(!InStyleSetName.IsNone());
    }
 
    FBindingContext(const FBindingContext&) = default;
    FBindingContext(FBindingContext&&) = default;
    FBindingContext& operator=(const FBindingContext&) = default;
    FBindingContext& operator=(FBindingContext&&) = default;
 
    SLATE_API FUICommandInfoDecl NewCommand( const FName InCommandName, const FText& InCommandLabel, const FText& InCommandDesc );
 
    FName GetContextName() const { return ContextName; }
 
    FName GetContextParent() const { return ContextParent; }
 
    FName GetStyleSetName() const { return StyleSetName; }
 
    const FText& GetContextDesc() const { return ContextDesc; }
 
    SLATE_API void AddBundle(const FName Name, const FText& Desc);
 
    SLATE_API const FText& GetBundleLabel(const FName Name);
 
    friend uint32 GetTypeHash( const FBindingContext& Context )
    {
        return GetTypeHash( Context.ContextName );
    }
 
    bool operator==( const FBindingContext& Other ) const
    {
        return ContextName == Other.ContextName;
    }
 
    static SLATE_API FOnBindingContextChanged CommandsChanged;
 
private:
 
    FName ContextName;
 
    FName ContextParent;
 
    FText ContextDesc;
 
    FName StyleSetName;
 
    TMap<FName, FText> Bundles;
};
 
 
class FUICommandInfo
{
    friend class FInputBindingManager;
    friend class FUICommandInfoDecl;
 
public:
 
    SLATE_API FUICommandInfo(const FName InBindingContext);
 
    SLATE_API const FText GetInputText() const;
 
    const TSharedRef<const FInputChord> GetActiveChord(const EMultipleKeyBindingIndex InChordIndex) const { return ActiveChords[static_cast<uint8>(InChordIndex)]; }
    
    const bool HasActiveChord(const FInputChord InChord) const { return *ActiveChords[static_cast<uint8>(EMultipleKeyBindingIndex::Primary)] == InChord ||
                                                                    *ActiveChords[static_cast<uint8>(EMultipleKeyBindingIndex::Secondary)] == InChord; }
 
    const TSharedRef<const FInputChord> GetFirstValidChord() const {
        return ActiveChords[static_cast<uint8>(EMultipleKeyBindingIndex::Primary)]->IsValidChord()
                ? ActiveChords[static_cast<uint8>(EMultipleKeyBindingIndex::Primary)]
                : ActiveChords[static_cast<uint8>(EMultipleKeyBindingIndex::Secondary)];
    }
 
    const bool HasDefaultChord(const FInputChord InChord) const {
        return (DefaultChords[static_cast<uint8>(EMultipleKeyBindingIndex::Primary)] == InChord) ||
            (DefaultChords[static_cast<uint8>(EMultipleKeyBindingIndex::Secondary)] == InChord);
    }
 
    const FInputChord& GetDefaultChord(const EMultipleKeyBindingIndex InChordIndex) const { return DefaultChords[static_cast<uint8>(InChordIndex)]; }
 
    static SLATE_API void MakeCommandInfo( const TSharedRef<class FBindingContext>& InContext, TSharedPtr< FUICommandInfo >& OutCommand, const FName InCommandName, const FText& InCommandLabel, const FText& InCommandDesc, const FSlateIcon& InIcon, const EUserInterfaceActionType InUserInterfaceType, const FInputChord& InDefaultChord, const FInputChord& InAlternateDefaultChord = FInputChord(), const FName InBundle = NAME_None);
 
    static SLATE_API void UnregisterCommandInfo(const TSharedRef<class FBindingContext>& InContext, const TSharedRef<FUICommandInfo>& InCommand);
 
    const FText& GetLabel() const { return Label; }
 
    const FText& GetDescription() const { return Description; }
 
    const FSlateIcon& GetIcon() const { return Icon; }
 
    EUserInterfaceActionType GetUserInterfaceType() const { return UserInterfaceType; }
    
    FName GetCommandName() const { return CommandName; }
 
    FName GetBindingContext() const { return BindingContext; }
 
    FName GetBundle() const { return Bundle; }
 
    bool GetUseLongDisplayName() const { return bUseLongDisplayName; }
 
    void SetUseLongDisplayName(const bool bInUseLongDisplayName) { bUseLongDisplayName = bInUseLongDisplayName; }
 
    SLATE_API void SetActiveChord( const FInputChord& NewChord, const EMultipleKeyBindingIndex InChordIndex );
 
    SLATE_API void RemoveActiveChord(const EMultipleKeyBindingIndex InChordIndex);
 
    SLATE_API TSharedRef<class SToolTip> MakeTooltip( const TAttribute<FText>& InText = TAttribute<FText>() , const TAttribute< EVisibility >& InToolTipVisibility = TAttribute<EVisibility>()) const;
 
private:
 
    TArray<TSharedRef<FInputChord>> ActiveChords;
 
    FText Label;
 
    FText Description;
 
    TArray<FInputChord> DefaultChords;
 
    FSlateIcon Icon;
 
    FName UIStyle;
 
    FName CommandName;
 
    FName BindingContext;
 
    FName Bundle;
 
    EUserInterfaceActionType UserInterfaceType;
 
    bool bUseLongDisplayName;
};