search

fluxxcode / egui-file-dialog

Full featured and customizable file dialog for egui
MIT License
88 stars 14 forks source link

Come up with clear and consistent naming for "currently selected" vs "confirmed picked" items #171

Open crumblingstatue opened 4 weeks ago

crumblingstatue commented 4 weeks ago

170 Adds methods to get the currently selected directory entries, but the naming of the methods is not ideal, and might be a source of confusion for users.

File dialogs are often referred to as file pickers, so perhaps what is right now referred to as "selection" (select_file, selected, take_selected, ...) could be renamed to pick_file, picked, take_picked, etc. The word "pick" implies that the user has already made up their mind, as opposed to just select, which can be an action during the picking process (selecting multiple files to pick, etc.).

There might be other good candidates as well. But after careful consideration, we should pick a consistent naming scheme, and then review all the relevant API items and rename everything where appropriate. This will be a breaking change of course, so it should be done sooner rather than later.

fluxxcode commented 3 weeks ago

I completely agree. I'm currently wondering whether it would be better to put this into a separate release without any further changes. I think I'll change it with v0.9.0.