Navigation
Unreal Engine C++ API Reference > Editor > DetailCustomizations
Inheritance Hierarchy
References
Module | DetailCustomizations |
Header | /Engine/Source/Editor/DetailCustomizations/Public/KeyStructCustomization.h |
Include | #include "KeyStructCustomization.h" |
Syntax
class FKeyStructCustomization : public [IPropertyTypeCustomization](API\Editor\PropertyEditor\IPropertyTypeCustomization)
Remarks
Implements a details panel customization for FKey structures. As "Key"
Variables
Type | Name | Description |
---|---|---|
bool | bEnableKeySelector | Whether the key selector should be enabled or not |
FString | DefaultKeyName | Default Key to assign the KeySelector when it is disabled |
FText | DisabledKeySelectorToolTip | Tooltip to display on the actual KeySelector |
TSharedPtr< SKe... | KeySelector | Shared pointer to the Key Selector. |
TSharedPtr< IPr... | PropertyHandle | Holds a handle to the property being edited. |
Constructors
Type | Name | Description |
---|---|---|
FKeyStructCustomization () | ||
FKeyStructCustomization ( FKeyStructCustomization&& ) | ||
FKeyStructCustomization ( const FKeyStructCustomization& ) |
Functions
Type | Name | Description |
---|---|---|
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? |
TOptional< F... | GetCurrentKey () | Gets the current Key being edited. |
FString | GetDefaultKeyName () | Gets default key name - what key selector will default to if it is disabled |
FText | GetDisabledKeySelectorToolTip () | Gets tooltip on the KeySelector when it is disabled |
bool | GetEnableKeySelector () | Gets bEnableKeySelector bool |
TSharedRef< ... | MakeInstance () | Creates a new instance. |
void | OnKeyChanged ( TSharedPtr< FKey > SelectedKey ) | Updates the property when a new key is selected. |
void | SetDefaultKeyName ( FString KeyName ) | Sets default key name - what key selector will default to if it is disabled |
void | SetDisabledKeySelectorToolTip ( const FText& InToolTip ) | Sets tooltip on the KeySelector when it is disabled |
void | SetEnableKeySelector ( bool bKeySelectorEnabled ) | Sets a bool for whether the key selector should be enabled or not |
void | SetKey ( const FString& KeyName ) |
Overridden from IPropertyTypeCustomization
Type | Name | Description |
---|---|---|
void | CustomizeChildren ( TSharedRef< IPropertyHandle > Prope..., IDetailChildrenBuilder& ChildBuild..., IPropertyTypeCustomizationUtils& C... ) | Called when the children of the property should be customized or extra rows added |
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 |
bool | ShouldInlineKey () |
Operators
Type | Name | Description |
---|---|---|
FKeyStructCu... | operator= ( FKeyStructCustomization&& ) | |
FKeyStructCu... | operator= ( const FKeyStructCustomization& ) |
Deprecated Variables
Type | Name | Description |
---|---|---|
bool | bDisplayIcon | bDisplayIcon is deprecated and the icon has been removed |
Deprecated Functions
Type | Name | Description |
---|---|---|
bool | GetDisplayIcon () | GetDisplayIcon() is deprecated and the icon referenced has been removed |
PRAGMA_DISAB... | SetDisplayIcon ( bool bShouldDisplayIcon ) | SetDisplayIcon(bShouldDisplayIcon) is deprecated and the icon referenced has been removed |