1. Epic GamesDeveloper
  3. UInputKeySelector

UInputKeySelector

A widget for selecting a single key or a single key with a modifier.

API > API/Runtime > API/Runtime/UMG > API/Runtime/UMG/Components

Inheritance Hierarchy

References

   
Module UMG
Header /Engine/Source/Runtime/UMG/Public/Components/InputKeySelector.h
Include #include "Components/InputKeySelector.h"

Syntax

class UInputKeySelector : public UWidget

Remarks

A widget for selecting a single key or a single key with a modifier.

Variables

  Type Name Description
Public variable TArray< FKey > EscapeKeys When true gamepad keys are allowed in the input chord representing the selected key, otherwise they are ignored.
Public variable FOnIsSelectingKeyChanged OnIsSelectingKeyChanged Called whenever the key selection mode starts or stops.
Public variable FOnKeySelected OnKeySelected Called whenever a new key is selected by the user.

Constructors

  Type Name Description
Public function  

UInputKeySelector ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const bool Returns true if gamepad keys are allowed, otherwise returns false.
Public function Const bool Returns true if modifier keys keys are allowed, otherwise returns false.
Public function Const const FButtonStyle & Returns the style of the button used to start key selection mode.
Public function Const bool Returns true if the widget is currently selecting a key, otherwise returns false.
Public function Const const FText & Returns the text which is displayed while selecting keys.
Public function Const const FMargin & Returns the amount of blank space around the text used to display the currently selected key.
Public function Const const FText & Returns the text to display when no key text is available or not selecting a key.
Public function Const FInputChord Returns the currently selected key.
Public function Const const FTextBlockStyle & Returns the style of the text used inside the button.
Public function void

SetAllowGamepadKeys ( bool bInAllowGamepadKeys
)

 Sets whether or not gamepad keys are allowed in the selected key.
Public function void

SetAllowModifierKeys ( bool bInAllowModifierKeys
)

 Sets whether or not modifier keys are allowed in the selected key.
Public function void

SetButtonStyle ( const FButtonStyle& ButtonStyle
)

 Sets the style of the button used to start key selection mode.
Public function void

SetEscapeKeys ( const TArray< FKey >& InKeys
)

 Sets escape keys.
Public function void

SetKeySelectionText ( FText InKeySelectionText
)

 Sets the text which is displayed while selecting keys.
Public function void

SetMargin ( const FMargin& InMargin
)

 Sets the amount of blank space around the text used to display the currently selected key.
Public function void

SetNoKeySpecifiedText ( FText InNoKeySpecifiedText
)

 Sets the text to display when no key text is available or not selecting a key.
Public function void

SetSelectedKey ( const FInputChord& InSelectedKey
)

 Sets the currently selected key.
Public function void

SetTextBlockVisibility ( const ESlateVisibility InVisibility
)

 Sets the visibility of the text block.
Public function void

SetTextStyle ( const FTextBlockStyle& InTextStyle
)

 Sets the style of the text used inside the button.

Overridden from UWidget

  Type Name Description
Public function Virtual const FText Gets the palette category of the widget
Protected function Virtual TSharedRef< SWidget > Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed.
Public function Virtual void Applies all properties to the native widget if possible.

Overridden from UVisual

  Type Name Description
Protected function Virtual void

ReleaseSlateResources ( bool bReleaseChildren
)

  

Overridden from UObject

  Type Name Description
Protected function Virtual void Handles reading, writing, and reference collecting using FArchive.

Classes

  Type Name Description
Public class FOnIsSelectingKeyChanged    
Public class FOnKeySelected    

Deprecated Variables

  Type Name Description
Public variable bool bAllowGamepadKeys Direct access to bAllowGamepadKeys is now deprecated. Use the setter or getter.
Public variable bool bAllowModifierKeys Direct access to bAllowModifierKeys is now deprecated. Use the setter or getter.
Public variable FText KeySelectionText Direct access to KeySelectionText is now deprecated. Use the setter or getter.
Public variable FMargin Margin Direct access to Margin is now deprecated. Use the setter or getter.
Public variable FText NoKeySpecifiedText Direct access to NoKeySpecifiedText is now deprecated. Use the setter or getter.
Public variable FInputChord SelectedKey Direct access to SelectedKey is now deprecated. Use the setter or getter.
Public variable FTextBlockStyle TextStyle Direct access to TextStyle is now deprecated. Use the setter or getter.
Public variable FButtonStyle WidgetStyle Direct access to WidgetStyle is now deprecated. Use the setter or getter.

Deprecated Functions

  Type Name Description
Public function void

SetButtonStyle ( const FButtonStyle* ButtonStyle
)

 SetButtonStyle with pointer type parameter is deprecated. Please pass a reference instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page