Navigation
API > API/Developer > API/Developer/WidgetRegistration
Inheritance Hierarchy
- TSharedFromThis< FToolElementRegistrationArgs >
- FToolElementRegistrationArgs
- FCategoryDrivenContentBuilderBase
- FToolkitBuilder
References
| Module | WidgetRegistration |
| Header | /Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h |
| Include | #include "ToolkitBuilder.h" |
Syntax
class FToolkitBuilder : public FCategoryDrivenContentBuilderBase
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
TSharedPtr< FToolPalette > | ActivePalette | The tool palette which is currently loaded/active |
 |
TArray< TSharedRef< FEditablePalette > > | EditablePalettesArray | A TArray of FEditablePalettes, kept to update the commands which are on them |
 |
TMap< FName, TSharedPtr< FToolBarBuilder > > | LoadCommandNameToPaletteToolbarBuilderMap | The FName of each Load palette command to the FToolbarBuilder for the palette which it loads |
 |
TMap< FString, TSharedPtr< FToolPalette > > | LoadCommandNameToToolPaletteMap | The map of the command name to the ButtonArgs for it |
 |
TMap< FString, TSharedPtr< const FUICommandInfo > > | PaletteCommandInfos | Map of command name to the actual command for all commands belonging to this palette |
 |
TMap< FString, TSharedPtr< FButtonArgs > > | PaletteCommandNameToButtonArgsMap | The map of the command name to the ButtonArgs for it |
 |
FName | ToolbarCustomizationName | Name of the toolbar this mode uses and can be used by external systems to customize that mode toolbar |
 |
TSharedPtr< FUICommandList > | ToolkitCommandList | A TSharedPointer to the FUICommandList for the current mode |
 |
TArray< TSharedRef< FToolElement > > | ToolPaletteElementArray | The array of Tool Palettes on display. |
 |
TSharedPtr< SVerticalBox > | ToolPaletteWidget | The SVerticalBox which holds the tool palette (the Buttons which load each tool) |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
FToolkitBuilder
(
FToolkitBuilderArgs& Args |
Default constructor | |
 |
FToolkitBuilder
(
FName ToolbarCustomizationName, |
Constructor |
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 |
  |
EVisibility | ||
  |
FName | ||
  |
FText | ||
 |
void | GetCommandsForEditablePalette
(
TSharedRef< FEditablePalette > EditablePalette, |
Fills the OutCommands TArray with TSharedPtr |
  |
bool | ||
 |
void | InitializeCategoryToolbar
(
bool bInitLoadToolPaletteMap |
Initializes the data necessary to build the category toolbar |
  |
ECheckBoxState | IsActiveToolPalette
(
FName CommandName |
|
 |
void | OnEditablePaletteEdited
(
TSharedRef< FEditablePalette > EditablePalette |
|
 |
void | Resets the tool palette widget, on which the buttons for the currently chosen toolset are shown | |
 |
void | SetActivePaletteCommandsVisibility
(
EVisibility Visibility |
|
 |
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 | UpdateEditablePalette
(
TSharedRef< FEditablePalette > EditablePalette |
Updates the Editable Palette with any commands that are on it |
Overridden from FCategoryDrivenContentBuilderBase
| Type | Name | Description | |
|---|---|---|---|
  |
void | Initializes the data necessary to build the category toolbar |
Overridden from FToolElementRegistrationArgs
| Type | Name | Description | |
|---|---|---|---|
  |
void | ResetWidget () |
Cleans up any previously set data in this FToolkitBuilder and reset the members to their initial values |
  |
void | UpdateWidget () |
Updates the Toolkit. |