1. Epic GamesDeveloper
  3. FKeyStructCustomization

FKeyStructCustomization

Implements a details panel customization for [FKey](API\Runtime\InputCore\FKey) structures.

API > API/Editor > API/Editor/DetailCustomizations

Inheritance Hierarchy

References

   
Module DetailCustomizations
Header /Engine/Source/Editor/DetailCustomizations/Public/KeyStructCustomization.h
Include #include "KeyStructCustomization.h"

Syntax

class FKeyStructCustomization : public IPropertyTypeCustomization

Remarks

Implements a details panel customization for FKey structures. As "Key"

Variables

  Type Name Description
Protected variable bool bEnableKeySelector Whether the key selector should be enabled or not
Protected variable FString DefaultKeyName Default Key to assign the KeySelector when it is disabled
Protected variable FText DisabledKeySelectorToolTip Tooltip to display on the actual KeySelector
Protected variable TSharedPtr< SKeySelector > KeySelector Shared pointer to the Key Selector.
Protected variable TSharedPtr< IPropertyHandle > PropertyHandle Holds a handle to the property being edited.

Constructors

  Type Name Description
Public function    
Public function    
Public function    

Functions

  Type Name Description
Public function void

CustomizeHeaderOnlyWithButton ( TSharedRef< class IPropertyHandle > StructPropertyHandle,
FDetailWidgetRow& HeaderRow,
IPropertyTypeCustomizationUtils& StructCustomizationUtils,
TSharedRef< SWidget > Button
)

 Helper variant that generates the key struct in the header and appends a single button at the end TODO: Is there a better way?
Protected function Const TOptional< FKey > Gets the current Key being edited.
Public function Const FString Gets default key name - what key selector will default to if it is disabled
Public function Const FText Gets tooltip on the KeySelector when it is disabled
Public function Const bool Gets bEnableKeySelector bool
Public function Static TSharedRef< IPropertyTypeCustomization > Creates a new instance.
Protected function void

OnKeyChanged ( TSharedPtr< FKey > SelectedKey
)

 Updates the property when a new key is selected.
Public function void Sets default key name - what key selector will default to if it is disabled
Public function void

SetDisabledKeySelectorToolTip ( const FText& InToolTip
)

 Sets tooltip on the KeySelector when it is disabled
Public function void

SetEnableKeySelector ( bool bKeySelectorEnabled
)

 Sets a bool for whether the key selector should be enabled or not
Public function void

SetKey ( const FString& KeyName
)

  

Overridden from IPropertyTypeCustomization

  Type Name Description
Public function Virtual void

CustomizeChildren ( TSharedRef< IPropertyHandle > PropertyHandle,
IDetailChildrenBuilder& ChildBuilder,
IPropertyTypeCustomizationUtils& CustomizationUtils
)

 Called when the children of the property should be customized or extra rows added
Public function Virtual void

CustomizeHeader ( TSharedRef< class IPropertyHandle > PropertyHandle,
FDetailWidgetRow& HeaderRow,
IPropertyTypeCustomizationUtils& CustomizationUtils
)

 Called when the header of the property (the row in the details panel where the property is shown) If nothing is added to the row, the header is not displayed
Public function Virtual Const bool  

Operators

  Type Name Description
Public function FKeyStructCustomization &  
Public function FKeyStructCustomization &  

Deprecated Variables

  Type Name Description
Protected variable bool bDisplayIcon bDisplayIcon is deprecated and the icon has been removed

Deprecated Functions

  Type Name Description
Public function Const bool GetDisplayIcon() is deprecated and the icon referenced has been removed
Public function PRAGMA_DISABLE_DEPRECATION_WARNINGSvoid

SetDisplayIcon ( bool bShouldDisplayIcon
)

 SetDisplayIcon(bShouldDisplayIcon) is deprecated and the icon referenced has been removed

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page