Class USFCategoryTabBase

The native base class for the content widget representing a setting category. More...

#include "UI/Components/SFCategoryTabBase.h"

Inherits the following classes: UCommonActivatableWidget

Inherited by the following classes: USFCategoryTab_Branch, USFCategoryTab_Leaf

Public Attributes

Type	Name
FOnSettingEntryFocused	OnSettingFocused

Public Functions

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

Protected Attributes

Type	Name
TObjectPtr< class USFSettingCategory >	SettingCategory

Detailed Description

The native base class for the content widget representing a setting category.

This is the superclass of USFCategoryTab_Branch, which displays a branch-type category with subcategories, and USFCategoryTab_Leaf, which displays a leaf-type category with setting entries.

Note:

Abstract BlueprintType

Public Attributes Documentation

variable OnSettingFocused

FOnSettingEntryFocused USFCategoryTabBase::OnSettingFocused;

Event fired when a setting entry within this category is hovered/focused in the UI, with the focused setting's tag as a parameter.

Public Functions Documentation

function GetSettingCategory

inline const class USFSettingCategory * USFCategoryTabBase::GetSettingCategory () const

Get the category asset assigned to this widget.

Returns:

The category asset assigned to this widget.

Note:

BlueprintPure

function InitializeCategoryDisplay

inline virtual void USFCategoryTabBase::InitializeCategoryDisplay ()

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.

function SetCategory

void USFCategoryTabBase::SetCategory (
    class USFSettingCategory * InSettingCategory
)

Assign the corresponding category asset to this widget.

Parameters:

InSettingCategory The category asset represented by this widget.

Protected Attributes Documentation

variable SettingCategory

TObjectPtr<class USFSettingCategory> USFCategoryTabBase::SettingCategory;

The transient pointer to the category asset represented by this widget.

Note:

Transient

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