Struct ModalHandler 

pub struct ModalHandler<T = ()> { /* private fields */ }

Manages modal open/close state

Implementations

impl<T> ModalHandler<T>

pub fn new(id: impl Hash + Debug) -> Self

Create a new modal handler with the given ID

pub fn id(&self) -> Id

Get the modal ID

pub fn open(&mut self)

Open the modal without a payload

pub fn open_with(&mut self, payload: T)

Open the modal with a payload

pub fn close(&mut self)

Close the modal and clear the payload

pub fn is_open(&self) -> bool

Check if the modal is open

pub fn payload(&self) -> Option<&T>

Get a reference to the payload

pub fn payload_mut(&mut self) -> Option<&mut T>

Get a mutable reference to the payload

pub fn take_payload(&mut self) -> Option<T>

Take the payload out of the handler

pub fn show<R>( &mut self, ctx: &Context, add_contents: impl FnOnce(&mut Ui, Option<&T>) -> R, ) -> Option<R>

Show the modal if open

The content is drawn in the dialog frame, centred above a dimmed backdrop. Escape or a click on the backdrop closes the modal.

Returns the result of the content function if the modal was shown.

pub fn show_mut<R>( &mut self, ctx: &Context, add_contents: impl FnOnce(&mut Ui, Option<&mut T>) -> R, ) -> Option<R>

Show the modal with mutable payload access

impl ModalHandler<()>

pub fn show_simple<R>( &mut self, ctx: &Context, add_contents: impl FnOnce(&mut Ui) -> R, ) -> Option<R>

Show the modal if open (simplified for no payload)

Trait Implementations

impl<T> Default for ModalHandler<T>

fn default() -> Self

Returns the “default value” for a type.