UOperatingSystemSettingModule Class Reference

Represents a module for operating system settings. More...

#include "OperatingSystemSettingModule.h"

Inheritance diagram for UOperatingSystemSettingModule:

Collaboration diagram for UOperatingSystemSettingModule:

Public Member Functions
	UOperatingSystemSettingModule ()
void	ApplySetting (const FName SettingIdentifier, UObject *Payload=nullptr)
	Apply a setting to the operating system setting module identified by the specified SettingIdentifier.
OPERATINGSYSTEMSIMULATOR_API UOperatingSystem *	GetParentOperatingSystem () const
	Retrieves a pointer to the parent operating system object. It is a constant method, meaning it does not modify the object's state.
OPERATINGSYSTEMSIMULATOR_API FORCEINLINE FOperatingSystemSettingModuleInfo	GetModuleInfo () const
	Retrieves an FOperatingSystemSettingModuleInfo object containing information about the module.

Static Public Member Functions
static UOperatingSystemSettingModule *	ConstructSettingModule (UOperatingSystem *OwningOS, const FOperatingSystemSettingModuleInfo &Info, const TSoftClassPtr< UOperatingSystemSettingModule > &SettingModuleSoftClass, FGenericError &OutError)
	Constructs a setting module for the operating system.

Protected Member Functions
virtual OPERATINGSYSTEMSIMULATOR_API void	OnApplySetting (const FName &SettingIdentifier, UObject *Payload)
	Apply a setting to the operating system setting module identified by the specified SettingIdentifier. This method applies a setting to the operating system setting module identified by the specified SettingIdentifier. The SettingIdentifier parameter represents the name of the setting identifier that will be applied. The Payload parameter is an optional payload object associated with the setting. If the Payload parameter is not provided, the setting module itself will be used as the payload.
virtual OPERATINGSYSTEMSIMULATOR_API void	OnCreated ()
	This method is called when the operating system setting module is created.
void	K2_OnCreated ()
	Blueprint implementable event triggered when an instance of OperatingSystemSettingModule is created.
void	K2_OnApplySetting (const FName &SettingIdentifier, UObject *Payload)
	Called when a setting is being applied.

Protected Attributes
TSoftClassPtr< UOperatingSystemSettingModuleWidget >	WidgetClass

Detailed Description

Represents a module for operating system settings.

This class inherits from UObject and provides functionality for managing operating system setting modules. It contains properties and methods to handle the module's data and behavior.

Constructor & Destructor Documentation

UOperatingSystemSettingModule()

UOperatingSystemSettingModule::UOperatingSystemSettingModule

(

)

Here is the call graph for this function:

Member Function Documentation

ApplySetting()

void UOperatingSystemSettingModule::ApplySetting	(	const FName	SettingIdentifier,
		UObject *	Payload = nullptr )

Apply a setting to the operating system setting module identified by the specified SettingIdentifier.

Parameters

SettingIdentifier	The name of the setting identifier to apply.
Payload	An optional payload object associated with the setting.

Here is the call graph for this function:

ConstructSettingModule()

UOperatingSystemSettingModule * UOperatingSystemSettingModule::ConstructSettingModule ( UOperatingSystem * OwningOS, const FOperatingSystemSettingModuleInfo & Info, const TSoftClassPtr< UOperatingSystemSettingModule > & SettingModuleSoftClass, FGenericError & OutError )

static

Constructs a setting module for the operating system.

This method creates a setting module object for the operating system based on the provided parameters. It initializes the module's properties and sets up its widget class.

Parameters

OwningOS	The parent operating system object to which this setting module belongs.
Info	The basic information regarding this module.
SettingModuleSoftClass	A soft reference to the class of the setting module.
OutError	[out] The error information if the construction fails.

Returns

A pointer to the constructed setting module object, or nullptr if the construction fails.

Here is the call graph for this function:

Here is the caller graph for this function:

GetModuleInfo()

OPERATINGSYSTEMSIMULATOR_API FORCEINLINE FOperatingSystemSettingModuleInfo UOperatingSystemSettingModule::GetModuleInfo ( ) const

inline

Retrieves an FOperatingSystemSettingModuleInfo object containing information about the module.

Returns

The module information.

GetParentOperatingSystem()

UOperatingSystem * UOperatingSystemSettingModule::GetParentOperatingSystem

(

)

const

Retrieves a pointer to the parent operating system object. It is a constant method, meaning it does not modify the object's state.

Returns

A pointer to the parent operating system object. If the parent operating system object is not set, the return value will be nullptr.

Here is the caller graph for this function:

K2_OnApplySetting()

void UOperatingSystemSettingModule::K2_OnApplySetting ( const FName & SettingIdentifier, UObject * Payload )

protected

Called when a setting is being applied.

This is a blueprint implementable event used to handle the application of a setting. The method is called with the setting identifier and a payload that contains additional data related to the setting.

Parameters

SettingIdentifier	The identifier of the setting being applied.
Payload	The payload object containing additional data for the setting.

Here is the caller graph for this function:

K2_OnCreated()

void UOperatingSystemSettingModule::K2_OnCreated ( )

protected

Blueprint implementable event triggered when an instance of OperatingSystemSettingModule is created.

This event is fired when an instance of OperatingSystemSettingModule is created. It can be overridden in Blueprints to add custom functionality when the module is created.

OnApplySetting()

virtual OPERATINGSYSTEMSIMULATOR_API void UOperatingSystemSettingModule::OnApplySetting ( const FName & SettingIdentifier, UObject * Payload )

inlineprotectedvirtual

Apply a setting to the operating system setting module identified by the specified SettingIdentifier. This method applies a setting to the operating system setting module identified by the specified SettingIdentifier. The SettingIdentifier parameter represents the name of the setting identifier that will be applied. The Payload parameter is an optional payload object associated with the setting. If the Payload parameter is not provided, the setting module itself will be used as the payload.

Note

This method is intended to be overridden by derived classes. The default implementation does nothing.

Parameters

SettingIdentifier	The name of the setting identifier to apply.
Payload	An optional payload object associated with the setting.

Here is the caller graph for this function:

OnCreated()

virtual OPERATINGSYSTEMSIMULATOR_API void UOperatingSystemSettingModule::OnCreated ( )

inlineprotectedvirtual

This method is called when the operating system setting module is created.

This method is a virtual method that can be overridden by derived classes to perform custom initialization when the setting module is created. It is called after the setting module object is constructed and its properties are initialized. This method does not take any parameters or return any value.

Note

This method is intended to be overridden by derived classes. The default implementation does nothing.

Reimplemented in UOperatingSystemSettingModule_Wallpaper.

Here is the caller graph for this function:

Member Data Documentation

WidgetClass

TSoftClassPtr<UOperatingSystemSettingModuleWidget> UOperatingSystemSettingModule::WidgetClass

protected

Widget class to create when this module is constructed

---

The documentation for this class was generated from the following files:

• Source/OperatingSystemSimulator/Public/Programs/Settings/OperatingSystemSettingModule.h
• Source/OperatingSystemSimulator/Private/Programs/Settings/OperatingSystemSettingModule.cpp