1. Epic GamesDeveloper
  3. UInputKeySelector

UInputKeySelector

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

Unreal Engine C++ API Reference > Runtime > UMG > Components

Inheritance Hierarchy

References

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

Syntax

UCLASS (MinimalAPI)  
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 UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter bool bAllowGamepadKeys When true gamepad keys are allowed in the input chord representing the selected key, otherwise they are ignored.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter bool bAllowModifierKeys 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.
Public variable UProperty Category, EditAnywhere BlueprintReadOnly TArray< FKey > EscapeKeys When true gamepad keys are allowed in the input chord representing the selected key, otherwise they are ignored.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter FText KeySelectionText Sets the text which is displayed while selecting keys.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite getter, setter FMargin Margin The amount of blank space around the text used to display the currently selected key.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite blueprintsetter, getter, setter FText NoKeySpecifiedText Sets the text to display when no key text is available or not selecting a key.
Public variable UProperty Category BlueprintAssignable FOnIsSelectingKeyChanged OnIsSelectingKeyChanged Called whenever the key selection mode starts or stops.
Public variable UProperty Category BlueprintAssignable FOnKeySelected OnKeySelected Called whenever a new key is selected by the user.
Public variable UProperty Category BlueprintReadWrite blueprintsetter, fieldnotify, getter, setter FInputChord SelectedKey The currently selected key chord.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter FTextBlockStyle TextStyle The button style used at runtime
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite getter, setter FButtonStyle WidgetStyle The button style used at runtime

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 UFunction BlueprintCallable, Category 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.
Protected function Virtual void

Serialize ( FArchive& Ar
)

  
Public function UFunction BlueprintCallable, Category void

SetAllowGamepadKeys ( bool bInAllowGamepadKeys
)

 Sets whether or not gamepad keys are allowed in the selected key.
Public function UFunction BlueprintCallable, Category 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

SetButtonStyle ( const FButtonStyle* ButtonStyle
)

 Sets the style of the button used to start key selection mode.
Public function UFunction BlueprintCallable, Category void

SetEscapeKeys ( const TArray< FKey >& InKeys
)

 Sets escape keys.
Public function UFunction BlueprintCallable, Category 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 UFunction BlueprintCallable, Category void

SetNoKeySpecifiedText ( FText InNoKeySpecifiedText
)

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

SetSelectedKey ( const FInputChord& InSelectedKey
)

 Sets the currently selected key.
Public function UFunction BlueprintCallable, Category 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
)

  

Classes

  Type Name Description
Public class FOnIsSelectingKeyChanged    
Public class FOnKeySelected    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page