Navigation
API > API/Developer > API/Developer/WidgetRegistration > API/Developer/WidgetRegistration/Layout
Inheritance Hierarchy
- TSharedFromThis< FToolElementRegistrationArgs >
- FToolElementRegistrationArgs
- FCategoryDrivenContentBuilderBase
- FCategoryDrivenContentBuilder
References
| Module | WidgetRegistration |
| Header | /Engine/Source/Developer/WidgetRegistration/Public/Layout/CategoryDrivenContentBuilder.h |
| Include | #include "Layout/CategoryDrivenContentBuilder.h" |
Syntax
class FCategoryDrivenContentBuilder : public FCategoryDrivenContentBuilderBase
Remarks
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.
Variables
| Type | Name | Description | |
|---|---|---|---|
| FProvideSelectedCategoryContent | ProvideSelectedCategoryContentDelegate | ||
| FUpdateContentForCategoryDelegate | UpdateContentForCategoryDelegate | A delegate which provides the const FName& Command name as a parameter to indicates which category was clicked. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
| Initializes this FCategoryDrivenContentBuilder with the given FCategoryDrivenContentBuilderArgs |
Destructors
| Type | Name | Description | |
|---|---|---|---|
| Destroys the FCategoryDrivenContentBuilder and frees any resources |
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | AddBuilder
(
TSharedRef< SWidget > Widget |
Converts the SWidget Widget to a FSlateBuilder and adds it to the main content for the currently selected category | |
| void | AddFavorite
(
FName InFavoriteCommandName |
Adds the favorites with the name InFavoriteCommandName to the favorites list. | |
| void | Clears the content for the currently selected category | ||
| TSharedRef< SWidget > | CreateFavoritesContextMenu
(
FString FavoritesItemName |
||
| TSharedRef< SWidget > | Returns the context menu containing an item to show or hide category labels. | ||
| void | FillWithBuilder
(
TSharedRef< SWidget > Widget |
Converts the SWidget Widget to a FSlateBuilder and sets it as the entire main content for the currently selected category | |
| const TArray< FName > & | GetFavorites () |
||
| void | Initializes the category buttons with the given FBuilderInputs | ||
| void | InitializeCategoryButtons
(
TArray< UE::DisplayBuilders::FBuilderInput > InBuilderInputArray |
Initializes the category buttons with the given FBuilderInputs | |
| void | SetShowNoCategorySelection
(
bool bInShowNoCategorySelection |
Sets whether we should show that no category selected. |
Overridden from FCategoryDrivenContentBuilderBase
| Type | Name | Description | |
|---|---|---|---|
| void | Initializes the data necessary to build the category toolbar |
Overridden from FToolElementRegistrationArgs
| Type | Name | Description | |
|---|---|---|---|
| TSharedPtr< SWidget > | Generate the widget built by this builder and return a shared pointer to it. | ||
| void | UpdateWidget () |
Refreshes the existing widget. |
Typedefs
| Name | Description |
|---|---|
| FProvideSelectedCategoryContent | |
| FUpdateContentForCategoryDelegate |