FKeyStructCustomization

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

Windows
MacOS
Linux

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" <SKeySelector>

Variables

Name Description

Protected variable

TSharedPtr < IPr ...

 

PropertyHandle

Holds a handle to the property being edited.

Functions

Name Description

Public function

void

 

CustomizeHeaderOnlyWithButton

(
    TSharedRef < class IPropertyHandle >...,
    FDetailWidgetRow & HeaderRow,
    IPropertyTypeCustomizationUtils & S...,
    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 < F ...

 

GetCurrentKey()

Gets the current Key being edited.

Public function Static

TSharedRef < ...

 

MakeInstance()

Creates a new instance.

Protected function

void

 

OnKeyChanged

(
    TSharedPtr < FKey > SelectedKey
)

Updates the property when a new key is selected.

Overridden from IPropertyTypeCustomization

Name Description

Public function Virtual

void

 

CustomizeChildren

(
    TSharedRef < IPropertyHandle > Prope...,
    IDetailChildrenBuilder & ChildBuild...,
    IPropertyTypeCustomizationUtils & C...
)

Called when the children of the property should be customized or extra rows added

Public function Virtual

void

 

CustomizeHeader

(
    TSharedRef < class IPropertyHandle >...,
    FDetailWidgetRow & HeaderRow,
    IPropertyTypeCustomizationUtils & C...
)

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

 

ShouldInlineKey()

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback