Skip to content

Class USFCategoryTab_Leaf

ClassList > USFCategoryTab_Leaf

The native base class for the content widget representing a leaf-type setting category (contains setting entries). More...

  • #include "UI/Components/SFCategoryTab_Leaf.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
TMap< FGameplayTag, TObjectPtr< class USFSettingEntryWidget > > EntryWidgetMap
TObjectPtr< class UPanelWidget > SettingGroupContainer

Protected Attributes inherited from USFCategoryTabBase

See USFCategoryTabBase

Type Name
TObjectPtr< class USFSettingCategory > SettingCategory

Protected Functions

Type Name
void OnGroupWidgetAdded (class UPanelSlot * WidgetAsPanelSlot, class USFSettingGroupWidget * WidgetAsGroupWidget)

Detailed Description

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

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

Note:

Abstract BlueprintType Blueprintable

Public Functions Documentation

function InitializeCategoryDisplay

virtual void USFCategoryTab_Leaf::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 EntryWidgetMap

TMap<FGameplayTag, TObjectPtr<class USFSettingEntryWidget> > USFCategoryTab_Leaf::EntryWidgetMap;

The transient mapping of setting Gameplay Tags to their corresponding setting entry widgets, used for quick lookup.

Note:

Transient

variable SettingGroupContainer

TObjectPtr<class UPanelWidget> USFCategoryTab_Leaf::SettingGroupContainer;

The container widget for setting groups within this category. Setting entry widgets are added to this container through their group widgets.

Note:

BlueprintReadOnly BindWidget

Protected Functions Documentation

function OnGroupWidgetAdded

void USFCategoryTab_Leaf::OnGroupWidgetAdded (
    class UPanelSlot * WidgetAsPanelSlot,
    class USFSettingGroupWidget * WidgetAsGroupWidget
)

Called when a USFSettingGroupWidget is added to SettingGroupContainer. To be implemented in Blueprint to add any additional styling like padding and such.

Parameters:

  • WidgetAsPanelSlot The added group widget as a panel slot, used for styling.

Note:

BlueprintImplementableEvent

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