Struct floem::file::FileDialogOptions

pub struct FileDialogOptions { /* private fields */ }

Implementations

impl FileDialogOptions

pub fn new() -> FileDialogOptions

Create a new set of options.

pub fn show_hidden(self) -> Self

Set hidden files and directories to be visible.

pub fn select_directories(self) -> Self

Set directories to be selectable instead of files.

This is only relevant for open dialogs.

pub fn packages_as_directories(self) -> Self

Set packages to be treated as directories instead of files.

This allows for writing more universal cross-platform code at the cost of user experience.

This is only relevant on macOS.

pub fn multi_selection(self) -> Self

Set multiple items to be selectable.

This is only relevant for open dialogs.

pub fn allowed_types(self, types: Vec<FileSpec>) -> Self

Set the file types the user is allowed to select.

This filter is only applied to files and packages, but not to directories.

An empty collection is treated as no filter.

macOS

These file types also apply to directories to define packages. Which means the directories that match the filter are no longer considered directories. The packages are defined by this collection even in directories mode.

pub fn default_type(self, default_type: FileSpec) -> Self

Set the default file type.

The provided default_type must also be present in allowed_types.

If it’s None then the first entry in allowed_types will be used as the default.

This is only relevant in files mode.

pub fn default_name(self, default_name: impl Into<String>) -> Self

Set the default filename that appears in the dialog.

pub fn name_label(self, name_label: impl Into<String>) -> Self

Set the text in the label next to the filename editbox.

pub fn title(self, title: impl Into<String>) -> Self

Set the title text of the dialog.

pub fn button_text(self, text: impl Into<String>) -> Self

Set the text of the Open/Save button.

pub fn force_starting_directory(self, path: impl Into<PathBuf>) -> Self

Force the starting directory to the specified path.

User experience

This should almost never be used because it overrides the OS choice, which will usually be a directory that the user recently visited.

Trait Implementations

impl Clone for FileDialogOptions

fn clone(&self) -> FileDialogOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileDialogOptions

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

Formats the value using the given formatter.

impl Default for FileDialogOptions

fn default() -> FileDialogOptions

Returns the “default value” for a type.