UOperatingSystemTaskbarButton

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

class UOperatingSystemTaskbarButton

Defined in OperatingSystemTaskbarButton.h:20

Inherits: UOperatingSystemWidgetBase

Inheritance diagram

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemTaskbarButton["UOperatingSystemTaskbarButton"]
  class UOperatingSystemWidgetBase["UOperatingSystemWidgetBase"]
  UOperatingSystemWidgetBase <|-- UOperatingSystemTaskbarButton

Collaboration diagram

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemTaskbarButton["UOperatingSystemTaskbarButton"]
  class EOperatingSystemProgramViewState["EOperatingSystemProgramViewState"]
  UOperatingSystemTaskbarButton ..> EOperatingSystemProgramViewState
  class UOperatingSystemBaseProgram["UOperatingSystemBaseProgram"]
  UOperatingSystemTaskbarButton *-- UOperatingSystemBaseProgram

Class detail

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemTaskbarButton {
    +UOperatingSystemTaskbarButton()
    +RemoveFromTaskbar()
    +ChangeTaskbarState(const EOperatingSystemProgramViewState NewS bool
    +GetParentProgram() const UOperatingSystemBaseProgram() *
    +GetCurrentState() const EOperatingSystemProgramViewState()
    +CreateTaskbarButton(UOperatingSystemBaseProgram *OwningProgram) UOperatingSystemTaskbarButton() *
    +CurrentState : EOperatingSystemProgramViewState()
    +ParentProgram : TWeakObjectPtr< UOperatingSystemBaseProg
    +ToggleState()
    +K2_OnCreated()
    +Internal_OnCreated()
    +Internal_OnWindowBroughtToFront(UDraggableWindow *FocusedWindow)
  }

Represents a taskbar button in the operating system.

UOperatingSystemTaskbarButton is an abstract class that represents a taskbar button in an operating system. It inherits from UOperatingSystemWidgetBase and provides functions and variables specific to the taskbar button.

Public Methods

Return	Name	Description
	`UOperatingSystemTaskbarButton`
`void`	`RemoveFromTaskbar`
`bool`	`ChangeTaskbarState`	Changes the state of the taskbar button to the specified state.
`UOperatingSystemBaseProgram *`	`GetParentProgram` `const`
`EOperatingSystemProgramViewState`	`GetCurrentState` `const` `inline`	Returns the current state of the taskbar button. This method returns the current state of the taskbar button.

UOperatingSystemTaskbarButton

UOperatingSystemTaskbarButton()

Defined in OperatingSystemTaskbarButton.h:41

RemoveFromTaskbar

void RemoveFromTaskbar()

Defined in OperatingSystemTaskbarButton.h:59

References

ParentOS
ParentProgram

ChangeTaskbarState

bool ChangeTaskbarState(const EOperatingSystemProgramViewState NewState)

Defined in OperatingSystemTaskbarButton.h:74 Changes the state of the taskbar button to the specified state.

This method changes the state of the taskbar button to the specified state. If the current state and the new state are not the same, the method updates the current state, triggers the OnProgramWindowStateChanged event on the parent program, and returns true. If the current state and the new state are the same, the method does nothing and returns false.

Parameters

NewState The new state of the taskbar button.

Returns

Returns true if the state was changed, false otherwise.

References

CurrentState
ParentProgram

GetParentProgram

const

UOperatingSystemBaseProgram * GetParentProgram() const

Defined in OperatingSystemTaskbarButton.h:109

References

ParentProgram

GetCurrentState

const inline

inline EOperatingSystemProgramViewState GetCurrentState() const

Defined in OperatingSystemTaskbarButton.h:118 Returns the current state of the taskbar button. This method returns the current state of the taskbar button.

Returns

The current state of the taskbar button as an EOperatingSystemProgramViewState enum value.

See also: EOperatingSystemProgramViewState

Public Static Methods

Return	Name	Description
`UOperatingSystemTaskbarButton *`	`CreateTaskbarButton` `static`	Creates a taskbar button for the specified owning program.

CreateTaskbarButton

static

static UOperatingSystemTaskbarButton * CreateTaskbarButton(UOperatingSystemBaseProgram * OwningProgram)

Defined in OperatingSystemTaskbarButton.h:57 Creates a taskbar button for the specified owning program.

This method creates a taskbar button for the specified owning program. It returns a pointer to the created taskbar button.

Parameters

OwningProgram The owning program for which the taskbar button will be created.

Returns

A pointer to the created taskbar button. If the owning program’s taskbar button class is null, the method returns nullptr.

Referenced by

StartProgram

References

Protected Attributes

Return	Name	Description
`EOperatingSystemProgramViewState`	`CurrentState`
`TWeakObjectPtr< UOperatingSystemBaseProgram >`	`ParentProgram`	Represents the parent program associated with the taskbar button. It is a weak reference to a UOperatingSystemBaseProgram object. The parent program is the program to which the taskbar button belongs.

CurrentState

EOperatingSystemProgramViewState CurrentState

Defined in OperatingSystemTaskbarButton.h:27

Referenced by

ChangeTaskbarState
ToggleState

ParentProgram

TWeakObjectPtr< UOperatingSystemBaseProgram > ParentProgram

Defined in OperatingSystemTaskbarButton.h:37 Represents the parent program associated with the taskbar button. It is a weak reference to a UOperatingSystemBaseProgram object. The parent program is the program to which the taskbar button belongs.

Referenced by

ChangeTaskbarState
GetParentProgram
Internal_OnWindowBroughtToFront
RemoveFromTaskbar
ToggleState

Protected Methods

Return	Name	Description
`void`	`ToggleState`	Toggles the state of the taskbar button. If the current state is Focused or NotFocused, it will minimize the parent program. If the current state is Minimized or MinimizedAndNotFocused, it will restore the minimized program.
`void`	`K2_OnCreated`	This method is called when the taskbar button is created.

ToggleState

void ToggleState()

Defined in OperatingSystemTaskbarButton.h:88 Toggles the state of the taskbar button. If the current state is Focused or NotFocused, it will minimize the parent program. If the current state is Minimized or MinimizedAndNotFocused, it will restore the minimized program.

References

CurrentState
Focused
ParentOS
ParentProgram

K2_OnCreated

void K2_OnCreated()

Defined in OperatingSystemTaskbarButton.h:105 This method is called when the taskbar button is created.

This method is an event that is called when the taskbar button is created. It is a BlueprintImplementableEvent, which means that it can be implemented in Blueprint subclasses of UOperatingSystemTaskbarButton to provide additional functionality. It is called after the taskbar button is created and initialized.

Referenced by

Internal_OnCreated

Private Methods

Return	Name	Description
`void`	`Internal_OnCreated`
`void`	`Internal_OnWindowBroughtToFront`

Internal_OnCreated

void Internal_OnCreated()

Defined in OperatingSystemTaskbarButton.h:78

References

ChangeTaskbarState
Focused
Internal_OnWindowBroughtToFront
K2_OnCreated
ParentOS

Internal_OnWindowBroughtToFront

void Internal_OnWindowBroughtToFront(UDraggableWindow * FocusedWindow)

Defined in OperatingSystemTaskbarButton.h:79

Referenced by

Internal_OnCreated

References

ChangeTaskbarState
Focused
ParentProgram