Struct egui_file_dialog::FileDialog

pub struct FileDialog { /* private fields */ }

Represents a file dialog instance.

The FileDialog instance can be used multiple times and for different actions.

Examples

use egui_file_dialog::FileDialog;

struct MyApp {
    file_dialog: FileDialog,
}

impl MyApp {
    fn update(&mut self, ctx: &egui::Context, ui: &mut egui::Ui) {
        if ui.button("Select a file").clicked() {
            self.file_dialog.select_file();
        }
         
        if let Some(path) = self.file_dialog.update(ctx).selected() {
            println!("Selected file: {:?}", path);
        }
    }
}

Implementations

impl FileDialog

pub fn new() -> Self

Creates a new file dialog instance with default values.

pub fn initial_directory(self, directory: PathBuf) -> Self

Sets the first loaded directory when the dialog opens. If the path is a file, the file’s parent directory is used. If the path then has no parent directory or cannot be loaded, the user will receive an error. However, the user directories and system disk allow the user to still select a file in the event of an error.

Relative and absolute paths are allowed, but absolute paths are recommended.

pub fn default_window_size(self, size: Vec2) -> Self

Sets the default size of the window.

pub fn default_file_name(self, name: &str) -> Self

Sets the default file name when opening the dialog in DialogMode::SaveFile mode.

pub fn open(&mut self, mode: DialogMode, show_files: bool) -> Result<()>

Opens the file dialog in the given mode with the given options. This function resets the file dialog and takes care for the variables that need to be set when opening the file dialog.

Returns the result of the operation to load the initial directory.

The show_files parameter will be ignored when the mode equals DialogMode::SelectFile.

pub fn select_directory(&mut self)

Shortcut function to open the file dialog to prompt the user to select a directory. If used, no files in the directories will be shown to the user. Use the open() method instead, if you still want to display files to the user. This function resets the file dialog. Configuration variables such as initial_directory are retained.

The function ignores the result of the initial directory loading operation.

pub fn select_file(&mut self)

Shortcut function to open the file dialog to prompt the user to select a file. This function resets the file dialog. Configuration variables such as initial_directory are retained.

The function ignores the result of the initial directory loading operation.

pub fn save_file(&mut self)

Shortcut function to open the file dialog to prompt the user to save a file. This function resets the file dialog. Configuration variables such as initial_directory are retained.

The function ignores the result of the initial directory loading operation.

pub fn mode(&self) -> DialogMode

Returns the mode the dialog is currently in.

pub fn state(&self) -> DialogState

Returns the state the dialog is currently in.

pub fn selected(&self) -> Option<&Path>

Returns the directory or file that the user selected, or the target file if the dialog is in DialogMode::SaveFile mode.

None is returned when the user has not yet selected an item.

pub fn update(&mut self, ctx: &Context) -> &Self

The main update method that should be called every frame if the dialog is to be visible.

This function has no effect if the dialog state is currently not DialogState::Open.

Trait Implementations

impl Default for FileDialog

fn default() -> Self

Creates a new file dialog instance with default values.