UOperatingSystemSettingModule

#include <OperatingSystemSimulator/Public/Programs/Settings/OperatingSystemSettingModule.h>

class UOperatingSystemSettingModule

Defined in OperatingSystemSettingModule.h:21

Inherits: UObject Subclassed by: UOperatingSystemSettingModule_Theme, UOperatingSystemSettingModule_Wallpaper

Inheritance diagram

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemSettingModule["UOperatingSystemSettingModule"]
  class UObject["UObject"]
  UObject <|-- UOperatingSystemSettingModule
  class UOperatingSystemSettingModule_Theme["UOperatingSystemSettingModule_Theme"]
  UOperatingSystemSettingModule <|-- UOperatingSystemSettingModule_Theme
  class UOperatingSystemSettingModule_Wallpaper["UOperatingSystemSettingModule_Wallpaper"]
  UOperatingSystemSettingModule <|-- UOperatingSystemSettingModule_Wallpaper

Collaboration diagram

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemSettingModule["UOperatingSystemSettingModule"]
  class FOperatingSystemSettingModuleInfo["FOperatingSystemSettingModuleInfo"]
  UOperatingSystemSettingModule *-- FOperatingSystemSettingModuleInfo
  class UOperatingSystemSettingModuleWidget["UOperatingSystemSettingModuleWidget"]
  UOperatingSystemSettingModule *-- UOperatingSystemSettingModuleWidget
  class UOperatingSystem["UOperatingSystem"]
  UOperatingSystemSettingModule *-- UOperatingSystem

Class detail

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemSettingModule {
    +UOperatingSystemSettingModule()
    +ApplySetting(const FName SettingIdentifier, UObject *Pay
    +GetParentOperatingSystem() const UOperatingSystem() *
    +GetModuleInfo() const FOperatingSystemSettingModuleInfo()
    +ConstructSettingModule(UOperatingSystem *OwningOS, const FOperatin UOperatingSystemSettingModule() *
    +WidgetClass : TSoftClassPtr< UOperatingSystemSettingMo
    +OnApplySetting(const FName &SettingIdentifier, UObject *Pa
    +OnCreated()
    +K2_OnCreated()
    +K2_OnApplySetting(const FName &SettingIdentifier, UObject *Pa
    +Data : FOperatingSystemSettingModuleInfo()
    +Widget : TObjectPtr< UOperatingSystemSettingModul
    +ParentOS : TWeakObjectPtr< UOperatingSystem() >
  }

Caller impact — GetParentOperatingSystem

Documented call sites inside the plugin (5):

flowchart LR
  UOperatingSystemSettingModule__GetParentOperatingSystem["UOperatingSystemSettingModule::GetParentOperatingSystem"]
  UOperatingSystemSettingModuleWidget__CreateWidget["UOperatingSystemSettingModuleWidget::CreateWidget"]
  UOperatingSystemSettingModuleWidget__CreateWidget --> UOperatingSystemSettingModule__GetParentOperatingSystem
  UOperatingSystemSettingModule_Wallpaper__GetDesktopWallpapers["UOperatingSystemSettingModule_Wallpaper::GetDesktopWallpapers"]
  UOperatingSystemSettingModule_Wallpaper__GetDesktopWallpapers --> UOperatingSystemSettingModule__GetParentOperatingSystem
  UOperatingSystemSettingModule_Wallpaper__OnCreated["UOperatingSystemSettingModule_Wallpaper::OnCreated"]
  UOperatingSystemSettingModule_Wallpaper__OnCreated --> UOperatingSystemSettingModule__GetParentOperatingSystem
  UOperatingSystemSettingModule_Wallpaper__SaveBundledWallpaper["UOperatingSystemSettingModule_Wallpaper::SaveBundledWallpaper"]
  UOperatingSystemSettingModule_Wallpaper__SaveBundledWallpaper --> UOperatingSystemSettingModule__GetParentOperatingSystem
  UOperatingSystemSettingModule_Wallpaper__SaveCustomWallpaper["UOperatingSystemSettingModule_Wallpaper::SaveCustomWallpaper"]
  UOperatingSystemSettingModule_Wallpaper__SaveCustomWallpaper --> UOperatingSystemSettingModule__GetParentOperatingSystem

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.

Public Methods

Return	Name	Description
	UOperatingSystemSettingModule
void	ApplySetting	Apply a setting to the operating system setting module identified by the specified SettingIdentifier.
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.
FOperatingSystemSettingModuleInfo	GetModuleInfo const inline	Retrieves an FOperatingSystemSettingModuleInfo object containing information about the module.

---

UOperatingSystemSettingModule

UOperatingSystemSettingModule()

Defined in OperatingSystemSettingModule.h:56

References

• CHECK_IN_BP
• IMPLEMENTED_IN_BP_LAMBDA
• OnApplySetting
• OnCreated

---

ApplySetting

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

Defined in OperatingSystemSettingModule.h:83 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.

References

• K2_OnApplySetting
• OnApplySetting
• OS_LOG_ERROR
• ParentOS

---

GetParentOperatingSystem

const

UOperatingSystem * GetParentOperatingSystem() const

Defined in OperatingSystemSettingModule.h:137 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.

Referenced by

• CreateWidget
• GetDesktopWallpapers
• OnCreated
• SaveBundledWallpaper
• SaveCustomWallpaper

References

• ParentOS

---

GetModuleInfo

const inline

inline FOperatingSystemSettingModuleInfo GetModuleInfo() const

Defined in OperatingSystemSettingModule.h:144 Retrieves an FOperatingSystemSettingModuleInfo object containing information about the module.

Returns

The module information.

Public Static Methods

Return	Name	Description
UOperatingSystemSettingModule *	ConstructSettingModule static	Constructs a setting module for the operating system.

---

ConstructSettingModule

static

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

Defined in OperatingSystemSettingModule.h:71 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.

Referenced by

• OnValidate

References

• CreateWidget
• Info
• MAKE_ERROR
• NEW_SOFT_OBJ
• Reset

Protected Attributes

Return	Name	Description
TSoftClassPtr< UOperatingSystemSettingModuleWidget >	WidgetClass	Widget class to create when this module is constructed

---

WidgetClass

TSoftClassPtr< UOperatingSystemSettingModuleWidget > WidgetClass

Defined in OperatingSystemSettingModule.h:33 Widget class to create when this module is constructed

Protected Methods

Return	Name	Description
void	OnApplySetting virtual inline	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.
void	OnCreated virtual inline	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	Called when a setting is being applied.

---

OnApplySetting

virtual inline

virtual inline void OnApplySetting(const FName & SettingIdentifier, UObject * Payload)

Defined in OperatingSystemSettingModule.h:97 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.

Referenced by

• ApplySetting
• UOperatingSystemSettingModule

---

OnCreated

virtual inline

virtual inline void OnCreated()

Defined in OperatingSystemSettingModule.h:108 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.

Referenced by

• UOperatingSystemSettingModule

Reimplemented by

• OnCreated

---

K2_OnCreated

void K2_OnCreated()

Defined in OperatingSystemSettingModule.h:117 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.

---

K2_OnApplySetting

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

Defined in OperatingSystemSettingModule.h:129 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.

Referenced by

• ApplySetting

Private Attributes

Return	Name	Description
FOperatingSystemSettingModuleInfo	Data	Basic information regarding this module
TObjectPtr< UOperatingSystemSettingModuleWidget >	Widget	Represents a pointer to a UOperatingSystemSettingModuleWidget object.
TWeakObjectPtr< UOperatingSystem >	ParentOS	A weak pointer to the parent operating system object to which this setting module belongs. It is a weak pointer, meaning that it does not have ownership of the parent object. The value of this variable can be null if the parent operating system has been destroyed or is not set.

---

Data

FOperatingSystemSettingModuleInfo Data

Defined in OperatingSystemSettingModule.h:27 Basic information regarding this module

---

Widget

TObjectPtr< UOperatingSystemSettingModuleWidget > Widget

Defined in OperatingSystemSettingModule.h:39 Represents a pointer to a UOperatingSystemSettingModuleWidget object.

---

ParentOS

TWeakObjectPtr< UOperatingSystem > ParentOS

Defined in OperatingSystemSettingModule.h:47 A weak pointer to the parent operating system object to which this setting module belongs. It is a weak pointer, meaning that it does not have ownership of the parent object. The value of this variable can be null if the parent operating system has been destroyed or is not set.

Referenced by

• ApplySetting
• GetParentOperatingSystem