feat!: opening mode

CHANGELOG.md

@@ -8,12 +8,17 @@
 - Renamed `DialogState`'s: `Selected` -> `Picked`, `SelectedMultiple` -> `PickedMultiple` [#229](https://github.com/fluxxcode/egui-file-dialog/pull/229)
 - Renamed `active_entry` -> `selected_entry` [#229](https://github.com/fluxxcode/egui-file-dialog/pull/229)
 - Renamed `active_selected_entries` -> `selected_entries` [#229](https://github.com/fluxxcode/egui-file-dialog/pull/229)
-- Added `file_system` attribute to `FileDialogConfig` [#227](https://github.com/fluxxcode/egui-file-dialog/pull/227)
+
+#### Breaking changes due to new features and updated configuration
+- Added `file_system` to `FileDialogConfig` [#227](https://github.com/fluxxcode/egui-file-dialog/pull/227)
 - Added `file_system` parameter to `DirectoryEntry::from_path` [#227](https://github.com/fluxxcode/egui-file-dialog/pull/227)
+- Added `opening_mode` to `FileDialogConfig` [#239](https://github.com/fluxxcode/egui-file-dialog/pull/239)
+- Added `last_visited_dir` and `last_picked_dir` to `FileDialogStorage` [#239](https://github.com/fluxxcode/egui-file-dialog/pull/239)
 
 ### ✨ Features
 
 - Implement file system abstraction so that the file dialog can be used with virtual file systems [#227](https://github.com/fluxxcode/egui-file-dialog/pull/227) (thanks [@Masterchef365](https://github.com/Masterchef365)!)
+- Added new configuration option `FileDialog::opening_mode` which allows to further specify which directory is loaded when the file dialog is opened [#239](https://github.com/fluxxcode/egui-file-dialog/pull/239)
 
 ### 🐛 Bug Fixes
 

src/config/mod.rs

@@ -20,6 +20,10 @@ pub struct FileDialogStorage {
     pub show_hidden: bool,
     /// If system files should be listed inside the directory view.
     pub show_system_files: bool,
+    /// The last directory the user visited.
+    pub last_visited_dir: Option<PathBuf>,
+    /// The last directory from which the user picked an item.
+    pub last_picked_dir: Option<PathBuf>,
 }
 
 impl Default for FileDialogStorage {
@@ -29,10 +33,24 @@ impl Default for FileDialogStorage {
             pinned_folders: Vec::new(),
             show_hidden: false,
             show_system_files: false,
+            last_visited_dir: None,
+            last_picked_dir: None,
         }
     }
 }
 
+/// Sets which directory is loaded when opening the file dialog.
+#[derive(Debug, PartialEq, Eq, Clone)]
+pub enum OpeningMode {
+    /// The configured initial directory (`FileDialog::initial_directory`) should always be opened.
+    AlwaysInitialDir,
+    /// The directory most recently visited by the user should be opened regardless of
+    /// whether anything was picked.
+    LastVisitedDir,
+    /// The last directory from which the user picked an item should be opened.
+    LastPickedDir,
+}
+
 /// Contains configuration values of a file dialog.
 ///
 /// The configuration of a file dialog can be set using `FileDialog::with_config`.
@@ -77,6 +95,8 @@ pub struct FileDialogConfig {
 
     // ------------------------------------------------------------------------
     // General options:
+    /// Sets which directory is loaded when opening the file dialog.
+    pub opening_mode: OpeningMode,
     /// If the file dialog should be visible as a modal window.
     /// This means that the input outside the window is not registered.
     pub as_modal: bool,
@@ -222,6 +242,7 @@ impl FileDialogConfig {
             labels: FileDialogLabels::default(),
             keybindings: FileDialogKeyBindings::default(),
 
+            opening_mode: OpeningMode::LastPickedDir,
             as_modal: true,
             modal_overlay_color: egui::Color32::from_rgba_premultiplied(0, 0, 0, 120),
             initial_directory: file_system.current_dir().unwrap_or_default(),

src/file_dialog.rs

@@ -1,6 +1,6 @@
 use crate::config::{
     FileDialogConfig, FileDialogKeyBindings, FileDialogLabels, FileDialogStorage, FileFilter,
-    Filter, QuickAccess,
+    Filter, OpeningMode, QuickAccess,
 };
 use crate::create_directory_dialog::CreateDirectoryDialog;
 use crate::data::{
@@ -347,7 +347,7 @@ impl FileDialog {
             .id
             .map_or_else(|| egui::Id::new(self.get_window_title()), |id| id);
 
-        self.load_directory(&self.gen_initial_directory(&self.config.initial_directory));
+        self.load_directory(&self.get_initial_directory());
 
         // TODO: Dont return a result from this method
         Ok(())
@@ -484,6 +484,12 @@ impl FileDialog {
         &mut self.config.labels
     }
 
+    /// Sets which directory is loaded when opening the file dialog.
+    pub const fn opening_mode(mut self, opening_mode: OpeningMode) -> Self {
+        self.config.opening_mode = opening_mode;
+        self
+    }
+
     /// If the file dialog window should be displayed as a modal.
     ///
     /// If the window is displayed as modal, the area outside the dialog can no longer be
@@ -2752,6 +2758,8 @@ impl FileDialog {
             return;
         }
 
+        self.config.storage.last_picked_dir = self.current_directory().map(PathBuf::from);
+
         match &self.mode {
             DialogMode::PickDirectory | DialogMode::PickFile => {
                 // Should always contain a value since `is_selection_valid` is used to
@@ -2798,9 +2806,26 @@ impl FileDialog {
 
     /// This function generates the initial directory based on the configuration.
     /// The function does the following things:
+    ///   - Get the path to open based on the opening mode
     ///   - Canonicalize the path if enabled
     ///   - Attempts to use the parent directory if the path is a file
-    fn gen_initial_directory(&self, path: &Path) -> PathBuf {
+    fn get_initial_directory(&self) -> PathBuf {
+        let path = match self.config.opening_mode {
+            OpeningMode::AlwaysInitialDir => &self.config.initial_directory,
+            OpeningMode::LastVisitedDir => self
+                .config
+                .storage
+                .last_visited_dir
+                .as_deref()
+                .unwrap_or(&self.config.initial_directory),
+            OpeningMode::LastPickedDir => self
+                .config
+                .storage
+                .last_picked_dir
+                .as_deref()
+                .unwrap_or(&self.config.initial_directory),
+        };
+
         let mut path = self.canonicalize_path(path);
 
         if self.config.file_system.is_file(&path) {
@@ -3117,6 +3142,8 @@ impl FileDialog {
 
     /// Loads the directory content of the given path.
     fn load_directory_content(&mut self, path: &Path) {
+        self.config.storage.last_visited_dir = Some(path.to_path_buf());
+
         self.directory_content = DirectoryContent::from_path(
             &self.config,
             path,

src/lib.rs

@@ -205,7 +205,7 @@ mod modals;
 
 pub use config::{
     FileDialogConfig, FileDialogKeyBindings, FileDialogLabels, FileDialogStorage, IconFilter,
-    KeyBinding, QuickAccess, QuickAccessPath,
+    KeyBinding, OpeningMode, QuickAccess, QuickAccessPath,
 };
 pub use data::{DirectoryEntry, Disk, Disks, Metadata, UserDirectories};
 pub use file_dialog::{DialogMode, DialogState, FileDialog};