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

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

   
Name UInputKeySelector
Type class
Header File /Engine/Source/Runtime/UMG/Public/Components/InputKeySelector.h
Include Path #include "Components/InputKeySelector.h"

Syntax

UCLASS (MinimalAPI)  
class UInputKeySelector : public UWidget

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UInputKeySelector ( const FObjectInitializer& ObjectInitializer
)

   Components/InputKeySelector.h  

Classes

Name Remarks
FOnIsSelectingKeyChanged  
FOnKeySelected  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bAllowGamepadKeys bool When true gamepad keys are allowed in the input chord representing the selected key, otherwise they are ignored. Components/InputKeySelector.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter="AllowGamepadKeys"
  • Setter="SetAllowGamepadKeys"
  • BlueprintSetter="SetAllowGamepadKeys"
  • Category="Key Selection"
bAllowModifierKeys bool When true modifier keys such as control and alt are allowed in the input chord representing the selected key, if false modifier keys are ignored. Components/InputKeySelector.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter="AllowModifierKeys"
  • Setter="SetAllowModifierKeys"
  • BlueprintSetter="SetAllowModifierKeys"
  • Category="Key Selection"
EscapeKeys TArray< FKey > When true gamepad keys are allowed in the input chord representing the selected key, otherwise they are ignored. Components/InputKeySelector.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category="Key Selection"
KeySelectionText FText Sets the text which is displayed while selecting keys. Components/InputKeySelector.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter="SetKeySelectionText"
  • Category=Appearance
Margin FMargin The amount of blank space around the text used to display the currently selected key. Components/InputKeySelector.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category=Appearance
NoKeySpecifiedText FText Sets the text to display when no key text is available or not selecting a key. Components/InputKeySelector.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter="SetNoKeySpecifiedText"
  • Category=Appearance
OnIsSelectingKeyChanged FOnIsSelectingKeyChanged Called whenever the key selection mode starts or stops. Components/InputKeySelector.h
  • BlueprintAssignable
  • Category="Widget Event"
OnKeySelected FOnKeySelected Called whenever a new key is selected by the user. Components/InputKeySelector.h
  • BlueprintAssignable
  • Category="Widget Event"
SelectedKey FInputChord The currently selected key chord. Components/InputKeySelector.h
  • BlueprintReadWrite
  • Getter
  • Setter
  • BlueprintSetter="SetSelectedKey"
  • FieldNotify
  • Category="Key Selection"
TextStyle FTextBlockStyle The button style used at runtime Components/InputKeySelector.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter
  • Setter
  • Category=Appearance
  • Meta=(DisplayName="Text Style")
WidgetStyle FButtonStyle The button style used at runtime Components/InputKeySelector.h
  • EditAnywhere
  • BlueprintReadWrite
  • Getter="GetButtonStyle"
  • Setter="SetButtonStyle"
  • Category=Appearance
  • Meta=(DisplayName="Style")

Protected

Name Type Remarks Include Path Unreal Specifiers
MyInputKeySelector TSharedPtr< SInputKeySelector > The input key selector widget managed by this object. Components/InputKeySelector.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AllowGamepadKeys()

 Returns true if gamepad keys are allowed, otherwise returns false. Components/InputKeySelector.h  

bool AllowModifierKeys()

 Returns true if modifier keys keys are allowed, otherwise returns false. Components/InputKeySelector.h  

const FButtonStyle & GetButtonStyle()

 Returns the style of the button used to start key selection mode. Components/InputKeySelector.h  

bool GetIsSelectingKey()

 Returns true if the widget is currently selecting a key, otherwise returns false. Components/InputKeySelector.h
  • BlueprintCallable
  • Category="Widget"

const FText & GetKeySelectionText()

 Returns the text which is displayed while selecting keys. Components/InputKeySelector.h  

const FMargin & GetMargin()

 Returns the amount of blank space around the text used to display the currently selected key. Components/InputKeySelector.h  

const FText & GetNoKeySpecifiedText()

 Returns the text to display when no key text is available or not selecting a key. Components/InputKeySelector.h  

FInputChord GetSelectedKey()

 Returns the currently selected key. Components/InputKeySelector.h  

const FTextBlockStyle & GetTextStyle()

 Returns the style of the text used inside the button. Components/InputKeySelector.h  

void SetAllowGamepadKeys ( bool bInAllowGamepadKeys
)

 Sets whether or not gamepad keys are allowed in the selected key. Components/InputKeySelector.h
  • BlueprintCallable
  • Category="Widget"

void SetAllowModifierKeys ( bool bInAllowModifierKeys
)

 Sets whether or not modifier keys are allowed in the selected key. Components/InputKeySelector.h
  • BlueprintCallable
  • Category="Widget"

void SetButtonStyle ( const FButtonStyle& ButtonStyle
)

 Sets the style of the button used to start key selection mode. Components/InputKeySelector.h  

void SetButtonStyle ( const FButtonStyle* ButtonStyle
)

 Sets the style of the button used to start key selection mode. Components/InputKeySelector.h  

void SetEscapeKeys ( const TArray< FKey >& InKeys
)

 Sets escape keys. Components/InputKeySelector.h
  • BlueprintCallable
  • Category="Widget"

void SetKeySelectionText ( FText InKeySelectionText
)

 Sets the text which is displayed while selecting keys. Components/InputKeySelector.h
  • BlueprintCallable
  • Category="Widget"

void SetMargin ( const FMargin& InMargin
)

 Sets the amount of blank space around the text used to display the currently selected key. Components/InputKeySelector.h  

void SetNoKeySpecifiedText ( FText InNoKeySpecifiedText
)

 Sets the text to display when no key text is available or not selecting a key. Components/InputKeySelector.h
  • BlueprintCallable
  • Category="Widget"

void SetSelectedKey ( const FInputChord& InSelectedKey
)

 Sets the currently selected key. Components/InputKeySelector.h
  • BlueprintCallable
  • Category="Widget"

void SetTextBlockVisibility ( const ESlateVisibility InVisibility
)

 Sets the visibility of the text block. Components/InputKeySelector.h
  • BlueprintCallable
  • Category="Widget"

void SetTextStyle ( const FTextBlockStyle& InTextStyle
)

 Sets the style of the text used inside the button. Components/InputKeySelector.h  

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual const FText GetPaletteCategory()

 Gets the palette category of the widget Components/InputKeySelector.h  

virtual void SynchronizeProperties ()

 Applies all properties to the native widget if possible. Components/InputKeySelector.h  

Protected

Overridden from UWidget

Name Remarks Include Path Unreal Specifiers

virtual TSharedRef< SWidget > RebuildWidget()

 Function implemented by all subclasses of UWidget is called when the underlying SWidget needs to be constructed. Components/InputKeySelector.h  

Overridden from UVisual

Name Remarks Include Path Unreal Specifiers

virtual void ReleaseSlateResources ( bool bReleaseChildren
)

   Components/InputKeySelector.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void Serialize ( FArchive& Ar
)

   Components/InputKeySelector.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page