FileDialog

Struct FileDialog 

Source
pub struct FileDialog { /* private fields */ }
Expand description

§Synchronous File Dialog

§Supported Platforms:
  • Linux
  • Windows
  • Mac

Implementations§

Source§

impl FileDialog

Source

pub fn new() -> Self

New file dialog builder

Source

pub fn add_filter(self, name: &str, extensions: &[&str]) -> Self

Add file extension filter.

Takes in the name of the filter, and list of extensions

§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

Source

pub fn set_directory<P: AsRef<Path>>(self, path: P) -> Self

Set starting directory of the dialog.

§Supported Platforms:
  • Linux
  • Windows
  • Mac
Source

pub fn set_file_name(self, file_name: &str) -> Self

Set starting file name of the dialog.

§Supported Platforms:
  • Windows
  • Linux
  • Mac
Source

pub fn set_parent<W: HasRawWindowHandle>(self, parent: &W) -> Self

Set parent windows explicitly (optional) Suported in: macos and windows

Source§

impl FileDialog

Source

pub fn pick_file(self) -> Option<PathBuf>

Pick one file

Source

pub fn pick_files(self) -> Option<Vec<PathBuf>>

Pick multiple files

Source

pub fn pick_folder(self) -> Option<PathBuf>

Pick one folder

Source

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

Source§

fn clone(&self) -> FileDialog

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for FileDialog

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for FileDialog

Source§

fn default() -> FileDialog

Returns the “default value” for a type. Read more
Source§

impl Send for FileDialog

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.