Navigation
API > API/Developer > API/Developer/WidgetRegistration
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.
| Name | FCategoryDrivenContentBuilder |
| Type | class |
| Header File | /Engine/Source/Developer/WidgetRegistration/Public/Layout/CategoryDrivenContentBuilder.h |
| Include Path | #include "Layout/CategoryDrivenContentBuilder.h" |
Syntax
class FCategoryDrivenContentBuilder : public FCategoryDrivenContentBuilderBase
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → FToolElementRegistrationArgs → FCategoryDrivenContentBuilderBase → FCategoryDrivenContentBuilder
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FCategoryDrivenContentBuilder
(
FCategoryDrivenContentBuilderArgs& Args |
Initializes this FCategoryDrivenContentBuilder with the given FCategoryDrivenContentBuilderArgs | Layout/CategoryDrivenContentBuilder.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
~FCategoryDrivenContentBuilder() |
Destroys the FCategoryDrivenContentBuilder and frees any resources | Layout/CategoryDrivenContentBuilder.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FProvideSelectedCategoryContent | TBaseDelegate_OneParam< TSharedRef< SWidget >, const FName & > | Layout/CategoryDrivenContentBuilder.h | |
| FUpdateContentForCategoryDelegate | TBaseDelegate_TwoParams< void, FName, FText > | Layout/CategoryDrivenContentBuilder.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ProvideSelectedCategoryContentDelegate | FProvideSelectedCategoryContent | Layout/CategoryDrivenContentBuilder.h | ||
| UpdateContentForCategoryDelegate | FUpdateContentForCategoryDelegate | A delegate which provides the const FName& Command name as a parameter to indicates which category was clicked. | Layout/CategoryDrivenContentBuilder.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsFilledWithWidget | bool | If true, the content for the category should have a single widget fill the content | Layout/CategoryDrivenContentBuilder.h | |
| bShowNoCategorySelection | bool | If true, we need to show no selection on the category picker and no category title, else we should show both | Layout/CategoryDrivenContentBuilder.h | |
| BuilderInputArray | TArray< UE::DisplayBuilders::FBuilderInput > | The array of BuilderInputs, in the correct display order | Layout/CategoryDrivenContentBuilder.h | |
| CategoryLabel | FText | The FText label of the currently selected category | Layout/CategoryDrivenContentBuilder.h | |
| CategoryNameToBuilderInputMap | TMap< FName, UE::DisplayBuilders::FBuilderInput > | A map of the Category FName to the TSharedRef |
Layout/CategoryDrivenContentBuilder.h | |
| ChildBuilderArray | TArray< TSharedRef< FSlateBuilder > > | The array of FSlateBuilders that will build the content for the currently selected category | Layout/CategoryDrivenContentBuilder.h | |
| ColumnWrappingContainer | TSharedPtr< FColumnWrappingContainer > | The column wrapping container that provides the body of the category content | Layout/CategoryDrivenContentBuilder.h | |
| Favorites | TArray< FName > | The TArray of FNames which have been set as favorites | Layout/CategoryDrivenContentBuilder.h | |
| FavoritesCategoryName | FName | The FName of the favorites Category | Layout/CategoryDrivenContentBuilder.h | |
| TitleContainer | TSharedPtr< FSimpleTitleContainer > | The simple title container that has a header with the currently selected category name, and an empty body that will contain the category content | Layout/CategoryDrivenContentBuilder.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddBuilder
(
TSharedRef< SWidget > Widget |
Converts the SWidget Widget to a FSlateBuilder and adds it to the main content for the currently selected category | Layout/CategoryDrivenContentBuilder.h | |
void AddFavorite
(
FName InFavoriteCommandName |
Adds the favorites with the name InFavoriteCommandName to the favorites list. | Layout/CategoryDrivenContentBuilder.h | |
void ClearCategoryContent() |
Clears the content for the currently selected category | Layout/CategoryDrivenContentBuilder.h | |
TSharedRef< SWidget > CreateFavoritesContextMenu
(
FString FavoritesItemName |
Layout/CategoryDrivenContentBuilder.h | ||
TSharedRef< SWidget > CreateShowCategoryLabelsContextMenu() |
Returns the context menu containing an item to show or hide category labels. | Layout/CategoryDrivenContentBuilder.h | |
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 | Layout/CategoryDrivenContentBuilder.h | |
| Layout/CategoryDrivenContentBuilder.h | |||
void InitializeCategoryButtons () |
Initializes the category buttons with the given FBuilderInputs | Layout/CategoryDrivenContentBuilder.h | |
void InitializeCategoryButtons
(
TArray< UE::DisplayBuilders::FBuilderInput > InBuilderInputArray |
Initializes the category buttons with the given FBuilderInputs | Layout/CategoryDrivenContentBuilder.h | |
void SetShowNoCategorySelection
(
bool bInShowNoCategorySelection |
Sets whether we should show that no category selected. | Layout/CategoryDrivenContentBuilder.h |
Overridden from FCategoryDrivenContentBuilderBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void InitializeCategoryToolbar() |
Initializes the data necessary to build the category toolbar | Layout/CategoryDrivenContentBuilder.h |
Overridden from FToolElementRegistrationArgs
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TSharedPtr< SWidget > GenerateWidget() |
Generate the widget built by this builder and return a shared pointer to it. | Layout/CategoryDrivenContentBuilder.h | |
virtual void UpdateWidget() |
Refreshes the existing widget. | Layout/CategoryDrivenContentBuilder.h |