UOperatingSystemFile

#include <OperatingSystemSimulator/Public/Files/OperatingSystemFile.h>

class UOperatingSystemFile

Defined in OperatingSystemFile.h:20

Inherits: UObject Subclassed by: UOperatingSystemAudioFile, UOperatingSystemVideoFile

Inheritance diagram

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemFile["UOperatingSystemFile"]
  class UObject["UObject"]
  UObject <|-- UOperatingSystemFile
  class UOperatingSystemAudioFile["UOperatingSystemAudioFile"]
  UOperatingSystemFile <|-- UOperatingSystemAudioFile
  class UOperatingSystemVideoFile["UOperatingSystemVideoFile"]
  UOperatingSystemFile <|-- UOperatingSystemVideoFile

Collaboration diagram

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemFile["UOperatingSystemFile"]
  class UOperatingSystemBaseProgram["UOperatingSystemBaseProgram"]
  UOperatingSystemFile *-- UOperatingSystemBaseProgram
  class UOperatingSystemFileIconWidget["UOperatingSystemFileIconWidget"]
  UOperatingSystemFile *-- UOperatingSystemFileIconWidget
  class UOperatingSystemFileWidget["UOperatingSystemFileWidget"]
  UOperatingSystemFile *-- UOperatingSystemFileWidget
  class IOperatingSystemExplorerInterface["IOperatingSystemExplorerInterface"]
  UOperatingSystemFile *-- IOperatingSystemExplorerInterface

Class detail

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemFile {
    +UOperatingSystemFile()
    +OpenFile(FGenericError &OutError)
    +CloseFile()
    +GetFileName(const bool bWithExtension=true) const FText
    +GetExtension() const FText
    +IsSameFile(const UOperatingSystemFile *OtherFile) cons bool
    +GetIconObject() const TSoftObjectPtr< UObject >
    +GetExplorerInterface() const TScriptInterface< IOperatingSystemExplor
    +CreateFile(TScriptInterface< IOperatingSystemExplorerI UOperatingSystemFile() *
    +CreateRuntimeFile(UOperatingSystemFile *ParentFile) UOperatingSystemFile() *
    +Name : FText
    +Extension : FText
    +IconObject : TSoftObjectPtr< UObject >
    +SpaceRequiredInMB : float
    +bIsDeletable : uint8
    +bIsMovable : uint8
    +TargetProgramClass : TSoftClassPtr< UOperatingSystemBaseProgr
    +IconWidgetClass : TSoftClassPtr< UOperatingSystemFileIconW
    +WidgetClass : TSoftClassPtr< UOperatingSystemFileWidge
    +ParentProgram : TWeakObjectPtr< UOperatingSystemBaseProg
    +FileWidget : TObjectPtr< UOperatingSystemFileWidget()
    +ParentExplorerInterface : TScriptInterface< IOperatingSystemExplor
    +bHasBlueprintOnOpen : bool
    +OnValidate(FGenericError &OutError)
    +CreateIconWidget() UOperatingSystemFileIconWidget() *
    +K2_OnOpen()
    +Internal_Validate(FGenericError &OutError)
  }

Caller impact — GetFileName

Documented call sites inside the plugin (4):

flowchart LR
  UOperatingSystemFile__GetFileName["UOperatingSystemFile::GetFileName"]
  UOperatingSystemFile__IsSameFile["UOperatingSystemFile::IsSameFile"]
  UOperatingSystemFile__IsSameFile --> UOperatingSystemFile__GetFileName
  UOperatingSystemAudioFile__OnValidate["UOperatingSystemAudioFile::OnValidate"]
  UOperatingSystemAudioFile__OnValidate --> UOperatingSystemFile__GetFileName
  UOperatingSystemVideoFile__OnValidate["UOperatingSystemVideoFile::OnValidate"]
  UOperatingSystemVideoFile__OnValidate --> UOperatingSystemFile__GetFileName
  UOperatingSystemFile__OpenFile["UOperatingSystemFile::OpenFile"]
  UOperatingSystemFile__OpenFile --> UOperatingSystemFile__GetFileName

Caller impact — GetExplorerInterface

Documented call sites inside the plugin (3):

flowchart LR
  UOperatingSystemFile__GetExplorerInterface["UOperatingSystemFile::GetExplorerInterface"]
  UOperatingSystemFileWidget__CreateFileWidget["UOperatingSystemFileWidget::CreateFileWidget"]
  UOperatingSystemFileWidget__CreateFileWidget --> UOperatingSystemFile__GetExplorerInterface
  UOperatingSystemFileIconWidget__CreateIconWidget["UOperatingSystemFileIconWidget::CreateIconWidget"]
  UOperatingSystemFileIconWidget__CreateIconWidget --> UOperatingSystemFile__GetExplorerInterface
  UOperatingSystemFile__CreateRuntimeFile["UOperatingSystemFile::CreateRuntimeFile"]
  UOperatingSystemFile__CreateRuntimeFile --> UOperatingSystemFile__GetExplorerInterface

UOperatingSystemFile is a class that represents a file in an operating system.

It provides properties and methods to manage file data and behavior, such as name, extension, icon, space required, and more.

Public Methods

Return	Name	Description
	UOperatingSystemFile
void	OpenFile	Opens the file in its associated program.
void	CloseFile	Closes the file and cleans up any associated resources.
FText	GetFileName const	Gets the file name.
FText	GetExtension const inline	Retrieves the extension of the file.
bool	IsSameFile const	Checks if the given file is the same as this file.
TSoftObjectPtr< UObject >	GetIconObject const inline	GetIconObject is a method that returns the icon object associated with the operating system file.
TScriptInterface< IOperatingSystemExplorerInterface >	GetExplorerInterface const inline	This method returns the TScriptInterface of the IOperatingSystemExplorer.

---

UOperatingSystemFile

UOperatingSystemFile()

Defined in OperatingSystemFile.h:78

References

• CHECK_IN_BP
• IMPLEMENTED_IN_BP_LAMBDA

---

OpenFile

void OpenFile(FGenericError & OutError)

Defined in OperatingSystemFile.h:164 Opens the file in its associated program.

This method is used to open the file using the associated program. If the associated program is not set or no compatible program is installed, an error message is generated and added to the operating system’s notification list.

Parameters

• OutError A reference to a FGenericError object that will contain any error messages.

See also: FGenericError

References

• Application
• bHasBlueprintOnOpen
• CreateFileWidget
• FileWidget
• GetFileName
• IsValid
• K2_OnOpen
• MAKE_ERROR
• OperatingSystem
• ParentExplorerInterface
• ParentProgram
• TargetProgramClass
• WidgetClass

---

CloseFile

void CloseFile()

Defined in OperatingSystemFile.h:177 Closes the file and cleans up any associated resources.

This method is used to close the file and perform any necessary cleanup operations. It resets the parent program and removes the file widget from the parent if it is valid.

Note

This method does not perform any file system operations, such as saving or deleting the file. It is solely responsible for closing the file in the application.

See also: UOperatingSystemFile::ParentProgram

See also: UOperatingSystemFile::FileWidget

References

• FileWidget
• ParentProgram

---

GetFileName

const

FText GetFileName(const bool bWithExtension = true) const

Defined in OperatingSystemFile.h:189 Gets the file name.

This method returns the file name of the operating system file. It can optionally include the file extension as well.

Parameters

• bWithExtension Whether to include the file extension in the returned file name. Default value is true.

Returns

The file name as a FText object.

Referenced by

• IsSameFile
• OnValidate
• OnValidate
• OpenFile

References

• Extension
• Name

---

GetExtension

const inline

inline FText GetExtension() const

Defined in OperatingSystemFile.h:199 Retrieves the extension of the file.

This method returns the extension of the file as a text string. The extension represents the part of the file name after the last period (.) character.

Returns

The extension of the file as a text string.

---

IsSameFile

const

bool IsSameFile(const UOperatingSystemFile * OtherFile) const

Defined in OperatingSystemFile.h:208 Checks if the given file is the same as this file.

Parameters

• OtherFile The file to compare with this file.

Returns

True if the given file is the same as this file, false otherwise.

References

• GetFileName

---

GetIconObject

const inline

inline TSoftObjectPtr< UObject > GetIconObject() const

Defined in OperatingSystemFile.h:229 GetIconObject is a method that returns the icon object associated with the operating system file.

Returns

A TSoftObjectPtr<UObject> object representing the icon object associated with the operating system file.

Note

The returned icon object can be used to display the file icon in user interfaces or perform any other operations related to the icon.

---

GetExplorerInterface

const inline

inline TScriptInterface< IOperatingSystemExplorerInterface > GetExplorerInterface() const

Defined in OperatingSystemFile.h:233 This method returns the TScriptInterface of the IOperatingSystemExplorer.

Referenced by

• CreateFileWidget
• CreateIconWidget
• CreateRuntimeFile

Public Static Methods

Return	Name	Description
UOperatingSystemFile *	CreateFile static	Creates a new file in the operating system.
UOperatingSystemFile *	CreateRuntimeFile static	Creates a runtime file based on the given parent file.

---

CreateFile

static

static UOperatingSystemFile * CreateFile(TScriptInterface< IOperatingSystemExplorerInterface > ExplorerInterface, const TSoftClassPtr< UOperatingSystemFile > & FileSoftClass, FGenericError & OutError)

Defined in OperatingSystemFile.h:98 Creates a new file in the operating system.

This method creates a new file in the operating system using the specified explorer interface and file class.

Parameters

• ExplorerInterface The interface to the operating system explorer used to create the file.

• FileSoftClass The soft class pointer to the file class that will be used to create the file.

• OutError (output) The error object that will be populated if an error occurs during file creation. If the file creation is successful, this error object will be cleared.

Returns

A pointer to the newly created file if the creation was successful, nullptr otherwise.

Note

The returned file object must be managed by the caller and can be null if an error occurs during file creation.

Note

The error message can be retrieved from OutError if the file creation fails.

Note

This method will check for a valid explorer interface, access rights, enough space, and duplicate file names/extensions before creating the file.

Note

This method will log the creation of the file with the file name, extension, and explorer interface path at a very verbose log level.

Note

This method is expected to be called within a valid scope. Any cleanup required after file creation should be done in the calling code.

Note

This method should be used to create files in the operating system.

Referenced by

• CreateDirectory
• LoadFiles

References

• ErrorExceptionDescription
• IsValid
• MAKE_ERROR
• NEW_SOFT_OBJ
• OS_LOG_ERROR
• OS_LOG_VERY_VERBOSE
• OS_LOG_WARN
• Reset

---

CreateRuntimeFile

static

static UOperatingSystemFile * CreateRuntimeFile(UOperatingSystemFile * ParentFile)

Defined in OperatingSystemFile.h:111 Creates a runtime file based on the given parent file.

This method creates a new runtime file by copying the properties of the parent file and setting the necessary flags.

Parameters

• ParentFile The parent file from which the runtime file will be created. Must have RF_Transient flag.

Returns

The newly created runtime file. This file is managed by the caller and is expected to be deleted when no longer needed.

Note

This method ensures that the ParentFile has RF_Transient flag.

Note

The returned file object must be managed by the caller.

Referenced by

• OpenFile

References

• GetExplorerInterface
• NEW_OBJ

Protected Attributes

Return	Name	Description
FText	Name	Name of this file without extension.
FText	Extension	Extension represents the file extension of an operating system file.
TSoftObjectPtr< UObject >	IconObject	Obvious right? C’mon its just an Icon. What you need a tooltip for ¯(ツ)/¯
float	SpaceRequiredInMB	How much space does this file require on hard disk.
uint8	bIsDeletable	Is this file deletable?
uint8	bIsMovable	Is this file movable?
TSoftClassPtr< UOperatingSystemBaseProgram >	TargetProgramClass	Target class for the program that can open this file.
TSoftClassPtr< UOperatingSystemFileIconWidget >	IconWidgetClass	Target icon class for this file.
TSoftClassPtr< UOperatingSystemFileWidget >	WidgetClass	Target widget class for this file.
TWeakObjectPtr< UOperatingSystemBaseProgram >	ParentProgram	Program instance that owns this file.
TObjectPtr< UOperatingSystemFileWidget >	FileWidget	Widget spawned by this file.
TScriptInterface< IOperatingSystemExplorerInterface >	ParentExplorerInterface
bool	bHasBlueprintOnOpen

---

Name

FText Name

Defined in OperatingSystemFile.h:28 Name of this file without extension.

Referenced by

• CreateIconWidget
• GetFileName
• GetProgramName
• Internal_Validate

---

Extension

FText Extension

Defined in OperatingSystemFile.h:32 Extension represents the file extension of an operating system file.

Referenced by

• GetFileName
• UOperatingSystemAudioFile
• UOperatingSystemVideoFile

---

IconObject

TSoftObjectPtr< UObject > IconObject

Defined in OperatingSystemFile.h:36 Obvious right? C’mon its just an Icon. What you need a tooltip for ¯(ツ)/¯

Referenced by

• Internal_Validate
• UOperatingSystemAudioFile
• UOperatingSystemVideoFile

---

SpaceRequiredInMB

float SpaceRequiredInMB

Defined in OperatingSystemFile.h:40 How much space does this file require on hard disk.

Referenced by

• GetSpaceRequiredInMB
• Internal_Validate

---

bIsDeletable

uint8 bIsDeletable

Defined in OperatingSystemFile.h:44 Is this file deletable?

---

bIsMovable

uint8 bIsMovable

Defined in OperatingSystemFile.h:48 Is this file movable?

---

TargetProgramClass

TSoftClassPtr< UOperatingSystemBaseProgram > TargetProgramClass

Defined in OperatingSystemFile.h:52 Target class for the program that can open this file.

Referenced by

• OpenFile
• UOperatingSystemAudioFile
• UOperatingSystemVideoFile

---

IconWidgetClass

TSoftClassPtr< UOperatingSystemFileIconWidget > IconWidgetClass

Defined in OperatingSystemFile.h:56 Target icon class for this file.

Referenced by

• CreateIconWidget
• Internal_Validate

---

WidgetClass

TSoftClassPtr< UOperatingSystemFileWidget > WidgetClass

Defined in OperatingSystemFile.h:60 Target widget class for this file.

Referenced by

• Internal_Validate
• OpenFile
• UOperatingSystemAudioFile
• UOperatingSystemVideoFile

---

ParentProgram

TWeakObjectPtr< UOperatingSystemBaseProgram > ParentProgram

Defined in OperatingSystemFile.h:64 Program instance that owns this file.

Referenced by

• CloseFile
• OpenFile

---

FileWidget

TObjectPtr< UOperatingSystemFileWidget > FileWidget

Defined in OperatingSystemFile.h:68 Widget spawned by this file.

Referenced by

• CloseFile
• OpenFile

---

ParentExplorerInterface

TScriptInterface< IOperatingSystemExplorerInterface > ParentExplorerInterface

Defined in OperatingSystemFile.h:71

Referenced by

• OpenFile

---

bHasBlueprintOnOpen

bool bHasBlueprintOnOpen

Defined in OperatingSystemFile.h:74

Referenced by

• OpenFile

Protected Methods

Return	Name	Description
void	OnValidate virtual inline	Execute custom validation logic for the operating system file.
UOperatingSystemFileIconWidget *	CreateIconWidget	Creates an operating system file icon widget.
void	K2_OnOpen	K2_OnOpen is an event method that is called when the operating system file is opened.

---

OnValidate

virtual inline

virtual inline void OnValidate(FGenericError & OutError)

Defined in OperatingSystemFile.h:141 Execute custom validation logic for the operating system file.

This virtual method can be overridden in derived classes to provide custom validation logic for the operating system file. The derived class should implement the desired validation logic and modify the OutError object if there are any validation failures.

Parameters

• OutError [in,out] The error object to store the validation failures, if any.

Note

The derived class should call the base class implementation of this method to perform any common validation checks before adding its own custom validation logic.

See also: FGenericError

Referenced by

• Internal_Validate

Reimplemented by

• OnValidate
• OnValidate

---

CreateIconWidget

UOperatingSystemFileIconWidget * CreateIconWidget()

Defined in OperatingSystemFile.h:149 Creates an operating system file icon widget.

Returns

A pointer to the created operating system file icon widget. Returns nullptr if the icon widget class is null.

References

• CreateIconWidget
• IconWidgetClass
• Name
• OS_LOG_ERROR

---

K2_OnOpen

void K2_OnOpen()

Defined in OperatingSystemFile.h:218 K2_OnOpen is an event method that is called when the operating system file is opened.

This method is blueprint implementable, allowing subclasses to override and provide custom functionality when the file is opened.

Referenced by

• OpenFile

Private Methods

Return	Name	Description
void	Internal_Validate	Validates the internal state of the operating system file.

---

Internal_Validate

void Internal_Validate(FGenericError & OutError)

Defined in OperatingSystemFile.h:123 Validates the internal state of the operating system file.

This method checks if the name, icon, space required setting, icon widget class, and widget class are valid. If any of these properties are invalid, it generates an error message using the class name and returns it through the OutError parameter.

Parameters

• OutError A reference to a FGenericError object that will contain the error message if any validation errors occur.

References

• IconObject
• IconWidgetClass
• MAKE_ERROR
• Name
• OnValidate
• SpaceRequiredInMB
• WidgetClass