UFileUtilities Class Reference

#include <FileUtilities.h>

Inheritance diagram for UFileUtilities:

Collaboration diagram for UFileUtilities:

Static Public Member Functions
static void	OpenFileExplorer (FString Path)
static FString	OpenFileDialogReturnFirst (const FString &Path)
static TArray< FString >	OpenFileDialogReturnFiles (const FString &Path)

Detailed Description

A class for file related utilities.

Definition at line 17 of file FileUtilities.h.

Member Function Documentation

OpenFileDialogReturnFiles()

TArray< FString > UFileUtilities::OpenFileDialogReturnFiles ( const FString &  Path )

static

Opens a file dialog to allow the user to select multiple files. Note: This function pauses the entire game while the file dialog is open.

Parameters

Path	The initial path to start the file dialog from.

Returns

An array of full paths of the selected files, or an empty array if no files were selected or the operation was canceled.

Definition at line 36 of file FileUtilities.cpp.

{
    TArray<FString> OutFiles;
 
    // OpenFileDialog doesn't work in packaged builds.
#if !WITH_EDITOR
    return OutFiles;
#endif
 
    IDesktopPlatform* DesktopPlatform = FDesktopPlatformModule::Get();
    if (!DesktopPlatform)
    {
        return OutFiles;
    }
 
    FString DefaultPath = Path.IsEmpty() ? FPaths::ProjectDir() : Path;
 
    // Create a file picker dialog
    bool bOpened = DesktopPlatform->OpenFileDialog(
        nullptr,
        NSLOCTEXT("FileUtilities", "OpenFileDialog", "Choose a file").ToString(),
        DefaultPath,
        FString(),
        TEXT("All Files (*.*)|*.*"),
        EFileDialogFlags::Multiple,
        OutFiles
    );
 
    if (bOpened)
    {
        for (FString& FilePath : OutFiles)
        {
            // Convert relative path to full path
            FilePath = FPaths::ConvertRelativePathToFull(FilePath);
        }
    }
 
    return OutFiles;
}

Referenced by OpenFileDialogReturnFirst().

OpenFileDialogReturnFirst()

FString UFileUtilities::OpenFileDialogReturnFirst ( const FString &  Path )

static

Opens a file dialog to allow the user to select a file. Note: This function pauses the entire game while the file dialog is open.

Parameters

Path	The initial path to start the file dialog from.

Returns

The full path of the selected file, or an empty string if no file was selected or the operation was canceled.

Definition at line 23 of file FileUtilities.cpp.

{
    FString File;
    TArray<FString> Files = OpenFileDialogReturnFiles(Path);
 
    if (!Files.IsEmpty())
    {
        File = Files[0];
    }
 
    return File;
}

References OpenFileDialogReturnFiles().

OpenFileExplorer()

void UFileUtilities::OpenFileExplorer ( FString  Path )

static

Opens the file explorer at the specified path.

Parameters

Path	The path to open in the file explorer.

Definition at line 14 of file FileUtilities.cpp.

{
    FString AbsolutePath = FPaths::ConvertRelativePathToFull(Path);
    if (FPaths::DirectoryExists(AbsolutePath))
    {
        FPlatformProcess::ExploreFolder(*AbsolutePath);
    }
}

Referenced by ULogFile::OpenFilePath().

---

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

• Unreal/Agrarsense/Source/Agrarsense/Utils/FileUtilities.h
• Unreal/Agrarsense/Source/Agrarsense/Utils/FileUtilities.cpp