UOperatingSystemSettingModule_Theme Class Reference

#include "OperatingSystemSettingModule_Theme.h"

Inheritance diagram for UOperatingSystemSettingModule_Theme:

Collaboration diagram for UOperatingSystemSettingModule_Theme:

Public Member Functions
	UOperatingSystemSettingModule_Theme ()
void	SetTheme (const EOperatingSystemTheme NewTheme)
FLinearColor	GetPrimaryThemeColor (const bool bInvert=false) const
FLinearColor	GetSecondaryThemeColor (const bool bInvert=false) const
FLinearColor	GetPrimaryAccentColor (const bool bInvert=false) const
FLinearColor	GetSecondaryAccentColor (const bool bInvert=false) const
bool	FindColorByName (const FName Name, FLinearColor &OutColor) const
FORCEINLINE bool	IsDarkTheme () const
Public Member Functions inherited from UOperatingSystemSettingModule
	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 FName	GetThemeChangeEventName ()
Static Public Member Functions inherited from UOperatingSystemSettingModule
static UOperatingSystemSettingModule *	ConstructSettingModule (UOperatingSystem *OwningOS, const FOperatingSystemSettingModuleInfo &Info, const TSoftClassPtr< UOperatingSystemSettingModule > &SettingModuleSoftClass, FGenericError &OutError)
	Constructs a setting module for the operating system.

Additional Inherited Members
Protected Member Functions inherited from UOperatingSystemSettingModule
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 inherited from UOperatingSystemSettingModule
TSoftClassPtr< UOperatingSystemSettingModuleWidget >	WidgetClass

Detailed Description

UOperatingSystemSettingModule_Theme is a subclass of UOperatingSystemSettingModule that provides functionality for managing and retrieving theme-related settings.

Constructor & Destructor Documentation

UOperatingSystemSettingModule_Theme()

UOperatingSystemSettingModule_Theme::UOperatingSystemSettingModule_Theme

(

)

Member Function Documentation

FindColorByName()

bool UOperatingSystemSettingModule_Theme::FindColorByName	(	const FName	Name,
		FLinearColor &	OutColor ) const

Gets the color by name from the Colors TMap. This is particularly useful if you added your own custom colors.

Parameters

Name	Name of the color to find.
OutColor	Outputs the color or Black if invalid.

Returns

True if the given color name was found in Colors Map.

GetPrimaryAccentColor()

FLinearColor UOperatingSystemSettingModule_Theme::GetPrimaryAccentColor

(

const bool

bInvert = false

)

const

Returns the primary accent color.

Parameters

bInvert

Get color of inverted theme. If current theme is dark, this will return color for light theme.

Returns

Primary accent color of the current theme as defined in Colors parameter.

GetPrimaryThemeColor()

FLinearColor UOperatingSystemSettingModule_Theme::GetPrimaryThemeColor

(

const bool

bInvert = false

)

const

Returns the primary theme color.

Parameters

bInvert

Get color of inverted theme. If current theme is dark, this will return color for light theme.

Returns

Primary color of the current theme as defined in Colors parameter.

GetSecondaryAccentColor()

FLinearColor UOperatingSystemSettingModule_Theme::GetSecondaryAccentColor

(

const bool

bInvert = false

)

const

Returns the secondary accent color.

Parameters

bInvert

Get color of inverted theme. If current theme is dark, this will return color for light theme.

Returns

Secondary accent color of the current theme as defined in Colors parameter.

GetSecondaryThemeColor()

FLinearColor UOperatingSystemSettingModule_Theme::GetSecondaryThemeColor

(

const bool

bInvert = false

)

const

Returns the secondary theme color.

Parameters

bInvert

Get color of inverted theme. If current theme is dark, this will return color for light theme.

Returns

Secondary color of the current theme as defined in Colors parameter.

GetThemeChangeEventName()

static FName UOperatingSystemSettingModule_Theme::GetThemeChangeEventName ( )

inlinestatic

A helper static function for getting the event when changing themes. You can listen to this event name via device messenger.

Returns

The event name when changing theme.

IsDarkTheme()

FORCEINLINE bool UOperatingSystemSettingModule_Theme::IsDarkTheme ( ) const

inline

Checks if the current theme is dark or not. If this function returns false, it means current theme is light.

Returns

True if the current theme is dark.

SetTheme()

void UOperatingSystemSettingModule_Theme::SetTheme

(

const EOperatingSystemTheme

NewTheme

)

Sets the current theme.

Parameters

NewTheme

New theme to set.

---

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

• Source/OperatingSystemSimulator/Public/Programs/Settings/Modules/OperatingSystemSettingModule_Theme.h
• Source/OperatingSystemSimulator/Private/Programs/Settings/Modules/OperatingSystemSettingModule_Theme.cpp