Skip to content

Class USFCategoryTab_Branch

ClassList > USFCategoryTab_Branch

The native base class for the content widget representing a branch-type setting category (contains sub-categories). More...

  • #include "UI/Components/SFCategoryTab_Branch.h"

Inherits the following classes: USFCategoryTabBase

Public Attributes inherited from USFCategoryTabBase

See USFCategoryTabBase

Type Name
FOnSettingEntryFocused OnSettingFocused

Public Functions

Type Name
virtual void InitializeCategoryDisplay () override

Public Functions inherited from USFCategoryTabBase

See USFCategoryTabBase

Type Name
const class USFSettingCategory * GetSettingCategory () const
virtual void InitializeCategoryDisplay ()
void SetCategory (class USFSettingCategory * InSettingCategory)

Protected Attributes

Type Name
TObjectPtr< class UCommonTabListWidgetBase > SubCategoryTabList
TObjectPtr< class UCommonActivatableWidgetSwitcher > TabContentSwitcher

Protected Attributes inherited from USFCategoryTabBase

See USFCategoryTabBase

Type Name
TObjectPtr< class USFSettingCategory > SettingCategory

Detailed Description

The native base class for the content widget representing a branch-type setting category (contains sub-categories). This is a subclass of USFCategoryTabBase. It is added to USFSettingsScreen's TabContentSwitcher for branch-type categories.

The widget blueprint implementing this class should be assigned to the BranchTabContentClass in the Developer Settings at Project Settings > Plugins > SettingsFramework.

Note:

Abstract BlueprintType Blueprintable

Public Functions Documentation

function InitializeCategoryDisplay

virtual void USFCategoryTab_Branch::InitializeCategoryDisplay () override

Populate the widget with the data from the category asset. This is called when the widget is displayed for the first time to allow for lazy loading.

Implements USFCategoryTabBase::InitializeCategoryDisplay


Protected Attributes Documentation

variable SubCategoryTabList

TObjectPtr<class UCommonTabListWidgetBase> USFCategoryTab_Branch::SubCategoryTabList;

The Common Tab List widget containing tab buttons representing the sub-categories.

Note:

BlueprintReadOnly BindWidget


variable TabContentSwitcher

TObjectPtr<class UCommonActivatableWidgetSwitcher> USFCategoryTab_Branch::TabContentSwitcher;

The Common Activatable Widget Switcher containing the content for each sub-category, switched by the SubCategoryTabList.

Note:

BlueprintReadOnly BindWidget



The documentation for this class was generated from the following file Source/SettingsFramework/Public/UI/Components/SFCategoryTab_Branch.h