Struct FileDialogBuilder

pub struct FileDialogBuilder {
    pub filename: Option<String>,
    pub location: Option<PathBuf>,
    pub filters: Vec<Filter>,
    pub owner: UnsafeWindowHandle,
    pub title: Option<String>,
}

Builder for file dialogs.

Fields

filename: Option<String>

location: Option<PathBuf>

filters: Vec<Filter>

owner: UnsafeWindowHandle

title: Option<String>

Implementations

impl FileDialogBuilder

pub fn set_title(self, title: impl ToString) -> Self

Sets the window title for the dialog.

pub fn set_filename(self, filename: impl ToString) -> Self

Sets the default value of the filename text field in the dialog. For open dialogs of macOS and zenity, this is a no-op because there’s no such text field on the dialog.

pub fn reset_filename(self) -> Self

Resets the default value of the filename field in the dialog.

pub fn set_location<P: AsRef<Path> + ?Sized>(self, path: &P) -> Self

Sets the default directory that the dialog shows at open.

Examples found in repository

examples/tour.rs (line 26)

fn main() {
    let result = DialogBuilder::message()
        .set_title("Tour")
        .set_text("Do you want to begin the tour?")
        .set_level(MessageLevel::Warning)
        .confirm()
        .show()
        .unwrap();
    if !result {
        return;
    }
    echo("show_confirm", &result);

    let result = DialogBuilder::file()
        .set_location("~")
        .open_single_file()
        .show()
        .unwrap();
    echo("show_open_single_file", &result);

    let result = DialogBuilder::file()
        .add_filter("Rust Source", &["rs"])
        .add_filter("Image", &["png", "jpg", "gif"])
        .open_multiple_file()
        .show()
        .unwrap();
    echo("show_open_multiple_file", &result);

    let result = DialogBuilder::file().open_single_dir().show().unwrap();
    echo("show_open_single_dir", &result);

    let result = DialogBuilder::file()
        .add_filter("Rust Source", &["rs"])
        .add_filter("Image", &["png", "jpg", "gif"])
        .save_single_file()
        .show()
        .unwrap();
    echo("show_save_single_file", &result);

    DialogBuilder::message()
        .set_title("End")
        .set_text("That's the end!")
        .alert()
        .show()
        .unwrap();
}

pub fn reset_location(self) -> Self

Resets the default directory that the dialog shows at open. If a location is not set, the dialog will probably go to the current working directory.

pub fn add_filter( self, description: impl ToString, extensions: &[impl ToString], ) -> Self

Adds a file type filter. The filter must contains at least one extension, otherwise this method will be a no-op. For dialogs that open directories, this is also a no-op.

Examples found in repository

examples/tour.rs (line 33)

fn main() {
    let result = DialogBuilder::message()
        .set_title("Tour")
        .set_text("Do you want to begin the tour?")
        .set_level(MessageLevel::Warning)
        .confirm()
        .show()
        .unwrap();
    if !result {
        return;
    }
    echo("show_confirm", &result);

    let result = DialogBuilder::file()
        .set_location("~")
        .open_single_file()
        .show()
        .unwrap();
    echo("show_open_single_file", &result);

    let result = DialogBuilder::file()
        .add_filter("Rust Source", &["rs"])
        .add_filter("Image", &["png", "jpg", "gif"])
        .open_multiple_file()
        .show()
        .unwrap();
    echo("show_open_multiple_file", &result);

    let result = DialogBuilder::file().open_single_dir().show().unwrap();
    echo("show_open_single_dir", &result);

    let result = DialogBuilder::file()
        .add_filter("Rust Source", &["rs"])
        .add_filter("Image", &["png", "jpg", "gif"])
        .save_single_file()
        .show()
        .unwrap();
    echo("show_save_single_file", &result);

    DialogBuilder::message()
        .set_title("End")
        .set_text("That's the end!")
        .alert()
        .show()
        .unwrap();
}

pub fn reset_filters(self) -> Self

Removes all file type filters.

pub fn set_owner<W: HasWindowHandle>(self, window: &W) -> Self

Sets the owner of the dialog.

pub fn reset_owner(self) -> Self

Resets the owner of the dialog to nothing.

pub fn open_single_file(self) -> OpenSingleFile

Builds a dialog that let users to open one file.

Examples found in repository

examples/tour.rs (line 27)

fn main() {
    let result = DialogBuilder::message()
        .set_title("Tour")
        .set_text("Do you want to begin the tour?")
        .set_level(MessageLevel::Warning)
        .confirm()
        .show()
        .unwrap();
    if !result {
        return;
    }
    echo("show_confirm", &result);

    let result = DialogBuilder::file()
        .set_location("~")
        .open_single_file()
        .show()
        .unwrap();
    echo("show_open_single_file", &result);

    let result = DialogBuilder::file()
        .add_filter("Rust Source", &["rs"])
        .add_filter("Image", &["png", "jpg", "gif"])
        .open_multiple_file()
        .show()
        .unwrap();
    echo("show_open_multiple_file", &result);

    let result = DialogBuilder::file().open_single_dir().show().unwrap();
    echo("show_open_single_dir", &result);

    let result = DialogBuilder::file()
        .add_filter("Rust Source", &["rs"])
        .add_filter("Image", &["png", "jpg", "gif"])
        .save_single_file()
        .show()
        .unwrap();
    echo("show_save_single_file", &result);

    DialogBuilder::message()
        .set_title("End")
        .set_text("That's the end!")
        .alert()
        .show()
        .unwrap();
}

pub fn open_multiple_file(self) -> OpenMultipleFile

Builds a dialog that let users to open multiple files.

Examples found in repository

examples/tour.rs (line 35)

fn main() {
    let result = DialogBuilder::message()
        .set_title("Tour")
        .set_text("Do you want to begin the tour?")
        .set_level(MessageLevel::Warning)
        .confirm()
        .show()
        .unwrap();
    if !result {
        return;
    }
    echo("show_confirm", &result);

    let result = DialogBuilder::file()
        .set_location("~")
        .open_single_file()
        .show()
        .unwrap();
    echo("show_open_single_file", &result);

    let result = DialogBuilder::file()
        .add_filter("Rust Source", &["rs"])
        .add_filter("Image", &["png", "jpg", "gif"])
        .open_multiple_file()
        .show()
        .unwrap();
    echo("show_open_multiple_file", &result);

    let result = DialogBuilder::file().open_single_dir().show().unwrap();
    echo("show_open_single_dir", &result);

    let result = DialogBuilder::file()
        .add_filter("Rust Source", &["rs"])
        .add_filter("Image", &["png", "jpg", "gif"])
        .save_single_file()
        .show()
        .unwrap();
    echo("show_save_single_file", &result);

    DialogBuilder::message()
        .set_title("End")
        .set_text("That's the end!")
        .alert()
        .show()
        .unwrap();
}

pub fn open_single_dir(self) -> OpenSingleDir

Builds a dialog that let users to open one directory.

Examples found in repository

examples/tour.rs (line 40)

fn main() {
    let result = DialogBuilder::message()
        .set_title("Tour")
        .set_text("Do you want to begin the tour?")
        .set_level(MessageLevel::Warning)
        .confirm()
        .show()
        .unwrap();
    if !result {
        return;
    }
    echo("show_confirm", &result);

    let result = DialogBuilder::file()
        .set_location("~")
        .open_single_file()
        .show()
        .unwrap();
    echo("show_open_single_file", &result);

    let result = DialogBuilder::file()
        .add_filter("Rust Source", &["rs"])
        .add_filter("Image", &["png", "jpg", "gif"])
        .open_multiple_file()
        .show()
        .unwrap();
    echo("show_open_multiple_file", &result);

    let result = DialogBuilder::file().open_single_dir().show().unwrap();
    echo("show_open_single_dir", &result);

    let result = DialogBuilder::file()
        .add_filter("Rust Source", &["rs"])
        .add_filter("Image", &["png", "jpg", "gif"])
        .save_single_file()
        .show()
        .unwrap();
    echo("show_save_single_file", &result);

    DialogBuilder::message()
        .set_title("End")
        .set_text("That's the end!")
        .alert()
        .show()
        .unwrap();
}

pub fn save_single_file(self) -> SaveSingleFile

Builds a dialog that let users to save one file.

Examples found in repository

examples/tour.rs (line 46)

fn main() {
    let result = DialogBuilder::message()
        .set_title("Tour")
        .set_text("Do you want to begin the tour?")
        .set_level(MessageLevel::Warning)
        .confirm()
        .show()
        .unwrap();
    if !result {
        return;
    }
    echo("show_confirm", &result);

    let result = DialogBuilder::file()
        .set_location("~")
        .open_single_file()
        .show()
        .unwrap();
    echo("show_open_single_file", &result);

    let result = DialogBuilder::file()
        .add_filter("Rust Source", &["rs"])
        .add_filter("Image", &["png", "jpg", "gif"])
        .open_multiple_file()
        .show()
        .unwrap();
    echo("show_open_multiple_file", &result);

    let result = DialogBuilder::file().open_single_dir().show().unwrap();
    echo("show_open_single_dir", &result);

    let result = DialogBuilder::file()
        .add_filter("Rust Source", &["rs"])
        .add_filter("Image", &["png", "jpg", "gif"])
        .save_single_file()
        .show()
        .unwrap();
    echo("show_save_single_file", &result);

    DialogBuilder::message()
        .set_title("End")
        .set_text("That's the end!")
        .alert()
        .show()
        .unwrap();
}

Trait Implementations

impl Clone for FileDialogBuilder

fn clone(&self) -> FileDialogBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileDialogBuilder

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

Formats the value using the given formatter.

impl Default for FileDialogBuilder

fn default() -> FileDialogBuilder

Returns the “default value” for a type.