pub struct FileDialog { /* private fields */ }
Expand description
Synchronous File Dialog. Supported platforms:
- Linux
- Windows
- Mac
Implementations§
Source§impl FileDialog
impl FileDialog
Sourcepub fn add_filter(
self,
name: impl Into<String>,
extensions: &[impl ToString],
) -> Self
pub fn add_filter( self, name: impl Into<String>, extensions: &[impl ToString], ) -> Self
Add file extension filter.
Takes in the name of the filter, and list of extensions
The name of the filter will be displayed on supported platforms:
- Windows
- Linux
On platforms that don’t support filter names, all filters will be merged into one filter
Sourcepub fn set_directory<P: AsRef<Path>>(self, path: P) -> Self
pub fn set_directory<P: AsRef<Path>>(self, path: P) -> Self
Set starting directory of the dialog. Supported platforms:
- Linux (GTK only)
- Windows
- Mac
Sourcepub fn set_file_name(self, file_name: impl Into<String>) -> Self
pub fn set_file_name(self, file_name: impl Into<String>) -> Self
Set starting file name of the dialog. Supported platforms:
- Windows
- Linux
- Mac
Sourcepub fn set_title(self, title: impl Into<String>) -> Self
pub fn set_title(self, title: impl Into<String>) -> Self
Set the title of the dialog. Supported platforms:
- Windows
- Linux
- Mac
Sourcepub fn set_parent<W: HasWindowHandle + HasDisplayHandle>(
self,
parent: &W,
) -> Self
pub fn set_parent<W: HasWindowHandle + HasDisplayHandle>( self, parent: &W, ) -> Self
Set parent windows explicitly (optional). Supported platforms:
- Windows
- Mac
- Linux (XDG only)
Sourcepub fn set_can_create_directories(self, can: bool) -> Self
pub fn set_can_create_directories(self, can: bool) -> Self
Set can create directories in the dialog.
Suported in: macos
.
Source§impl FileDialog
impl FileDialog
Sourcepub fn pick_files(self) -> Option<Vec<PathBuf>>
pub fn pick_files(self) -> Option<Vec<PathBuf>>
Pick multiple files
Sourcepub fn pick_folder(self) -> Option<PathBuf>
pub fn pick_folder(self) -> Option<PathBuf>
Pick one folder
Sourcepub fn pick_folders(self) -> Option<Vec<PathBuf>>
pub fn pick_folders(self) -> Option<Vec<PathBuf>>
Pick multiple folders
Sourcepub fn save_file(self) -> Option<PathBuf>
pub fn save_file(self) -> Option<PathBuf>
Opens save file dialog
§Platform specific notes regarding save dialog filters:
- On macOS
- If filter is set, all files will be grayed out (no matter the extension sadly)
- If user does not type an extension MacOs will append first available extension from filters list
- If user types in filename with extension MacOs will check if it exists in filters list, if not it will display appropriate message
- On GTK
- It only filters which already existing files get shown to the user
- It does not append extensions automatically
- It does not prevent users from adding any unsupported extension
- On Win:
- If no extension was provided it will just add currently selected one
- If selected extension was typed in by the user it will just return
- If unselected extension was provided it will append selected one at the end, example:
test.png.txt
Trait Implementations§
Source§impl Clone for FileDialog
impl Clone for FileDialog
Source§fn clone(&self) -> FileDialog
fn clone(&self) -> FileDialog
Returns a copy of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moreSource§impl Debug for FileDialog
impl Debug for FileDialog
Source§impl Default for FileDialog
impl Default for FileDialog
Source§fn default() -> FileDialog
fn default() -> FileDialog
Returns the “default value” for a type. Read more
impl Send for FileDialog
impl Sync for FileDialog
Auto Trait Implementations§
impl Freeze for FileDialog
impl RefUnwindSafe for FileDialog
impl Unpin for FileDialog
impl UnwindSafe for FileDialog
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more