Advanced Menu System  1.0
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
UKeyBindingWidget Class Reference

Input setting line widget. More...

#include <KeyBindingWidget.h>

+ Inheritance diagram for UKeyBindingWidget:

Public Member Functions

 DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam (FOnKeySelected, FInputChord, SelectedKey)
 
 DECLARE_DYNAMIC_MULTICAST_DELEGATE (FOnIsSelectingKeyChanged)
 
 UKeyBindingWidget (const FObjectInitializer &ObjectInitializer)
 
virtual void NativeConstruct () override
 
virtual void SynchronizeProperties () override
 
void CheckInputType ()
 
void SetSelectedKey (const FInputChord &InSelectedKey)
 
FInputChord GetSelectedKey () const
 
void SetKeySelectionText (FText InKeySelectionText)
 
const FText & GetKeySelectionText () const
 
void SetNoKeySpecifiedText (FText InNoKeySpecifiedText)
 
const FText & GetNoKeySpecifiedText () const
 
void SetAllowModifierKeys (bool bInAllowModifierKeys)
 
bool AllowModifierKeys () const
 
void SetAllowGamepadKeys (bool bInAllowGamepadKeys)
 
bool AllowGamepadKeys () const
 
bool GetIsSelectingKey () const
 
void SetSelectionBlockVisibility (const ESlateVisibility InVisibility)
 
void SetButtonStyle (const FButtonStyle &ButtonStyle)
 
void SetButtonStyle (const FButtonStyle *ButtonStyle)
 
const FButtonStyle & GetButtonStyle () const
 
void SetTextStyle (const FTextBlockStyle &InTextStyle)
 
const FTextBlockStyle & GetTextStyle () const
 
void SetMargin (const FMargin &InMargin)
 
const FMargin & GetMargin () const
 
void SetEscapeKeys (const TArray< FKey > &InKeys)
 
void UpdateIcon (FInputChord Key)
 
- Public Member Functions inherited from USettingsParamBase
 USettingsParamBase (const FObjectInitializer &ObjectInitializer)
 
virtual void NativeConstruct () override
 
virtual void SynchronizeProperties () override
 
virtual void PostLoad () override
 
void SetTitleText (FText Text)
 
void SetTitleTextColor (FColor Color)
 
void SetTitleTextFont (FSlateFontInfo Font)
 
void UpdateTextBlock ()
 

Public Attributes

class UInputKeySelector * InputKeySelector
 
EKeyBindingTypes Type
 
FButtonStyle WidgetButtonStyle
 
FTextBlockStyle TextStyle
 
FInputChord SelectedKey
 
FMargin Margin
 
FText KeySelectionText
 
FText NoKeySpecifiedText
 
bool bAllowModifierKeys
 
bool bAllowGamepadKeys
 
TArray< FKey > EscapeKeys
 
FOnKeySelected OnKeySelected
 
FOnIsSelectingKeyChanged OnIsSelectingKeyChanged
 
EKeyBindingTypes KeyBindingType
 
TArray< FButtonIconButtonIcons
 
- Public Attributes inherited from USettingsParamBase
class UTextBlock * TitleTextBlock
 
FText TitleText
 
FColor TitleTextColor
 
FSlateFontInfo TitleTextFont
 

Detailed Description

Input setting line widget.

Constructor & Destructor Documentation

◆ UKeyBindingWidget()

UKeyBindingWidget::UKeyBindingWidget ( const FObjectInitializer &  ObjectInitializer)

Member Function Documentation

◆ AllowGamepadKeys()

bool UKeyBindingWidget::AllowGamepadKeys ( ) const

Returns true if gamepad keys are allowed, otherwise returns false.

◆ AllowModifierKeys()

bool UKeyBindingWidget::AllowModifierKeys ( ) const

Returns true if modifier keys keys are allowed, otherwise returns false.

◆ CheckInputType()

void UKeyBindingWidget::CheckInputType ( )

◆ DECLARE_DYNAMIC_MULTICAST_DELEGATE()

UKeyBindingWidget::DECLARE_DYNAMIC_MULTICAST_DELEGATE ( FOnIsSelectingKeyChanged  )

◆ DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam()

UKeyBindingWidget::DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam ( FOnKeySelected  ,
FInputChord  ,
SelectedKey   
)

◆ GetButtonStyle()

const FButtonStyle & UKeyBindingWidget::GetButtonStyle ( ) const

Returns the style of the button used to start key selection mode.

◆ GetIsSelectingKey()

bool UKeyBindingWidget::GetIsSelectingKey ( ) const

Returns true if the widget is currently selecting a key, otherwise returns false.

◆ GetKeySelectionText()

const FText & UKeyBindingWidget::GetKeySelectionText ( ) const

Returns the text which is displayed while selecting keys.

◆ GetMargin()

const FMargin & UKeyBindingWidget::GetMargin ( ) const

Returns the amount of blank space around the text used to display the currently selected key.

◆ GetNoKeySpecifiedText()

const FText & UKeyBindingWidget::GetNoKeySpecifiedText ( ) const

Returns the text to display when no key text is available or not selecting a key.

◆ GetSelectedKey()

FInputChord UKeyBindingWidget::GetSelectedKey ( ) const

Returns the currently selected key.

◆ GetTextStyle()

const FTextBlockStyle & UKeyBindingWidget::GetTextStyle ( ) const

Returns the style of the text used inside the button.

◆ NativeConstruct()

void UKeyBindingWidget::NativeConstruct ( )
overridevirtual

Reimplemented from USettingsParamBase.

◆ SetAllowGamepadKeys()

void UKeyBindingWidget::SetAllowGamepadKeys ( bool  bInAllowGamepadKeys)

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

◆ SetAllowModifierKeys()

void UKeyBindingWidget::SetAllowModifierKeys ( bool  bInAllowModifierKeys)

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

◆ SetButtonStyle() [1/2]

void UKeyBindingWidget::SetButtonStyle ( const FButtonStyle &  ButtonStyle)

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

◆ SetButtonStyle() [2/2]

void UKeyBindingWidget::SetButtonStyle ( const FButtonStyle *  ButtonStyle)

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

◆ SetEscapeKeys()

void UKeyBindingWidget::SetEscapeKeys ( const TArray< FKey > &  InKeys)

Sets escape keys.

◆ SetKeySelectionText()

void UKeyBindingWidget::SetKeySelectionText ( FText  InKeySelectionText)

Sets the text which is displayed while selecting keys.

◆ SetMargin()

void UKeyBindingWidget::SetMargin ( const FMargin &  InMargin)

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

◆ SetNoKeySpecifiedText()

void UKeyBindingWidget::SetNoKeySpecifiedText ( FText  InNoKeySpecifiedText)

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

◆ SetSelectedKey()

void UKeyBindingWidget::SetSelectedKey ( const FInputChord &  InSelectedKey)

Sets the currently selected key.

◆ SetSelectionBlockVisibility()

void UKeyBindingWidget::SetSelectionBlockVisibility ( const ESlateVisibility  InVisibility)

Sets the visibility of the text block.

◆ SetTextStyle()

void UKeyBindingWidget::SetTextStyle ( const FTextBlockStyle &  InTextStyle)

Sets the style of the text used inside the button.

◆ SynchronizeProperties()

void UKeyBindingWidget::SynchronizeProperties ( )
overridevirtual

Reimplemented from USettingsParamBase.

◆ UpdateIcon()

void UKeyBindingWidget::UpdateIcon ( FInputChord  Key)

Member Data Documentation

◆ bAllowGamepadKeys

bool UKeyBindingWidget::bAllowGamepadKeys

When true gamepad keys are allowed in the input chord representing the selected key, otherwise they are ignored.

◆ bAllowModifierKeys

bool UKeyBindingWidget::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.

◆ ButtonIcons

TArray<FButtonIcon> UKeyBindingWidget::ButtonIcons

◆ EscapeKeys

TArray<FKey> UKeyBindingWidget::EscapeKeys

When true gamepad keys are allowed in the input chord representing the selected key, otherwise they are ignored.

◆ InputKeySelector

class UInputKeySelector* UKeyBindingWidget::InputKeySelector

◆ KeyBindingType

EKeyBindingTypes UKeyBindingWidget::KeyBindingType

◆ KeySelectionText

FText UKeyBindingWidget::KeySelectionText

Sets the text which is displayed while selecting keys.

◆ Margin

FMargin UKeyBindingWidget::Margin

The amount of blank space around the text used to display the currently selected key.

◆ NoKeySpecifiedText

FText UKeyBindingWidget::NoKeySpecifiedText

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

◆ OnIsSelectingKeyChanged

FOnIsSelectingKeyChanged UKeyBindingWidget::OnIsSelectingKeyChanged

Called whenever the key selection mode starts or stops.

◆ OnKeySelected

FOnKeySelected UKeyBindingWidget::OnKeySelected

Called whenever a new key is selected by the user.

◆ SelectedKey

FInputChord UKeyBindingWidget::SelectedKey

The currently selected key chord.

◆ TextStyle

FTextBlockStyle UKeyBindingWidget::TextStyle

The button style used at runtime

◆ Type

EKeyBindingTypes UKeyBindingWidget::Type

◆ WidgetButtonStyle

FButtonStyle UKeyBindingWidget::WidgetButtonStyle