Class USFSettingEntryWidget_Checkbox

ClassList > USFSettingEntryWidget_Checkbox

The native base class for a setting entry widget for a boolean setting, represented as a checkbox in the UI. More...

#include "UI/SettingEntries/SFSettingEntryWidget_Checkbox.h"

Inherits the following classes: USFSettingEntryWidget

Public Attributes inherited from USFSettingEntryWidget

Type	Name
FOnSettingEntryFocused	OnSettingFocused

Public Functions inherited from USFSettingEntryWidget

See USFSettingEntryWidget

Type	Name
class USFSettingDefinition *	GetSettingDefinition () const
FGameplayTag	GetSettingTag () const
virtual void	InitializeSettingEntry (const class USFSettingDefinition * InSettingDefinition)

Protected Attributes

Type	Name
TObjectPtr< class UCheckBox >	CheckboxWidget

Protected Attributes inherited from USFSettingEntryWidget

See USFSettingEntryWidget

Type	Name
TObjectPtr< class UCommonTextBlock >	SettingLabel
FGameplayTag	SettingTag

Protected Functions

Type	Name
virtual void	InitializeSettingEntry (const class USFSettingDefinition * InSettingDefinition) override
virtual void	UpdateVisualValue_Implementation (const class USFSettingValue * NewValue) override

Protected Functions inherited from USFSettingEntryWidget

See USFSettingEntryWidget

Type	Name
void	BP_InitializeSettingEntry (const class USFSettingDefinition * InSettingDefinition)
void	OnUserChangedValue (class USFSettingValue * NewValue)
void	UpdateVisualValue (const class USFSettingValue * NewValue)
virtual void	UpdateVisualValue_Implementation (const class USFSettingValue * NewValue)
void	UpdateWidgetState ()

Detailed Description

The native base class for a setting entry widget for a boolean setting, represented as a checkbox in the UI.

The widget blueprint implementing this class should be assigned as a value to the SettingEntryWidgetClasses map with the boolean setting definition class (USFSettingDefinition_Bool) as the key in the Developer Settings at Project Settings > Plugins > SettingsFramework.

Protected Attributes Documentation

variable CheckboxWidget

TObjectPtr<class UCheckBox> USFSettingEntryWidget_Checkbox::CheckboxWidget;

The checkbox widget representing the boolean setting value in the UI.

Note:

BlueprintReadOnly BindWidget

Protected Functions Documentation

function InitializeSettingEntry

virtual void USFSettingEntryWidget_Checkbox::InitializeSettingEntry (
    const class USFSettingDefinition * InSettingDefinition
) override

Initializes the data and display of this setting entry widget based on the assigned setting definition asset. Subclasses can override this function to hook up any setting type-specific logic or display elements, but should call the parent implementation to ensure the base functionality is executed (e.g., binding to setting value change events from the subsystem).

Parameters:

InSettingDefinition The setting definition asset represented by this widget.

Implements USFSettingEntryWidget::InitializeSettingEntry

function UpdateVisualValue_Implementation

virtual void USFSettingEntryWidget_Checkbox::UpdateVisualValue_Implementation (
    const class USFSettingValue * NewValue
) override

Native implementation of UpdateVisualValue, can be optionally overridden by C++ subclasses to handle setting value change events from the subsystem.

Implements USFSettingEntryWidget::UpdateVisualValue_Implementation

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