Struct FileDialog

pub struct FileDialog { /* private fields */ }

egui component that represents OpenFileDialog or SaveFileDialog.

Implementations

impl FileDialog

pub fn select_folder(initial_path: Option<PathBuf>) -> Self

Create dialog that prompts the user to select a folder.

pub fn open_file(initial_path: Option<PathBuf>) -> Self

Create dialog that prompts the user to open a file.

pub fn save_file(initial_path: Option<PathBuf>) -> Self

Create dialog that prompts the user to save a file.

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

Set the default file name.

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

Set the window title text.

pub fn open_button_text(self, text: Cow<'static, str>) -> Self

Set the open button text.

pub fn save_button_text(self, text: Cow<'static, str>) -> Self

Set the save button text.

pub fn cancel_button_text(self, text: Cow<'static, str>) -> Self

Set the cancel button text.

pub fn new_folder_button_text(self, text: Cow<'static, str>) -> Self

Set the new folder button text.

pub fn new_folder_name_text(self, text: Cow<'static, str>) -> Self

Set the new folder name text.

pub fn refresh_button_hover_text(self, text: Cow<'static, str>) -> Self

Set the refresh button hover text.

pub fn parent_folder_button_hover_text(self, text: Cow<'static, str>) -> Self

Set the parent folder button hover text.

pub fn rename_button_text(self, text: Cow<'static, str>) -> Self

Set the rename button text.

pub fn file_label_text(self, text: Cow<'static, str>) -> Self

Set the file label text.

pub fn show_hidden_checkbox_text(self, text: Cow<'static, str>) -> Self

Set the show hidden checkbox text.

pub fn id(self, id: impl Into<Id>) -> Self

Set the window ID.

pub fn anchor(self, align: Align2, offset: impl Into<Vec2>) -> Self

Set the window anchor.

pub fn current_pos(self, current_pos: impl Into<Pos2>) -> Self

Set the window’s current position.

pub fn default_pos(self, default_pos: impl Into<Pos2>) -> Self

Set the window’s default position.

pub fn default_size(self, default_size: impl Into<Vec2>) -> Self

Set the window’s default size.

pub fn resizable(self, resizable: bool) -> Self

Enable/disable resizing the window. Default is true.

pub fn show_rename(self, rename: bool) -> Self

Show the Rename button. Default is true.

pub fn show_new_folder(self, new_folder: bool) -> Self

Show the New Folder button. Default is true.

pub fn multi_select(self, multi_select: bool) -> Self

pub fn has_multi_select(&self) -> bool

pub fn show_files_filter(self, filter: Filter<PathBuf>) -> Self

Set a function to filter listed files.

pub fn filename_filter(self, filter: Filter<String>) -> Self

Set a function to filter the selected filename.

pub fn keep_on_top(self, keep_on_top: bool) -> Self

Set to true in order to keep this window on top of other windows. Default is false.

pub fn with_fs(self, fs: Box<dyn Vfs>) -> Self

pub fn show_system_files(self, show_system_files: bool) -> Self

Set to true in order to show system files. Default is false.

pub fn dialog_type(&self) -> DialogType

Get the dialog type.

pub fn visible(&self) -> bool

Get the window’s visibility.

pub fn open(&mut self)

Opens the dialog.

pub fn path(&self) -> Option<&Path>

Resulting file path.

pub fn selection(&self) -> Vec<&Path>

Retrieves multi selection as a vector.

pub fn directory(&self) -> &Path

Currently mounted directory that is being shown in the dialog box

pub fn set_path(&mut self, path: impl Into<PathBuf>)

Set the dialog’s current opened path

pub fn state(&self) -> State

Dialog state.

pub fn selected(&self) -> bool

Returns true, if the file selection was confirmed.

pub fn show(&mut self, ctx: &Context) -> &Self

Shows the dialog if it is open. It is also responsible for state management. Should be called every ui update.

Trait Implementations

impl Debug for FileDialog

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

Formats the value using the given formatter.