Navigation
API > API/Developer > API/Developer/WidgetRegistration
A class which provides the data necessary to generate a widget. This class should be extended and used to hold whatever information is needed to generate or update the widgets that make up the tool, and implement the virtual widget methods
| Name | FToolElementRegistrationArgs |
| Type | class |
| Header File | /Engine/Source/Developer/WidgetRegistration/Public/ToolElementRegistry.h |
| Include Path | #include "ToolElementRegistry.h" |
Syntax
class FToolElementRegistrationArgs : public TSharedFromThis< FToolElementRegistrationArgs >
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FToolElementRegistrationArgs
Derived Classes
FToolElementRegistrationArgs derived class hierarchy
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FToolElementRegistrationArgs
(
EToolElement InToolElementType |
The constructor, which takes an EToolElement which will define the type of Tool Element | ToolElementRegistry.h | |
FToolElementRegistrationArgs
(
FName InStyleClassName |
The constructor, which takes an EToolElement which will define the type of Tool Element | ToolElementRegistry.h | |
FToolElementRegistrationArgs
(
UE::DisplayBuilders::FBuilderKey InBuilderKey |
The constructor, which takes an FBuilderKey which will define the type of Tool Element | ToolElementRegistry.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FToolElementRegistrationArgs() |
Default destructor in case any subclasses need to provide a destructor | ToolElementRegistry.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BuilderKey | const UE::DisplayBuilders::FBuilderKey | The FBuilderKey for this. | ToolElementRegistry.h | |
| StyleClassName | const FName | The style class name | ToolElementRegistry.h | |
| ToolElementType | const EToolElement | The type of tool element this is Registration args for | ToolElementRegistry.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TSharedPtr< SWidget > GenerateWidget() |
Implements the generation of the TSharedPtr |
ToolElementRegistry.h | |
TSharedRef< SWidget > GenerateWidgetSharedRef() |
Implements the generation of the TSharedRef |
ToolElementRegistry.h | |
virtual void ResetWidget() |
Resets the widget to its initial state | ToolElementRegistry.h | |
virtual void UpdateWidget() |
Updates/reloads this widget. This should be called after a consumer has changed any Data in this | ToolElementRegistry.h |