Navigation
API > API/Editor > API/Editor/DetailCustomizations
Implements a details panel customization for FKey structures. As "Key"
| Name | FKeyStructCustomization |
| Type | class |
| Header File | /Engine/Source/Editor/DetailCustomizations/Public/KeyStructCustomization.h |
| Include Path | #include "KeyStructCustomization.h" |
Syntax
class FKeyStructCustomization : public IPropertyTypeCustomization
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FKeyStructCustomization() |
KeyStructCustomization.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| HeaderRow | FDetailWidgetRow & | KeyStructCustomization.h | ||
| override | FDetailWidgetRowIPropertyTypeCustomizationUtils &StructCustomizationUtils | KeyStructCustomization.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CustomizeHeaderOnlyWithButton
(
TSharedRef< class IPropertyHandle > StructPropertyHandle, |
Helper variant that generates the key struct in the header and appends a single button at the end TODO: Is there a better way? | KeyStructCustomization.h | |
FString GetDefaultKeyName() |
Gets default key name - what key selector will default to if it is disabled | KeyStructCustomization.h | |
FText GetDisabledKeySelectorToolTip() |
Gets tooltip on the KeySelector when it is disabled | KeyStructCustomization.h | |
bool GetDisplayIcon() |
Gets bDisplayIcon bool | KeyStructCustomization.h | |
bool GetEnableKeySelector() |
Gets bEnableKeySelector bool | KeyStructCustomization.h | |
void SetDefaultKeyName
(
FString KeyName |
Sets default key name - what key selector will default to if it is disabled | KeyStructCustomization.h | |
void SetDisabledKeySelectorToolTip
(
const FText& InToolTip |
Sets tooltip on the KeySelector when it is disabled | KeyStructCustomization.h | |
PRAGMA_DISABLE_DEPRECATION_WARNINGS void SetDisplayIcon
(
bool bShouldDisplayIcon |
Sets a bool for whether the information Icon for a combo trigger is displayed or not | KeyStructCustomization.h | |
PRAGMA_ENABLE_DEPRECATION_WARNINGS void SetEnableKeySelector
(
bool bKeySelectorEnabled |
Sets a bool for whether the key selector should be enabled or not | KeyStructCustomization.h | |
void SetKey
(
const FString& KeyName |
KeyStructCustomization.h | ||
UE_NONCOPYABLE
(
FKeyStructCustomization |
KeyStructCustomization.h |
Overridden from IPropertyTypeCustomization
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CustomizeChildren
(
TSharedRef< IPropertyHandle > StructPropertyHandle, |
KeyStructCustomization.h | ||
virtual bool ShouldInlineKey() |
KeyStructCustomization.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| Gets the current Key being edited. | KeyStructCustomization.h | ||
void OnKeyChanged
(
TSharedPtr< FKey > SelectedKey |
Updates the property when a new key is selected. | KeyStructCustomization.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TSharedRef< IPropertyTypeCustomization > MakeInstance() |
Creates a new instance. | KeyStructCustomization.h |