A class for representing a video player program in the operating system. More...

#include "OperatingSystemVideoPlayer.h"

Inheritance diagram for UOperatingSystemVideoPlayer:

Collaboration diagram for UOperatingSystemVideoPlayer:

Public Member Functions
	UOperatingSystemVideoPlayer ()

Public Member Functions inherited from UOperatingSystemBaseProgram
	UOperatingSystemBaseProgram ()

UOperatingSystemBaseProgram *	StartProgram (FGenericError &OutError)

bool	IsRunning () const

bool	CanAddToDesktop () const

UOperatingSystem *	GetOperatingSystem () const

UOperatingSystemProgramIconWidget *	CreateIconWidget ()

UOperatingSystemProgramIconWidget *	GetIconWidget () const

void	OpenFile (UOperatingSystemFile *TargetFile, FGenericError &OutError)

void	CloseProgram (const bool bIsFullClose, FGenericError &OutError)

void	BringToFront (FGenericError &OutError) const

UDraggableWindow *	GetParentWindow () const

void	IsCompatibleWithOS (const TWeakObjectPtr< const UOperatingSystem > TestOS, FGenericError &OutError) const

bool	CanSaveSettings () const

void	SetParentPartition (TWeakObjectPtr< UOperatingSystemPartition > OwningPartition)

void	OnProgramWindowStateChanged (const EOperatingSystemProgramViewState &NewState) const

bool	IsWindowMaximized () const
	Checks whether the window of the operating system base program is maximized.

virtual OPERATINGSYSTEMSIMULATOR_API FString	GetSaveSlotName () const

TOptional< FVector2D >	GetWindowPosition () const
	Retrieves the position of the window associated with the operating system program.

TWeakObjectPtr< UOperatingSystemPartition >	GetParentPartition () const
	Get the parent partition of the current operating system program.

TSoftClassPtr< UOperatingSystemProgramIconWidget >	GetIconWidgetClass () const
	Retrieves the class of the icon widget for the operating system program.

TSoftClassPtr< UOperatingSystemProgramWidget >	GetWidgetClass () const
	Retrieves the widget class associated with the operating system base program. This method returns the widget class that should be used to create the program widget for the specific program.

TSoftClassPtr< UOperatingSystemProgramSettings >	GetSettingsClass () const
	Get the settings class associated with this program. This method returns the class type of the settings object specific to this program.

TSoftClassPtr< UOperatingSystemProgramData >	GetDataClass () const
	Retrieves the data class associated with the program.

TSoftClassPtr< UOperatingSystemTaskbarButton >	GetTaskbarButtonClass () const
	Retrieves the taskbar button class associated with the program.

TWeakObjectPtr< UOperatingSystemProgramSettings >	GetSettings () const
	Get the settings object for the program.

TWeakObjectPtr< UOperatingSystemProgramData >	GetDataObj () const
	Retrieves the data object associated with the operating system program.

TWeakObjectPtr< UOperatingSystemTaskbarButton >	GetTaskbarButton () const
	Retrieves the taskbar button associated with the program.

UOperatingSystemProgramWidget *	GetProgramWidget () const
	Returns the program widget associated with the operating system program.

template<class T >
T *	GetSettings () const
	Get the settings object of type T.

template<class T >
T *	GetDataObj () const
	Returns the data object associated with the program.

FORCEINLINE FString	GetProgramName () const
	Returns the program name as a FString.

FORCEINLINE FName	GetIdentifier () const
	Returns the identifier of the program. The identifier serves as a unique identification for the program.

FORCEINLINE bool	IsSingleInstanceProgram () const
	Returns a boolean value indicating whether the program is a single instance program. A single instance program is a program that allows only one instance to run at a time.

FORCEINLINE bool	IsSystemInstalledProgram () const
	Returns a boolean value indicating whether the program is installed on the system. If the program is installed, it will return true; otherwise, it will return false.

FORCEINLINE uint32	GetProcessID () const
	Retrieves the process ID of the current program. This method allows you to obtain the unique process ID of the program.

FORCEINLINE float	GetSpaceRequiredInMB () const
	Get the space required by the program in megabytes. This method returns the space required by the program in megabytes.

FORCEINLINE bool	ShouldRememberLastWindowPosition () const
	Indicates whether the program should remember the last window position.

OPERATINGSYSTEMSIMULATOR_API FORCEINLINE EOperatingSystemProgramCloseMethod	GetCloseMethod () const
	Returns the close method of the operating system program.

Protected Member Functions
virtual void	OnOpenFile (UOperatingSystemFile *TargetFile, FGenericError &OutError) override
	Method for opening a file in the video player program.

virtual void	OnClose (FGenericError &OutError) override
	Method for handling the closing of the video player program.

Protected Member Functions inherited from UOperatingSystemBaseProgram
virtual OPERATINGSYSTEMSIMULATOR_API void	OnValidate (FGenericError &OutError) const
	OnValidate method for validating program-specific logic.

virtual OPERATINGSYSTEMSIMULATOR_API void	OnStart (FGenericError &OutError)
	Called when the program starts. It should be overridden in derived classes to provide the necessary functionality for the specific program.

virtual OPERATINGSYSTEMSIMULATOR_API void	OnThemeChanged (UOperatingSystemSettingModule_Theme *ThemePayload)
	Virtual method called when the theme is changed.

void	K2_OnCreate ()

void	K2_OnInstall ()

FGenericError	K2_OnStart ()

void	K2_OnClose ()

void	K2_OnSettingsLoad (UOperatingSystemProgramSettings *LoadedSettings)

void	K2_OnOpenFile (FGenericError &OutError)

void	K2_OnValidate (FGenericError &OutError) const

FString	K2_GetSaveSlotName () const

Additional Inherited Members
Static Public Member Functions inherited from UOperatingSystemBaseProgram
static UE_NODISCARD UOperatingSystemBaseProgram *	CreateProgram (TWeakObjectPtr< UOperatingSystem > OwningOS, const TSoftClassPtr< UOperatingSystemBaseProgram > &ProgramClass, FGenericError &OutError, const bool bInstalledWithOS=false)

static OPERATINGSYSTEMSIMULATOR_API bool	IsStoreItemFree (const FOperatingSystemStoreProgramData &ProgramData)

Public Attributes inherited from UOperatingSystemBaseProgram
FOnOperatingSystemProgramViewStateChanged	OnOperatingSystemProgramViewStateChanged

Protected Attributes inherited from UOperatingSystemBaseProgram
FText	Name

FText	Author

FText	Description

FName	Identifier

FOperatingSystemVersion	Version

FText	StoreDisplayName

FText	StoreType

float	StorePrice

FGameplayTagContainer	SupportedOperatingSystems

uint8	bRequireMinOperatingSystemVersion: 1

FOperatingSystemVersion	MinOperatingSystemVersion

TSoftObjectPtr< UObject >	IconObject

float	SpaceRequiredInMB

TSoftClassPtr< UOperatingSystemProgramIconWidget >	IconWidgetClass

TSoftClassPtr< UOperatingSystemProgramWidget >	WidgetClass

EOperatingSystemProgramCloseMethod	CloseMethod

EOperatingSystemProgramSaveMethod	SaveMethod

TSoftClassPtr< UOperatingSystemProgramSettings >	SettingsClass

TSoftClassPtr< UOperatingSystemProgramData >	DataClass

uint8	bRequiresData: 1

uint8	bAddToDesktop: 1

uint8	bCreateNotification: 1

uint8	bSingleInstanceOnly: 1

uint8	bCanRunOnPortableDevice: 1

uint8	bCreateSettingsBeforeStarting: 1

uint8	bRememberLastWindowPosition: 1

uint8	bAllowDragging: 1

uint8	bAllowResizing: 1

uint8	bOverrideWindowSize: 1

FVector2D	OverrideWindowSize

FVector2D	MinimumWindowResize

EOperatingSystemWindowStartupState	StartWindowState

TSoftClassPtr< UDraggableWindow >	OverrideWindowClass

TSoftClassPtr< UOperatingSystemTaskbarButton >	TaskbarButtonClass

TWeakObjectPtr< UOperatingSystemPartition >	ParentPartition

Detailed Description

A class for representing a video player program in the operating system.

This class derives from UOperatingSystemBaseProgram and provides functionality for opening video files and closing the program.

Constructor & Destructor Documentation

◆ UOperatingSystemVideoPlayer()

UOperatingSystemVideoPlayer::UOperatingSystemVideoPlayer ( )

Member Function Documentation

◆ OnClose()

void UOperatingSystemVideoPlayer::OnClose ( FGenericError & OutError )

overrideprotectedvirtual

Method for handling the closing of the video player program.

This method is called when the user wants to close the video player program. It stops the media audio in the device actor associated with the parent device. It modifies the OutError object if any error occurs during the closing process.

Warning: DO NOT call this function directly. Close the program instead to automatically close the file.

Parameters

OutError An FGenericError object that will store any error information.

Reimplemented from UOperatingSystemBaseProgram.

Here is the call graph for this function:

◆ OnOpenFile()

void UOperatingSystemVideoPlayer::OnOpenFile	(	UOperatingSystemFile *	TargetFile,
		FGenericError &	OutError )

overrideprotectedvirtual

Method for opening a file in the video player program.

This method is called when a user selects a file to open in the video player program. It takes a pointer to the target file to be opened and an FGenericError object as input. The method calls the OnOpenFile method of the UOperatingSystemVideoPlayerProgramData class to handle the file opening logic. It modifies the OutError object if any error occurs during the file opening process.

Warning: DO NOT call this function directly. Use UOperatingSystemStatics::OpenFile function instead.

Parameters

TargetFile	A pointer to the UOperatingSystemFile object representing the file to be opened.
OutError	An FGenericError object that will store any error information.

Reimplemented from UOperatingSystemBaseProgram.

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

Source/OperatingSystemSimulator/Public/Programs/VideoPlayer/OperatingSystemVideoPlayer.h
Source/OperatingSystemSimulator/Private/Programs/VideoPlayer/OperatingSystemVideoPlayer.cpp

Public Member Functions