Enum OutsideTap 

pub enum OutsideTap {
    Ignore,
    Notify {
        consume: bool,
    },
}

The overlay portal’s own vocabulary, flat-re-exported from frust-core: which z-band a floated surface sits in, whether the pointer reaches it, and what a press landing outside it delivers.

overlay_portal floats a surface above the whole app, anchored to its child’s bounds and painted after the entire main tree — so it escapes both the child’s paint order and every ancestor’s clip, and follows the child across scroll and relayout with nothing subscribed. The surface is mounted while OverlayPortalView::overlay is Some; a widget that hosts a surface of its own instead reaches for authoring::OverlaySlot.

Lifted flat for EditCommand’s reason: an app or design system naming a band, an input class or a light-dismiss policy is configuring a portal, not authoring a widget.

use frust::{
    OverlayBand, OverlayInput, OverlayPlacement, OverlaySide, View, any, overlay_portal, text,
};

struct App {
    hovering: bool,
}

// A tooltip: above its trigger, in the topmost band, and transparent to the
// pointer so hovering the trigger is never interrupted by its own tip.
fn trigger(state: &mut App) -> impl View<App> + use<> {
    overlay_portal(text("Save"))
        .overlay(state.hovering.then(|| any(text("Save the document"))))
        .placement(OverlayPlacement::on(OverlaySide::Top))
        .band(OverlayBand::Tooltip)
        .input(OverlayInput::Transparent)
}

What a registered surface wants to hear about a press that landed on nothing floated — the light-dismiss policy, a per-surface boolean everywhere this pattern exists.

Variants

Ignore

Say nothing. A surface that dismisses some other way (a menu closed by its own item, a toolbar that follows a selection) wants this.

Notify

Deliver OverlayEventKind::OutsideDown to the owner on a primary press outside every registered rect.

Fields

consume: bool

Whether the press is consumed by the notification.

true is the modal light-dismiss shape: the press closes the surface and the main tree never sees it, so the tap that dismisses a menu does not also activate the button under it. false is the pass-through shape: the owner is told, and the press continues into the main tree as usual.

Trait Implementations

impl Clone for OutsideTap

fn clone(&self) -> OutsideTap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for OutsideTap

impl Debug for OutsideTap

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

Formats the value using the given formatter.

impl Eq for OutsideTap

impl Hash for OutsideTap

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for OutsideTap

fn eq(&self, other: &OutsideTap) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for OutsideTap