Navigation
API > API/Developer > API/Developer/WidgetRegistration
Inheritance Hierarchy
- TSharedFromThis
- FToolElementRegistrationArgs
- FToolkitBuilder
References
| Module | WidgetRegistration |
| Header | /Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h |
| Include | #include "ToolkitBuilder.h" |
Syntax
class FToolkitBuilder : public FToolElementRegistrationArgs
Remarks
The FToolElementRegistrationArgs which is specified for Toolkits
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
FSimpleMulticastDelegate | OnActivePaletteChanged | OnActivePaletteChanged is broadcast when the active palette changes to a different palette |
 |
TSharedPtr< FToolElement > | VerticalToolbarElement | Returns a TSharedPointer to the FToolbarBuilder with the FUICommandInfos that load the Palettes |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
FToolkitBuilder
(
const FToolkitBuilderArgs& Args |
||
 |
FToolkitBuilder
(
FName ToolbarCustomizationName, |
Destructors
| Type | Name | Description | |
|---|---|---|---|
  |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | AddPalette
(
TSharedPtr< FEditablePalette > Palette |
Adds the FEditablePalette Palette to this FToolkitBuilder |
 |
void | AddPalette
(
TSharedPtr< FToolPalette > Palette |
Adds the FToolPalette Palette to this FToolkitBuilder |
  |
TSharedRef< SWidget > | Creates the Toolbar for the widget with the FUICommandInfos that load the Palettes | |
  |
EVisibility | ||
  |
FName | ||
  |
FText | ||
 |
void | GetCommandsForEditablePalette
(
TSharedRef< FEditablePalette > EditablePalette, |
Fills the OutCommands TArray with TSharedPtr |
 |
TSharedPtr< FToolBarBuilder > | Returns a TSharedPointer to the FToolbarBuilder with the FUICommandInfos that load the Palettes | |
  |
TSharedRef< SWidget > | Returns a TSharedPointer to the FToolbarBuilder with the FUICommandInfos that load the Palettes | |
  |
bool | Returns true is there is an active palette selected, else it returns false | |
  |
bool | Returns true if the Toolkit builder has some tools that are currently active/selected | |
 |
void | Initializes the category toolbar container VBox, and the children inside it. | |
 |
void | InitializeCategoryToolbar
(
bool InitLoadToolPaletteMap |
Initializes the data to necessary to build the category toolbar |
  |
ECheckBoxState | IsActiveToolPalette
(
FName CommandName |
Returns true if the FUICommandInfo with the name CommandName is the active tool palette, else it returns false |
 |
void | RefreshCategoryToolbarWidget refreshes the UI display of the category toolbar | |
 |
void | SetActivePaletteCommandsVisibility
(
EVisibility Visibility |
Configure whether or not the tool buttons in the active palette should be visible. |
 |
void | SetActivePaletteOnLoad
(
const FUICommandInfo* Command |
Loads the palette for the FUICommandInfo Command on first visit to the mode. |
 |
void | SetActiveToolDisplayName
(
FText InActiveToolDisplayName |
Sets the display name for the active tool |
 |
void | SetCategoryButtonLabelVisibility
(
EVisibility Visibility |
Sets category button label visibility to Visibility. |
 |
void | SetCategoryButtonLabelVisibility
(
bool bIsCategoryButtonLabelVisible |
Sets category button label visibility to Visiblity. |
Overridden from FToolElementRegistrationArgs
| Type | Name | Description | |
|---|---|---|---|
  |
TSharedPtr< SWidget > | Implements the generation of the TSharedPtr |
|
  |
void | ResetWidget () |
Cleans up any previously set data in this FToolkitBuilder and reset the members to their initial values |
  |
void | UpdateWidget () |
Updates the Toolkit. |
Enums
| Type | Name | Description | |
|---|---|---|---|
 |
ECategoryReclickBehavior | Used to specify what happens when you click the category button of a category that is already active. |
Constants
| Name | Description |
|---|---|
| ToolRegistry | The tool element registry this class will use to register UI tool elements |