lecui 1.0.0-alpha.20
lecui C++ user interface library
Public Member Functions | List of all members
liblec::lecui::filesystem Class Reference

Interact with the OS file system. More...

#include <filesystem.h>

Public Member Functions

 filesystem (form &fm)
 Constructor. More...
 
 ~filesystem ()
 Destructor.
 
std::string select_folder (const std::string &title)
 Display a 'select folder' modal dialog. More...
 
std::vector< std::string > open_file (const open_file_params &params)
 Display an 'open file' modal dialog. More...
 
std::string save_file (const std::string &file, const save_file_params &params)
 Display a 'save file' modal dialog so the user can select its properties and location. More...
 

Detailed Description

Interact with the OS file system.

Constructor & Destructor Documentation

◆ filesystem()

liblec::lecui::filesystem::filesystem ( form fm)

Constructor.

Parameters
fmA reference to the form.

Member Function Documentation

◆ open_file()

std::vector< std::string > liblec::lecui::filesystem::open_file ( const open_file_params params)

Display an 'open file' modal dialog.

Parameters
paramsThe parameters of the dialog.
Returns
A list of the full paths to the selected file(s), including the extensions.

◆ save_file()

std::string liblec::lecui::filesystem::save_file ( const std::string &  file,
const save_file_params params 
)

Display a 'save file' modal dialog so the user can select its properties and location.

Parameters
fileThe suggested name of the file.
paramsThe parameters of the dialog.
Returns
The full path the user desires, including the filename and extension.

◆ select_folder()

std::string liblec::lecui::filesystem::select_folder ( const std::string &  title)

Display a 'select folder' modal dialog.

Parameters
titleThe title of the dialog.
Returns
The full path to the selected folder. Empty if none is selected.

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