Struct FileDialog

pub struct FileDialog { /* private fields */ }

A struct representing a file dialog window.

This struct is used to display a file dialog window to the user, allowing them to select a file or folder. It provides an interface to the operating system’s file dialog APIs, which are used to display the dialog and retrieve the selected file or folder location.

Examples

Creating a new FileDialog and showing it to the user, returning the path selected:

use nvdialog_rs as nvdialog;
use nvdialog::FileDialog;
use nvdialog::FileDialogType;

let mut file_dialog = FileDialog::new("Title", FileDialogType::OpenFile);
let path = PathBuf::new();
if let Some(filename) = file_dialog.retrieve_filename() {
    path = filename;
    // do something with the returned Path
} else {
    println!("No file selected.");
}

FFI

Corresponds to NvdFileDialog.

Implementations

impl FileDialog

pub fn new<S: AsRef<str>>( title: S, type_of_dialog: FileDialogType, file_extensions: Option<impl IntoIterator<Item = S>>, ) -> Self

Creates a new FileDialog instance with the specified title and type of dialog.

This function returns a new FileDialog instance with a raw pointer to the underlying NvdFileDialog struct initialized based on the specified type of dialog. The title argument specifies the title to be displayed in the file dialog window. The type_of_dialog argument determines whether the dialog is used for opening a file (FileDialogType::OpenFile) or saving a file (FileDialogType::SaveFile).

If FileDialogType::OpenFile is specified, the raw pointer is obtained by calling the nvd_open_file_dialog_new function from the underlying C API. If FileDialogType::SaveFile is specified, the raw pointer is obtained by calling the nvd_save_file_dialog_new function from the underlying C API. In the case of FileDialogType::SaveFile, the dialog defaults to suggesting a filename of “filename”.

Examples

Creating a new FileDialog instance for opening a file:

let file_dialog = FileDialog::new("Open File", FileDialogType::OpenFile);

Creating a new FileDialog instance for saving a file:

let file_dialog = FileDialog::new("Save File", FileDialogType::SaveFile);

Examples found in repository

examples/folder-save-dialog.rs (line 29)

fn main() {
    nvdialog_rs::init().expect("failed to initialize nvdialog");
    let mut folder_dialog = FileDialog::new("Choose a folder", FileDialogType::OpenFolder, None::<Vec<&str>>);
    let mut where_to_save = FileDialog::new("Save as...", FileDialogType::SaveFile, None::<Vec<&str>>);
    
    if let Some(p) = folder_dialog.retrieve_filename() {
        println!("You chose folder {}", p.display());
    }

    if let Some(s) = where_to_save.retrieve_filename() {
        println!("Saved as {}", s.display());
    }
}

examples/file-dialog.rs (lines 33-43)

fn main() {
    nvdialog_rs::init().expect("Can't initialize NvDialog");
    let mut file_dialog = FileDialog::new(
        String::from("Select an image"),
        FileDialogType::OpenFile,
        Some(vec![
            "png".to_owned(),
            "jpg".to_owned(),
            "jpeg".to_owned(),
            "ico".to_owned(),
            "webp".to_owned(),
        ]),
    );

    if let Some(file) = file_dialog.retrieve_filename() {
        DialogBox::new("File chosen", &file.to_str().unwrap(), DialogType::Simple)
            .expect("Can't create dialog")
            .show()
    } else {
        DialogBox::new("Error", "No file chosen", DialogType::Error)
            .expect("Can't create dialog")
            .show()
    }
}

pub fn retrieve_filename(&mut self) -> Option<PathBuf>

Retrieves the file name selected in the file dialog. This function returns a PathBuf instance containing the selected file name, or None if no file was selected.

This function calls the nvd_get_file_location function from the underlying C API. If the returned pointer from NvDialog is NULL, this function returns None. If the pointer is not null, this function constructs a CStr instance from the raw buffer, and constructs a PathBuf instance from the CStr.

Safety

This function constructs the returned PathBuf using C bytes, which may cause a panic if the C data contains non-valid UTF-8 characters.

Returns

• Some(PathBuf) if a file was selected and the selected file name could be converted to a PathBuf instance.
• None if no file was selected.

Panics

This function may panic with the message “Invalid UTF-8 data” if the raw buffer returned from the underlying C API contains invalid UTF-8 data.

Examples

let mut file_dialog = FileDialog::new("Open File", FileDialogType::OpenFile);

if let Some(path) = file_dialog.retrieve_filename() {
    // A file was selected. Do something with the file...
} else {
    eprintln!("No file was selected")
}

Examples found in repository

examples/folder-save-dialog.rs (line 32)

fn main() {
    nvdialog_rs::init().expect("failed to initialize nvdialog");
    let mut folder_dialog = FileDialog::new("Choose a folder", FileDialogType::OpenFolder, None::<Vec<&str>>);
    let mut where_to_save = FileDialog::new("Save as...", FileDialogType::SaveFile, None::<Vec<&str>>);
    
    if let Some(p) = folder_dialog.retrieve_filename() {
        println!("You chose folder {}", p.display());
    }

    if let Some(s) = where_to_save.retrieve_filename() {
        println!("Saved as {}", s.display());
    }
}

examples/file-dialog.rs (line 45)

fn main() {
    nvdialog_rs::init().expect("Can't initialize NvDialog");
    let mut file_dialog = FileDialog::new(
        String::from("Select an image"),
        FileDialogType::OpenFile,
        Some(vec![
            "png".to_owned(),
            "jpg".to_owned(),
            "jpeg".to_owned(),
            "ico".to_owned(),
            "webp".to_owned(),
        ]),
    );

    if let Some(file) = file_dialog.retrieve_filename() {
        DialogBox::new("File chosen", &file.to_str().unwrap(), DialogType::Simple)
            .expect("Can't create dialog")
            .show()
    } else {
        DialogBox::new("Error", "No file chosen", DialogType::Error)
            .expect("Can't create dialog")
            .show()
    }
}