Struct Modal

pub struct Modal { /* private fields */ }

A layer to present a widget in a modal session.

Designed to be used in a Layers widget.

Implementations

impl Modal

pub fn new() -> Self

Returns a new modal layer.

pub fn present(&self, contents: impl MakeWidget)

Presents contents as the modal session.

pub fn new_handle(&self) -> ModalHandle

Returns a new pending handle that can be used to show a modal and dismiss it.

pub fn message(&self, message: impl MakeWidget, button_caption: impl MakeWidget)

Presents a modal dialog containing message with a default button that dismisses the dialog.

pub fn build_dialog(&self, message: impl MakeWidget) -> DialogBuilder

Returns a builder for a modal dialog that displays message.

pub fn dismiss(&self)

Dismisses the modal session.

pub fn visible(&self) -> bool

Returns true if this layer is currently presenting a modal session.

pub fn dismiss_callback<T>(&self) -> impl FnMut(T) + Send + 'static

Returns a function that dismisses the modal when invoked.

The input to the function is ignored. This function takes a single argument so that it is compatible with widgets that use a Callback for their events.

Trait Implementations

impl Clone for Modal

fn clone(&self) -> Modal

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Modal

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

Formats the value using the given formatter.

impl Default for Modal

fn default() -> Modal

Returns the “default value” for a type.

impl MakeWidgetWithTag for Modal

fn make_with_tag(self, tag: WidgetTag) -> WidgetInstance

Returns a new WidgetInstance whose WidgetId comes from tag.

impl ModalTarget for Modal

fn new_handle(&self) -> ModalHandle

Returns a new handle that can be used to show a dialog above self.

fn layer(&self) -> &Modal

Returns a reference to the modal layer this target presents to.

impl PickFile for Modal

fn pick_file<Callback>(&self, picker: &FilePicker, callback: Callback)

where Callback: FnOnce(Option<PathBuf>) + Send + 'static,

Shows a picker that selects a single file and invokes on_dismiss when the dialog is dismissed.

fn save_file<Callback>(&self, picker: &FilePicker, callback: Callback)

where Callback: FnOnce(Option<PathBuf>) + Send + 'static,

Shows a picker that creates a new file and invokes on_dismiss when the dialog is dismissed.

fn pick_files<Callback>(&self, picker: &FilePicker, callback: Callback)

where Callback: FnOnce(Option<Vec<PathBuf>>) + Send + 'static,

Shows a picker that selects one or more files and invokes on_dismiss when the dialog is dismissed.

fn pick_folder<Callback>(&self, picker: &FilePicker, callback: Callback)

where Callback: FnOnce(Option<PathBuf>) + Send + 'static,

Shows a picker that selects a single folder/directory and invokes on_dismiss when the dialog is dismissed.

fn pick_folders<Callback>(&self, picker: &FilePicker, callback: Callback)

where Callback: FnOnce(Option<Vec<PathBuf>>) + Send + 'static,

Shows a picker that selects one or more folders/directorys and invokes on_dismiss when the dialog is dismissed.