Enum OverlayBand 

pub enum OverlayBand {
    Floating,
    Tooltip,
}

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)
}

Which z-band a registered surface paints and hit-tests in.

Two bands, ordered Floating below Tooltip: a tooltip explaining a menu item must never be painted under the menu, and — because hit testing walks the bands in reverse — must never steal the pointer from it either (a tooltip is normally registered OverlayInput::Transparent anyway). Registration order breaks ties within a band; the band itself always wins.

Variants

Floating

Menus, popovers, dropdowns, selection toolbars — anything the user can interact with. Painted first, hit-tested last.

Tooltip

Tooltips and other explanatory chrome that must sit above everything else. Painted last, hit-tested first.

Trait Implementations

impl Clone for OverlayBand

fn clone(&self) -> OverlayBand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for OverlayBand

impl Debug for OverlayBand

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

Formats the value using the given formatter.

impl Eq for OverlayBand

impl Hash for OverlayBand

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 Ord for OverlayBand

fn cmp(&self, other: &OverlayBand) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for OverlayBand

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for OverlayBand

fn partial_cmp(&self, other: &OverlayBand) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for OverlayBand