Skip to content

Class USFSettingGroupWidget

ClassList > USFSettingGroupWidget

The native base class for the widget displaying a setting group. More...

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

Inherits the following classes: UCommonUserWidget

Public Functions

Type Name
void AddSettingEntry (class USFSettingEntryWidget * EntryWidget)
void DisplaySettingGroupInfo (const struct FSFSettingGroup & SettingGroup)
class USFSettingEntryWidget * GetFirstValidSettingEntry () const

Protected Attributes

Type Name
TObjectPtr< class UPanelWidget > SettingEntryContainer

Protected Functions

Type Name
void OnSettingEntryAdded (class UPanelSlot * EntryAsPanelSlot, class USFSettingEntryWidget * EntryAsSettingWidget)

Detailed Description

The native base class for the widget displaying a setting group.

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

Note:

Abstract BlueprintType Blueprintable

Public Functions Documentation

function AddSettingEntry

void USFSettingGroupWidget::AddSettingEntry (
    class USFSettingEntryWidget * EntryWidget
)

Add an initialized setting entry widget to be displayed in this group. This is called by USFCategoryTab_Leaf when initializing the display of its setting entries.

Parameters:

  • EntryWidget The initialized setting entry widget to be added to this group.

function DisplaySettingGroupInfo

void USFSettingGroupWidget::DisplaySettingGroupInfo (
    const struct FSFSettingGroup & SettingGroup
)

Display the metadata of the associated setting group. If the given struct is empty, clear the display.

Parameters:

  • SettingGroup The struct containing the metadata of the associated setting group.

Note:

BlueprintImplementableEvent

function GetFirstValidSettingEntry

class USFSettingEntryWidget * USFSettingGroupWidget::GetFirstValidSettingEntry () const

Get the first setting entry widget in this group that is valid for navigation (visible and enabled). Used for setting initial focus when displaying a leaf category tab.

Returns:

The first setting entry widget in this group that is valid for navigation, nullptr if none is found.

Protected Attributes Documentation

variable SettingEntryContainer

TObjectPtr<class UPanelWidget> USFSettingGroupWidget::SettingEntryContainer;

The container widget for setting entries within this group. Setting entry widgets are added to this container when initializing the display of a leaf category tab.

Protected Functions Documentation

function OnSettingEntryAdded

void USFSettingGroupWidget::OnSettingEntryAdded (
    class UPanelSlot * EntryAsPanelSlot,
    class USFSettingEntryWidget * EntryAsSettingWidget
)

Called when a setting entry widget is added to SettingEntryContainer. To be implemented in Blueprint to add any additional styling like padding and such.

Parameters:

  • EntryAsPanelSlot The added setting entry widget as a panel slot, used for styling.
  • EntryAsSettingWidget The added setting entry widget as a setting entry widget, used for any additional logic that may be needed.

Note:

BlueprintImplementableEvent

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