Navigation
API > API/Developer > API/Developer/WidgetRegistration > API/Developer/WidgetRegistration/Layout
Inheritance Hierarchy
- TSharedFromThis< FToolElementRegistrationArgs >
- FToolElementRegistrationArgs
- FCategoryDrivenContentBuilderBase
- FCategoryDrivenContentBuilder
- FToolkitBuilder
References
| Module | WidgetRegistration |
| Header | /Engine/Source/Developer/WidgetRegistration/Public/Layout/CategoryDrivenContentBuilderBase.h |
| Include | #include "Layout/CategoryDrivenContentBuilderBase.h" |
Syntax
class FCategoryDrivenContentBuilderBase : public FToolElementRegistrationArgs
Remarks
The FToolElementRegistrationArgs which is specified for Toolkits
Variables
| Type | Name | Description | |
|---|---|---|---|
| FName | ActiveCategoryName | The name of the currently selected/active category | |
| FName | BuilderName | Name of this builder | |
| EVisibility | CategoryButtonLabelVisibility | If CategoryButtonLabelVisibility == EVisibility::Visible, the category button labels are visible, else they are not displayed. | |
| ECategoryReclickBehavior | CategoryReclickBehavior | Specifies what happens if you click the category button of an already-active category | |
| EVisibility | CategoryToolbarVisibility | Is the Category toolbar visible? This should be false if the Category toolbar has less than 2 categories, because if there is only one showing it is superfluous to actually show it since it will always be selected. | |
| FGetDecoratedButtonDelegate | GetDecoratedButtonDelegate | Delegate that takes the default toolbar button created by this as a parameter, adds any decorator needed and returns the new widget | |
| TSharedPtr< FToolBarBuilder > | LoadPaletteToolBarBuilder | The toolbar builder for the toolbar which has the FUICommandInfos which load the various palettes | |
| TSharedPtr< FUICommandList > | LoadToolPaletteCommandList | A TSharedPointer to the FUICommandList for the FUICommandInfos which load a tool palette | |
| TSharedPtr< SVerticalBox > | MainContentVerticalBox | The SVerticalBox which holds the main content ~ -all but the Category chooser | |
| FSimpleMulticastDelegate | OnActivePaletteChanged | OnActivePaletteChanged is broadcast when the active palette changes to a different palette | |
| FToolkitWidgetStyle | Style | The current FToolkitWidgetStyle | |
| TSharedPtr< FToolElement > | VerticalToolbarElement | A TSharedPointer to the FToolElement for the vertical toolbar |
Constructors
| Type | Name | Description | |
|---|---|---|---|
FCategoryDrivenContentBuilderBase
(
FName InBuilderName |
A constructor for the FCategoryDrivenContentBuilderBase which defines the builder name | ||
| A constructor for the FCategoryDrivenContentBuilderBase which takes a FCategoryDrivenContentBuilderArgs to initialize this |
Destructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| TSharedRef< SWidget > | Creates the Toolbar for the widget with the FUICommandInfos that load the Palettes | ||
| void | CreateWidget () |
Creates the SWidget | |
| FName | |||
| TSharedPtr< FToolBarBuilder > | |||
| void | Initializes the category toolbar container VBox, and the children inside it. | ||
| void | Initializes the data necessary to build the category toolbar | ||
| void | RefreshCategoryToolbarWidget
(
bool bShouldReinitialize |
Refreshes the UI display of the category toolbar | |
| void | SetCategoryButtonLabelVisibility
(
EVisibility Visibility |
Sets category button label visibility to Visibility. | |
| void | SetCategoryButtonLabelVisibility
(
bool bIsCategoryButtonLabelVisible |
Sets category button label visibility to Visibility. | |
| void | UpdateContentForCategory
(
FName ActiveCategoryName, |
Overridden from FToolElementRegistrationArgs
| Type | Name | Description | |
|---|---|---|---|
| TSharedPtr< SWidget > | Implements the generation of the TSharedPtr |
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 |