SInputKeySelector.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/Margin.h"
#include "Styling/SlateColor.h"
#include "Fonts/SlateFontInfo.h"
#include "Input/Reply.h"
#include "Styling/SlateWidgetStyleAsset.h"
#include "Widgets/DeclarativeSyntaxSupport.h"
#include "Widgets/SCompoundWidget.h"
#include "Styling/SlateTypes.h"
#include "Styling/CoreStyle.h"
#include "Framework/Commands/InputChord.h"
#include "Layout/Visibility.h"
 
class SButton;
class STextBlock;
 
class SInputKeySelector : public SCompoundWidget
{
public:
    DECLARE_DELEGATE_OneParam( FOnKeySelected, const FInputChord& )
    DECLARE_DELEGATE( FOnIsSelectingKeyChanged )
 
    SLATE_BEGIN_ARGS( SInputKeySelector )
        : _SelectedKey( FInputChord(EKeys::Invalid) )
        , _ButtonStyle( &FCoreStyle::Get().GetWidgetStyle<FButtonStyle>( "Button" ) )
        , _TextStyle( &FCoreStyle::Get().GetWidgetStyle< FTextBlockStyle >("NormalText") )
        , _KeySelectionText( NSLOCTEXT("InputKeySelector", "DefaultKeySelectionText", "...") )
        , _NoKeySpecifiedText(NSLOCTEXT("InputKeySelector", "DefaultEmptyText", "Empty"))
        , _AllowModifierKeys( true )
        , _AllowGamepadKeys( false )
        , _EscapeCancelsSelection( true )
        , _IsFocusable(true)
        {}
 
        SLATE_ATTRIBUTE( FInputChord, SelectedKey )
 
        
        SLATE_ATTRIBUTE( FSlateFontInfo, Font )
 
        
        SLATE_ATTRIBUTE( FMargin, Margin )
 
        
        SLATE_STYLE_ARGUMENT( FButtonStyle, ButtonStyle )
 
        
        SLATE_STYLE_ARGUMENT( FTextBlockStyle, TextStyle)
 
        
        SLATE_ARGUMENT( FText, KeySelectionText )
 
        
        SLATE_ARGUMENT(FText, NoKeySpecifiedText)
 
        
        SLATE_ARGUMENT( bool, AllowModifierKeys )
 
        
        SLATE_ARGUMENT( bool, AllowGamepadKeys )
 
        
        SLATE_ARGUMENT( bool, EscapeCancelsSelection )
 
        
        SLATE_ARGUMENT( TArray<FKey>, EscapeKeys )
 
        
        SLATE_EVENT( FOnKeySelected, OnKeySelected )
 
        
        SLATE_EVENT( FOnIsSelectingKeyChanged, OnIsSelectingKeyChanged )
 
        
        SLATE_ARGUMENT(bool, IsFocusable)
    SLATE_END_ARGS()
 
    SLATE_API void Construct( const FArguments& InArgs );
 
public:
 
    SLATE_API FInputChord GetSelectedKey() const;
 
    SLATE_API void SetSelectedKey( TAttribute<FInputChord> InSelectedKey );
 
    SLATE_API void SetMargin( TAttribute<FMargin> InMargin );
 
    SLATE_API void SetButtonStyle( const FButtonStyle* ButtonStyle );
 
    SLATE_API void SetTextStyle(const FTextBlockStyle* InTextStyle);
 
    void SetKeySelectionText( FText InKeySelectionText ) { KeySelectionText = MoveTemp(InKeySelectionText); }
 
    void SetNoKeySpecifiedText(FText InNoKeySpecifiedText) { NoKeySpecifiedText = MoveTemp(InNoKeySpecifiedText); }
 
    void SetAllowModifierKeys(const bool bInAllowModifierKeys) { bAllowModifierKeys = bInAllowModifierKeys; }
 
    void SetAllowGamepadKeys(const bool bInAllowGamepadKeys) { bAllowGamepadKeys = bInAllowGamepadKeys; }
 
    void SetEscapeKeys(TArray<FKey> InEscapeKeys) { EscapeKeys = MoveTemp(InEscapeKeys); }
 
    bool GetIsSelectingKey() const { return bIsSelectingKey; }
 
    SLATE_API void SetTextBlockVisibility(EVisibility InVisibility);
 
public:
 
    SLATE_API virtual FReply OnPreviewKeyDown( const FGeometry& MyGeometry, const FKeyEvent& InKeyEvent ) override;
    SLATE_API virtual FReply OnKeyDown(const FGeometry& MyGeometry, const FKeyEvent& InKeyEvent) override;
    SLATE_API virtual FReply OnKeyUp( const FGeometry& MyGeometry, const FKeyEvent& InKeyEvent ) override;
    SLATE_API virtual FReply OnPreviewMouseButtonDown( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent ) override;
    SLATE_API virtual FReply OnMouseButtonDown(const FGeometry& MyGeometry, const FPointerEvent& MouseEvent) override;
    SLATE_API virtual void OnFocusLost( const FFocusEvent& InFocusEvent ) override;
    SLATE_API virtual FNavigationReply OnNavigation(const FGeometry& MyGeometry, const FNavigationEvent& InNavigationEvent) override;
    virtual bool SupportsKeyboardFocus() const override { return true; }
 
private:
 
    SLATE_API FText GetSelectedKeyText() const;
 
    SLATE_API FMargin GetMargin() const;
 
    SLATE_API FReply OnClicked();
 
    SLATE_API void SelectKey( FKey Key, bool bShiftDown, bool bControllDown, bool bAltDown, bool bCommandDown );
 
    SLATE_API void SetIsSelectingKey(bool bInIsSelectingKey);
 
    SLATE_API bool IsEscapeKey(const FKey& InKey) const;
 
private:
 
    bool bIsSelectingKey;
 
    TAttribute<FInputChord> SelectedKey;
 
    TAttribute<FMargin> Margin;
 
    FText KeySelectionText;
 
    FText NoKeySpecifiedText;
 
    bool bAllowModifierKeys;
 
    bool bAllowGamepadKeys;
 
    bool bEscapeCancelsSelection;
 
    TArray<FKey> EscapeKeys;
 
    FOnKeySelected OnKeySelected;
 
    FOnIsSelectingKeyChanged OnIsSelectingKeyChanged;
 
    TSharedPtr<SButton> Button;
 
    TSharedPtr<STextBlock> TextBlock;
 
    bool bIsFocusable;
};