pub struct OverlayHost { /* private fields */ }Expand description
Window-level modal stack + toast queue. Create with
cx.new(OverlayHost::new) and render it as the last child of the root.
Implementations§
Source§impl OverlayHost
impl OverlayHost
pub fn new(cx: &mut Context<'_, Self>) -> Self
Sourcepub fn toast_stack(&self) -> Entity<ToastStack>
pub fn toast_stack(&self) -> Entity<ToastStack>
The inner ToastStack, for duration/clear/remove control.
Sourcepub fn toast(
&mut self,
message: impl Into<SharedString>,
cx: &mut Context<'_, Self>,
)
pub fn toast( &mut self, message: impl Into<SharedString>, cx: &mut Context<'_, Self>, )
Push a plain toast.
Sourcepub fn toast_titled(
&mut self,
title: impl Into<SharedString>,
message: impl Into<SharedString>,
color: ColorName,
cx: &mut Context<'_, Self>,
)
pub fn toast_titled( &mut self, title: impl Into<SharedString>, message: impl Into<SharedString>, color: ColorName, cx: &mut Context<'_, Self>, )
Push a titled, colored toast.
Sourcepub fn open_modal<E>(
&mut self,
window: &mut Window,
cx: &mut Context<'_, Self>,
builder: impl Fn(ModalCloser, &mut Window, &mut App) -> E + 'static,
) -> usizewhere
E: IntoElement,
pub fn open_modal<E>(
&mut self,
window: &mut Window,
cx: &mut Context<'_, Self>,
builder: impl Fn(ModalCloser, &mut Window, &mut App) -> E + 'static,
) -> usizewhere
E: IntoElement,
Open a modal above everything (stacked above any already open). The
builder is re-invoked every frame (live content) and receives a
ModalCloser to wire to its close affordances. Returns the modal’s
id for close_modal.
Whatever was focused when the modal opened is refocused when it closes; Escape (with focus anywhere inside the modal) closes it.
Sourcepub fn close_modal(
&mut self,
id: usize,
window: &mut Window,
cx: &mut Context<'_, Self>,
)
pub fn close_modal( &mut self, id: usize, window: &mut Window, cx: &mut Context<'_, Self>, )
Close a modal by id, restoring the focus it captured on open.
Sourcepub fn close_top(&mut self, window: &mut Window, cx: &mut Context<'_, Self>)
pub fn close_top(&mut self, window: &mut Window, cx: &mut Context<'_, Self>)
Close the top-most modal, if any.
pub fn modal_count(&self) -> usize
Trait Implementations§
Source§impl Render for OverlayHost
impl Render for OverlayHost
Auto Trait Implementations§
impl !RefUnwindSafe for OverlayHost
impl !Send for OverlayHost
impl !Sync for OverlayHost
impl !UnwindSafe for OverlayHost
impl Freeze for OverlayHost
impl Unpin for OverlayHost
impl UnsafeUnpin for OverlayHost
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Convert
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more