Skip to main content

OverlayPlacement

Enum OverlayPlacement 

Source
pub enum OverlayPlacement {
    Below,
    Above,
    TrailingEdge,
    AtPointer(Point),
    NearAnchor {
        offset: Vec2,
    },
    Centered,
    BottomCenter,
    BelowPreferred,
    ViewportCorner {
        corner: Corner,
        margin: Vec2,
    },
    FullViewport,
}
Expand description

How an overlay is positioned relative to its anchor.

Variants§

§

Below

Below the anchor, leading-edge aligned (dropdown).

§

Above

Above the anchor (fallback when no space below).

§

TrailingEdge

To the trailing side of the anchor (submenu).

§

AtPointer(Point)

At the pointer position (context menu).

§

NearAnchor

Near the anchor with a preferred alignment and offset (tooltip).

Fields

§offset: Vec2
§

Centered

Centered within the viewport (dialog).

§

BottomCenter

Bottom-centered within the viewport (snackbar/toast).

§

BelowPreferred

Below the anchor if space allows, otherwise above (combo box dropdown). The viewport height is supplied by position_overlays() at layout time.

§

ViewportCorner

Snaps content to a viewport corner with a per-axis margin (used by ToastHost for stacked toast notifications, also suitable for picture-in-picture, floating action overlays). Anchor bounds are ignored. The leading/trailing axis honours LayoutDirection: TopTrailing is top-right under LTR and top-left under RTL.

Fields

§corner: Corner
§margin: Vec2
§

FullViewport

Fills the entire viewport, anchor-independent. Used by the modal-presentation pipeline to mount a dialog scrim behind a centered modal panel — the scrim covers the full window so the content behind dims uniformly. Anchor bounds are ignored.

Trait Implementations§

Source§

impl Clone for OverlayPlacement

Source§

fn clone(&self) -> OverlayPlacement

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OverlayPlacement

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.