InputKeySelector.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "Framework/Commands/InputChord.h"
#include "Fonts/SlateFontInfo.h"
#include "Layout/Margin.h"
#include "Widgets/SWidget.h"
#include "Components/Widget.h"
#include "Styling/SlateTypes.h"
#include "Layout/Visibility.h"
#include "InputKeySelector.generated.h"
 
class SInputKeySelector;
struct FButtonStyle;
 
UCLASS(MinimalAPI)
class UInputKeySelector : public UWidget
{
    GENERATED_UCLASS_BODY()
 
public:
    DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam( FOnKeySelected, FInputChord, SelectedKey );
    DECLARE_DYNAMIC_MULTICAST_DELEGATE( FOnIsSelectingKeyChanged );
 
public:
    UE_DEPRECATED(5.2, "Direct access to WidgetStyle is now deprecated. Use the setter or getter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter = "GetButtonStyle", Setter = "SetButtonStyle", Category = Appearance, meta = (DisplayName = "Style"))
    FButtonStyle WidgetStyle;
 
    UE_DEPRECATED(5.2, "Direct access to TextStyle is now deprecated. Use the setter or getter.")
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Getter, Setter, Category = Appearance, meta = (DisplayName = "Text Style"))
    FTextBlockStyle TextStyle;
 
    UE_DEPRECATED(5.2, "Direct access to SelectedKey is now deprecated. Use the setter or getter.")
    UPROPERTY( BlueprintReadWrite, Getter, Setter, BlueprintSetter = "SetSelectedKey", FieldNotify, Category = "Key Selection")
    FInputChord SelectedKey;
 
    UE_DEPRECATED(5.2, "Direct access to Margin is now deprecated. Use the setter or getter.")
    UPROPERTY( EditAnywhere, BlueprintReadWrite, Getter, Setter, Category = Appearance )
    FMargin Margin;
 
    UE_DEPRECATED(5.2, "Direct access to KeySelectionText is now deprecated. Use the setter or getter.")
    UPROPERTY( EditAnywhere, BlueprintReadWrite, Getter, Setter, BlueprintSetter = "SetKeySelectionText", Category = Appearance )
    FText KeySelectionText;
 
    UE_DEPRECATED(5.2, "Direct access to NoKeySpecifiedText is now deprecated. Use the setter or getter.")
    UPROPERTY( EditAnywhere, BlueprintReadWrite, Getter, Setter, BlueprintSetter = "SetNoKeySpecifiedText", Category = Appearance )
    FText NoKeySpecifiedText;
 
    UE_DEPRECATED(5.2, "Direct access to bAllowModifierKeys is now deprecated. Use the setter or getter.")
    UPROPERTY( EditAnywhere, BlueprintReadWrite, Getter = "AllowModifierKeys", Setter = "SetAllowModifierKeys", BlueprintSetter = "SetAllowModifierKeys", Category = "Key Selection")
    bool bAllowModifierKeys;
 
    UE_DEPRECATED(5.2, "Direct access to bAllowGamepadKeys is now deprecated. Use the setter or getter.")
    UPROPERTY( EditAnywhere, BlueprintReadWrite, Getter = "AllowGamepadKeys", Setter = "SetAllowGamepadKeys", BlueprintSetter = "SetAllowGamepadKeys", Category = "Key Selection")
    bool bAllowGamepadKeys;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category = "Key Selection")
    TArray<FKey> EscapeKeys;
 
public:
    UPROPERTY( BlueprintAssignable, Category = "Widget Event" )
    FOnKeySelected OnKeySelected;
 
    UPROPERTY( BlueprintAssignable, Category = "Widget Event" )
    FOnIsSelectingKeyChanged OnIsSelectingKeyChanged;
 
    UFUNCTION( BlueprintCallable, Category = "Widget" )
    UMG_API void SetSelectedKey(const FInputChord& InSelectedKey);
 
    UMG_API FInputChord GetSelectedKey() const;
 
    UFUNCTION( BlueprintCallable, Category = "Widget" )
    UMG_API void SetKeySelectionText( FText InKeySelectionText );
 
    UMG_API const FText& GetKeySelectionText() const;
 
    UFUNCTION(BlueprintCallable, Category = "Widget")
    UMG_API void SetNoKeySpecifiedText(FText InNoKeySpecifiedText);
 
    UMG_API const FText& GetNoKeySpecifiedText() const;
 
    UFUNCTION(BlueprintCallable, Category = "Widget" )
    UMG_API void SetAllowModifierKeys(bool bInAllowModifierKeys );
 
    UMG_API bool AllowModifierKeys() const;
 
    UFUNCTION(BlueprintCallable, Category = "Widget")
    UMG_API void SetAllowGamepadKeys(bool bInAllowGamepadKeys);
 
    UMG_API bool AllowGamepadKeys() const;
 
    UFUNCTION( BlueprintCallable, Category = "Widget" )
    UMG_API bool GetIsSelectingKey() const;
 
    UFUNCTION(BlueprintCallable, Category = "Widget")
    UMG_API void SetTextBlockVisibility(const ESlateVisibility InVisibility);
 
    UMG_API void SetButtonStyle(const FButtonStyle& ButtonStyle);
 
    UE_DEPRECATED(5.2, "SetButtonStyle with pointer type parameter is deprecated. Please pass a reference instead.")
    UMG_API void SetButtonStyle(const FButtonStyle* ButtonStyle);
 
    UMG_API const FButtonStyle& GetButtonStyle() const;
 
    UMG_API void SetTextStyle(const FTextBlockStyle& InTextStyle);
 
    UMG_API const FTextBlockStyle& GetTextStyle() const;
 
    UMG_API void SetMargin(const FMargin& InMargin);
 
    UMG_API const FMargin& GetMargin() const;
 
    UFUNCTION(BlueprintCallable, Category = "Widget")
    UMG_API void SetEscapeKeys(const TArray<FKey>& InKeys);
 
    //~ Begin UWidget Interface
#if WITH_EDITOR 
    UMG_API virtual const FText GetPaletteCategory() override;
#endif
    UMG_API virtual void SynchronizeProperties() override;
    //~ End UWidget Interface
 
protected:
    //~ Begin UObject Interface
    UMG_API virtual void Serialize(FArchive& Ar) override;
    //~ End UObject Interface
 
    //~ Begin UWidget Interface
    UMG_API virtual TSharedRef<SWidget> RebuildWidget() override;
    //~ End UWidget Interface
 
    //~ Begin UVisual Interface
    UMG_API virtual void ReleaseSlateResources(bool bReleaseChildren) override;
    //~ End UVisual Interface
 
private:
    UMG_API virtual void HandleKeySelected(const FInputChord& InSelectedKey);
    void HandleIsSelectingKeyChanged();
 
private:
    TSharedPtr<SInputKeySelector> MyInputKeySelector;
};