Navigation
API > API/Developer > API/Developer/WidgetRegistration
| Name | FToolkitBuilder |
| Type | class |
| Header File | /Engine/Source/Developer/WidgetRegistration/Public/ToolkitBuilder.h |
| Include Path | #include "ToolkitBuilder.h" |
Syntax
class FToolkitBuilder : public FCategoryDrivenContentBuilderBase
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FToolElementRegistrationArgs → FCategoryDrivenContentBuilderBase → FToolkitBuilder
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FToolkitBuilder
(
FName ToolbarCustomizationName, |
Constructor | ToolkitBuilder.h | |
FToolkitBuilder
(
FToolkitBuilderArgs& Args |
Default constructor | ToolkitBuilder.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FToolkitBuilder() |
ToolkitBuilder.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActivePalette | TSharedPtr< FToolPalette > | The tool palette which is currently loaded/active | ToolkitBuilder.h | |
| EditablePalettesArray | TArray< TSharedRef< FEditablePalette > > | A TArray of FEditablePalettes, kept to update the commands which are on them | ToolkitBuilder.h | |
| LoadCommandNameToPaletteToolbarBuilderMap | TMap< FName, TSharedPtr< FToolBarBuilder > > | The FName of each Load palette command to the FToolbarBuilder for the palette which it loads | ToolkitBuilder.h | |
| LoadCommandNameToToolPaletteMap | TMap< FString, TSharedPtr< FToolPalette > > | The map of the command name to the ButtonArgs for it | ToolkitBuilder.h | |
| PaletteCommandInfos | TMap< FString, TSharedPtr< const FUICommandInfo > > | Map of command name to the actual command for all commands belonging to this palette | ToolkitBuilder.h | |
| PaletteCommandNameToButtonArgsMap | TMap< FString, TSharedPtr< FButtonArgs > > | The map of the command name to the ButtonArgs for it | ToolkitBuilder.h | |
| ToolbarCustomizationName | FName | Name of the toolbar this mode uses and can be used by external systems to customize that mode toolbar | ToolkitBuilder.h | |
| ToolkitCommandList | TSharedPtr< FUICommandList > | A TSharedPointer to the FUICommandList for the current mode | ToolkitBuilder.h | |
| ToolPaletteElementArray | TArray< TSharedRef< FToolElement > > | The array of Tool Palettes on display. | ToolkitBuilder.h | |
| ToolPaletteWidget | TSharedPtr< SVerticalBox > | The SVerticalBox which holds the tool palette (the Buttons which load each tool) | ToolkitBuilder.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActiveToolDisplayName | FText | The display name of the currently active tool | ToolkitBuilder.h | |
| LoadCommandArray | TArray< FName > | The array of Command names, in the correct display order | ToolkitBuilder.h | |
| SelectedCategoryTitleVisibility | EVisibility | If SelectedCategoryTitleVisibility == EVisibility::Visible, the selected category title is visible, else it is not displayed. | ToolkitBuilder.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddPalette
(
TSharedPtr< FEditablePalette > Palette |
Adds the FEditablePalette Palette to this FToolkitBuilder | ToolkitBuilder.h | |
void AddPalette
(
TSharedPtr< FToolPalette > Palette |
Adds the FToolPalette Palette to this FToolkitBuilder | ToolkitBuilder.h | |
EVisibility GetActivePaletteCommandsVisibility() |
ToolkitBuilder.h | ||
FName GetActivePaletteName() |
ToolkitBuilder.h | ||
FText GetActiveToolDisplayName() |
ToolkitBuilder.h | ||
void GetCommandsForEditablePalette
(
TSharedRef< FEditablePalette > EditablePalette, |
Fills the OutCommands TArray with TSharedPtr |
ToolkitBuilder.h | |
bool HasActivePalette() |
ToolkitBuilder.h | ||
void InitializeCategoryToolbar
(
bool bInitLoadToolPaletteMap |
Initializes the data necessary to build the category toolbar | ToolkitBuilder.h | |
ECheckBoxState IsActiveToolPalette
(
FName CommandName |
ToolkitBuilder.h | ||
void OnEditablePaletteEdited
(
TSharedRef< FEditablePalette > EditablePalette |
ToolkitBuilder.h | ||
void ResetToolPaletteWidget() |
Resets the tool palette widget, on which the buttons for the currently chosen toolset are shown | ToolkitBuilder.h | |
void SetActivePaletteCommandsVisibility
(
EVisibility Visibility |
ToolkitBuilder.h | ||
void SetActivePaletteOnLoad
(
const FUICommandInfo* Command |
Loads the palette for the FUICommandInfo Command on first visit to the mode. | ToolkitBuilder.h | |
void SetActiveToolDisplayName
(
FText InActiveToolDisplayName |
Sets the display name for the active tool | ToolkitBuilder.h | |
void SetCategoryToolbarVisibility
(
EVisibility Visibility |
Sets the visibility of the category toolbar. | ToolkitBuilder.h | |
void UpdateEditablePalette
(
TSharedRef< FEditablePalette > EditablePalette |
Updates the Editable Palette with any commands that are on it | ToolkitBuilder.h |
Overridden from FCategoryDrivenContentBuilderBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void InitializeCategoryToolbar () |
Initializes the data necessary to build the category toolbar | ToolkitBuilder.h |
Overridden from FToolElementRegistrationArgs
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ResetWidget() |
Cleans up any previously set data in this FToolkitBuilder and reset the members to their initial values | ToolkitBuilder.h | |
virtual void UpdateWidget () |
Updates the Toolkit. | ToolkitBuilder.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedRef< SWidget > GetToolPaletteWidget() |
ToolkitBuilder.h |