Skip to main content

ModalScope

Struct ModalScope 

Source
pub struct ModalScope { /* private fields */ }
Expand description

A Dialog or a Sheet and its builder: open seeds the Renderer’s own open state, and on_dismiss says once that the user asked to close it.

Implementations§

Source§

impl ModalScope

Source

pub fn on_dismiss(self, handler: impl FnMut() + 'static) -> Self

Source

pub fn scrim(self, paint: impl Into<Paint>) -> Self

Sets the modal scrim colour, overriding the design system default.

Source

pub fn max_height_fraction(self, fraction: f32) -> Self

The tallest the sheet grows, as a fraction of the window’s height, above 0 and at most 1.

Below it the sheet is as tall as its content; content taller than that stops the sheet at the fraction and scrolls inside it. A fraction above 1 is taken as 1, and one that is not above 0 is not sent, which leaves the height to the design system as it is without this call. A Dialog sizes itself to its content and does not take it.

Source

pub fn presentation(self, presentation: SheetPresentation) -> Self

What form the sheet takes: an edge drawer (Edge, the default) or a centered modal (Centered). A Dialog is always centered and does not take this.

Source

pub fn max_width(self, max_width_dp: u32) -> Self

The maximum width of a centered sheet in dp.

Zero or absent leaves the width to the design system (560 dp). Content wider than this or a window narrower than this shrinks the sheet to fit. An edge sheet sizes its width by its edge and does not take this.

Source§

impl ModalScope

Source

pub fn modifier(self, modifier: Modifier) -> Self

What sits around it. Compose’s modifier parameter.

Source§

impl ModalScope

Source

pub fn content(self, content: impl FnOnce())

Composes this widget with content as its children.

Source§

impl ModalScope

Source

pub fn on_motion_finished( self, handler: impl FnMut(MotionFinished) + 'static, ) -> Self

Runs once when this node’s size motion comes to rest, with the size it settled at in dp. The node needs Modifier::motion for its size to move; without it nothing is reported. A run interrupted by a newer size is not reported, only the one that settles, and under reduced motion it arrives in the frame the size changes in.

Trait Implementations§

Source§

impl Drop for ModalScope

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. 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> 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, 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.