Navigation
| Name | WidgetRegistration |
| Type | Developer |
| Location | /Engine/Source/Developer/WidgetRegistration/ |
| Module Build Rules | WidgetRegistration.Build.cs |
Classes
| Name | Remarks |
|---|---|
| FBuilderInput | BuilderInput is the input representation for Builders and provides conversions to the various Slate types for inputs. |
| FBuilderKey | Provides identifiers for display builders and some methods for using them. |
| FBuilderKeys | FBuilderKeys provides keys registered for specific builders. |
| FCategoryDrivenContentBuilder | A builder which creates a widget that has a vertical toolbar category picker on the left hand side which populates the content on the right side. |
| FCategoryDrivenContentBuilderArgs | A struct to provide arguments for a FCategoryDrivenContentBuilderBase |
| FCategoryDrivenContentBuilderBase | The FToolElementRegistrationArgs which is specified for Toolkits |
| FLabelAndIconArgs | A class which provides a parameter object for builders consisting of an FText Label and a FSlateIcon icon |
| FSeparatorBuilder | FSeparatorBuilder instances will build a TSharedRef |
| FSeparatorSize | Provides a type that will hold the size for a FSeparatorBuilder |
| FToolbarRegistrationArgs | A class that provides the FToolbarRegistrationArgs for a UE toolbar |
| FToolElement | Represents one Tool Element, and is responsible for displaying the UI for that element |
| FToolElementRegistrationArgs | A class which provides the data necessary to generate a widget. |
| FToolElementRegistrationKey | Serves as a key into the FToolElementRegistry of FToolElements |
| FToolElementRegistry | A Registry for FToolElements, where the FToolElements will generate the UI for a certain tool |
| FToolkitBuilder | |
| FToolkitStyle | FToolkitStyle is the FSlateStyleSet that defines styles for FToolkitBuilders |
| FWidgetRegistrationModule | |
| UBuilderPersistenceManager | The Builder Persistence Manager handles persistence for Builders through use of FBuilderKeys |
Structs
| Name | Remarks |
|---|---|
| FEditablePalette | An FToolPalette to which you can add and remove actions |
| FEditableToolPaletteSettings | The actual struct that contains the properties saved for an FEditableToolPalette. |
| FPersistedBool | Manages a Bool to persist |
| FPersistedNameArray | Manages an array of FNames to persist |
| FSeparatorSizes | A struct to contain the possible sizes for a Separator |
| FSeparatorTemplates | A struct which holds methods that provide templates for FSeparatorBuilders. |
| FSlateBrushTemplates | A const FSlateBrush* Factory |
| FToolkitBuilderArgs | A simple struct to carry initialization data for an FToolkitBuilder |
| FToolkitSections | |
| FToolkitWidgetStyle | FToolkitWidgetStyle is the FSlateWidgetStyle that defines the styling of a ToolkitWidget |
| FToolPalette | A struct that provides the data for a single tool Palette |
Interfaces
| Name | Remarks |
|---|---|
| IEditableToolPaletteConfigManager | Interface class for FEditableToolPalette to interact with EditorConfig which is an Editor only module currently. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FGetEditableToolPaletteConfigManager | TBaseDelegate_NoParams< IEditableToolPaletteConfigManager * > | Delegate passed into FEditableToolPalette that is used to get the actual config manager instance. | ToolkitBuilderConfig.h |
Enums
Public
| Name | Remarks |
|---|---|
| EToolElement | An enum to provide the type of Tool Element |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
C void IMPLEMENT_MODULE_WidgetRegistration() |
Forced reference to this function is added by the linker to check that each module uses IMPLEMENT_MODULE | WidgetRegistrationModule.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static IModuleInterface * InitializeWidgetRegistrationModule() |
InitializeModule function, called by module manager after this module's DLL has been loaded | WidgetRegistrationModule.h | |
static FModuleInitializerEntry WidgetRegistrationInitializerEntry
(
TEXT("WidgetRegistration"), |
WidgetRegistrationModule.h |