UOperatingSystemWidgetBase

#include <OperatingSystemSimulator/Public/Widgets/Common/OperatingSystemWidgetBase.h>

class UOperatingSystemWidgetBase

Defined in OperatingSystemWidgetBase.h:21

Inherits: UCommonUserWidget, IOperatingSystemThemeInterface Subclassed by: UOperatingSystemMailContentWidget, UOperatingSystemSettingModuleWidget, UOperatingSystemTaskbarButton, UOperatingSystemWindowWidgetBase

Inheritance diagram

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemWidgetBase["UOperatingSystemWidgetBase"]
  class UCommonUserWidget["UCommonUserWidget"]
  UCommonUserWidget <|-- UOperatingSystemWidgetBase
  class IOperatingSystemThemeInterface["IOperatingSystemThemeInterface"]
  IOperatingSystemThemeInterface <|-- UOperatingSystemWidgetBase
  class UOperatingSystemMailContentWidget["UOperatingSystemMailContentWidget"]
  UOperatingSystemWidgetBase <|-- UOperatingSystemMailContentWidget
  class UOperatingSystemSettingModuleWidget["UOperatingSystemSettingModuleWidget"]
  UOperatingSystemWidgetBase <|-- UOperatingSystemSettingModuleWidget
  class UOperatingSystemTaskbarButton["UOperatingSystemTaskbarButton"]
  UOperatingSystemWidgetBase <|-- UOperatingSystemTaskbarButton
  class UOperatingSystemWindowWidgetBase["UOperatingSystemWindowWidgetBase"]
  UOperatingSystemWidgetBase <|-- UOperatingSystemWindowWidgetBase

Collaboration diagram

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemWidgetBase["UOperatingSystemWidgetBase"]
  class UOperatingSystem["UOperatingSystem"]
  UOperatingSystemWidgetBase *-- UOperatingSystem

Class detail

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemWidgetBase {
    +UOperatingSystemWidgetBase()
    +SetOperatingSystem(UOperatingSystem *NewOS)
    +DestroyOperatingSystemBaseWidget()
    +ThemeChanged(UOperatingSystemSettingModule_Theme *ThemeP
    +ParentOS : TObjectPtr< UOperatingSystem() >
    +NativeConstruct() override
    +OnDestroyWidget()
    +K2_OnSetOperatingSystem()
    +bHasBlueprintOnSetOperatingSystem : uint8
    +bHasBlueprintOnOperatingSystemThemeChanged : uint8
  }

Caller impact — SetOperatingSystem

Documented call sites inside the plugin (3):

flowchart LR
  UOperatingSystemWidgetBase__SetOperatingSystem["UOperatingSystemWidgetBase::SetOperatingSystem"]
  UOperatingSystemWidget__CreateNewWindow["UOperatingSystemWidget::CreateNewWindow"]
  UOperatingSystemWidget__CreateNewWindow --> UOperatingSystemWidgetBase__SetOperatingSystem
  UOperatingSystemSettingModuleWidget__Internal_SetOperatingSystem["UOperatingSystemSettingModuleWidget::Internal_SetOperatingSystem"]
  UOperatingSystemSettingModuleWidget__Internal_SetOperatingSystem --> UOperatingSystemWidgetBase__SetOperatingSystem
  UOperatingSystemWidgetBase__NativeConstruct["UOperatingSystemWidgetBase::NativeConstruct"]
  UOperatingSystemWidgetBase__NativeConstruct --> UOperatingSystemWidgetBase__SetOperatingSystem

This is an abstract base class that represents an operating system widget. It inherits from UCommonUserWidget and IOperatingSystemThemeInterface. It provides functionality to set the operating system, handle theme changes, and call blueprint events.

Public Methods

Return	Name	Description
	UOperatingSystemWidgetBase
void	SetOperatingSystem	Sets the given new Operating System as Parent OS and calls OnSetOperatingSystem event in Blueprint
void	DestroyOperatingSystemBaseWidget	Destroys the operating system base widget.
void	ThemeChanged	Callback function for handling theme changes in the operating system widget.

---

UOperatingSystemWidgetBase

UOperatingSystemWidgetBase()

Defined in OperatingSystemWidgetBase.h:53

References

• CHECK_IN_BP
• IMPLEMENTED_IN_BP_LAMBDA

---

SetOperatingSystem

void SetOperatingSystem(UOperatingSystem * NewOS)

Defined in OperatingSystemWidgetBase.h:61 Sets the given new Operating System as Parent OS and calls OnSetOperatingSystem event in Blueprint

Parameters

• NewOS New OS to set.

Referenced by

• CreateNewWindow
• Internal_SetOperatingSystem
• NativeConstruct

References

• bHasBlueprintOnSetOperatingSystem
• K2_OnSetOperatingSystem
• ParentOS

---

DestroyOperatingSystemBaseWidget

void DestroyOperatingSystemBaseWidget()

Defined in OperatingSystemWidgetBase.h:75 Destroys the operating system base widget.

This function is called to destroy the operating system base widget. It performs the following actions:

1. Calls the OnDestroyWidget() virtual function.

2. Sets the ParentOS pointer to nullptr.

3. Removes the widget from its parent.

See also: UOperatingSystemWidgetBase::OnDestroyWidget()

See also: UOperatingSystemWidgetBase::RemoveFromParent()

References

• OnDestroyWidget
• ParentOS

---

ThemeChanged

void ThemeChanged(UOperatingSystemSettingModule_Theme * ThemePayload)

Defined in OperatingSystemWidgetBase.h:89 Callback function for handling theme changes in the operating system widget.

This function is invoked when the operating system theme is changed. It takes a ThemePayload parameter, which is an instance of the UOperatingSystemSettingModule_Theme class. ThemePayload contains information about the new theme that is being applied.

The function first checks if there are any blueprint events registered for handling theme changes. If there are, it calls the Execute_K2_OnOperatingSystemThemeChanged() function, passing this widget instance and the ThemePayload.

Parameters

• ThemePayload A pointer to the theme payload object that contains information about the new theme.

References

• bHasBlueprintOnOperatingSystemThemeChanged

Protected Attributes

Return	Name	Description
TObjectPtr< UOperatingSystem >	ParentOS	A pointer to the parent operating system of the operating system widget.

---

ParentOS

TObjectPtr< UOperatingSystem > ParentOS

Defined in OperatingSystemWidgetBase.h:49 A pointer to the parent operating system of the operating system widget.

This variable is a UObjectPtr that points to a UOperatingSystem object. It is marked as BlueprintReadOnly, which means it can be read from blueprints but not modified. It belongs to the OperatingSystemWidgetBase category and is exposed on spawn.

This variable is used to set and retrieve the operating system for the widget. The SetOperatingSystem() function can be called to set a new operating system, which will trigger the OnSetOperatingSystem event in the blueprint. The ParentOS variable is checked against the new OS to avoid unnecessary updates. If the ParentOS is invalid, the widget will be destroyed.

See also: UOperatingSystem

See also: UOperatingSystemWidgetBase::SetOperatingSystem()

See also: UOperatingSystemWidgetBase::OnSetOperatingSystem()

Referenced by

• BringWindowToFront
• DestroyOperatingSystemBaseWidget
• Internal_OnCreated
• NativeConstruct
• RemoveFromTaskbar
• SetOperatingSystem
• ToggleState

Protected Methods

Return	Name	Description
void	NativeConstruct virtual override
void	OnDestroyWidget virtual inline
void	K2_OnSetOperatingSystem	Blueprint event called when the operating system is set.

---

NativeConstruct

virtual override

virtual void NativeConstruct() override

Defined in OperatingSystemWidgetBase.h:93

References

• ParentOS
• SetOperatingSystem

---

OnDestroyWidget

virtual inline

virtual inline void OnDestroyWidget()

Defined in OperatingSystemWidgetBase.h:95

Referenced by

• DestroyOperatingSystemBaseWidget

Reimplemented by

• OnDestroyWidget

---

K2_OnSetOperatingSystem

void K2_OnSetOperatingSystem()

Defined in OperatingSystemWidgetBase.h:107 Blueprint event called when the operating system is set.

This event is called when the operating system for the widget is set using the SetOperatingSystem() function. Blueprint implementations can override this event to perform additional actions or handle the operating system change.

Note

This is a BlueprintImplementableEvent, meaning it can be implemented in blueprint.

See also: UOperatingSystemWidgetBase::SetOperatingSystem()

Referenced by

• SetOperatingSystem

Private Attributes

Return	Name	Description
uint8	bHasBlueprintOnSetOperatingSystem
uint8	bHasBlueprintOnOperatingSystemThemeChanged

---

bHasBlueprintOnSetOperatingSystem

uint8 bHasBlueprintOnSetOperatingSystem

Defined in OperatingSystemWidgetBase.h:25

Referenced by

• SetOperatingSystem

---

bHasBlueprintOnOperatingSystemThemeChanged

uint8 bHasBlueprintOnOperatingSystemThemeChanged

Defined in OperatingSystemWidgetBase.h:26

Referenced by

• ThemeChanged