Struct OverlayHandle 

pub struct OverlayHandle { /* private fields */ }

Implementations

impl OverlayHandle

pub fn new() -> Self

pub fn show(&self, view: View) -> u64

pub fn show_with(&self, view: View, z_index: f32, pass_through: bool) -> u64

pub fn show_with_back( &self, view: View, z_index: f32, pass_through: bool, back_handler: BackHandler, ) -> u64

pub fn show_entry( &self, builder: Rc<dyn Fn() -> View>, z_index: f32, pass_through: bool, ) -> u64

pub fn show_entry_with_back( &self, builder: Rc<dyn Fn() -> View>, z_index: f32, pass_through: bool, back_handler: Option<BackHandler>, ) -> u64

pub fn show_guard( &self, builder: Rc<dyn Fn() -> View>, z_index: f32, pass_through: bool, ) -> OverlayGuard

Show builder and return a guard owning the entry. Dropping the guard dismisses the entry; see OverlayGuard.

pub fn show_guard_with_back( &self, builder: Rc<dyn Fn() -> View>, z_index: f32, pass_through: bool, back_handler: BackHandler, ) -> OverlayGuard

pub fn handle_back(&self) -> bool

pub fn entry_count(&self) -> usize

Number of live entries. Reads state directly rather than going through Self::host, which rebuilds every entry and so cannot be used to observe what is registered.

pub fn dismiss(&self, id: u64) -> bool

pub fn clear(&self)

pub fn host(&self, modifier: Modifier, content: View) -> View

Hoist content plus this handle’s entries under one root.

The runtime calls this implicitly around the app root each frame (see with_ambient_overlay); explicit host() calls remain for tests and advanced layering.

Trait Implementations

impl Clone for OverlayHandle

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for OverlayHandle

fn default() -> Self

Returns the “default value” for a type.