Struct ModalSpec 

pub struct ModalSpec<'a> {
    pub title: &'a str,
    pub icon: Option<Icon>,
    pub closable: bool,
    pub actions: &'a [ModalAction<'a>],
    pub platform: PlatformConventions,
    pub body_height: f64,
    pub header_height: f64,
    pub max_width: f64,
    pub close_hovered: bool,
    pub close_focused: bool,
    pub dismiss_on_scrim: bool,
    pub anchor: Option<Rect>,
}

What a modal is being asked to frame.

Fields

title: &'a str

The sheet’s title, set in the Title role.

icon: Option<Icon>

An icon leading the title that names who asks (a lock for a password, the network for a Wi-Fi join).

closable: bool

Draw a close control. Escape always dismisses; this is its visible half, for a sheet with no Cancel action.

actions: &'a [ModalAction<'a>]

Actions in semantic authoring order. Geometry follows Self::platform, so callers do not branch on native button order.

platform: PlatformConventions

Native shortcut and dialog presentation conventions.

body_height: f64

Height the caller’s body content wants, in the same logical pixels as the rest of the layout (already grown by the text scale).

header_height: f64

Height the sheet’s header wants, below the title: the body scrolls under it, so a strip of tabs or a search field stays in view.

max_width: f64

Widest the sheet may be drawn, in design pixels. Defaults to MODAL_MAX_WIDTH.

close_hovered: bool

close_focused: bool

dismiss_on_scrim: bool

Whether a scrim click dismisses. The scrim swallows the click either way: a surface that lets clicks through is not modal.

anchor: Option<Rect>

The control the sheet asks about: it stands beside it as a popover, the window undimmed. None centres it over the window.

Implementations

impl<'a> ModalSpec<'a>

pub fn new(title: &'a str) -> ModalSpec<'a>

pub fn actions(self, actions: &'a [ModalAction<'a>]) -> ModalSpec<'a>

pub fn icon(self, icon: Option<Icon>) -> ModalSpec<'a>

pub fn platform_conventions( self, platform: PlatformConventions, ) -> ModalSpec<'a>

pub fn body_height(self, h: f64) -> ModalSpec<'a>

pub fn header_height(self, h: f64) -> ModalSpec<'a>

pub fn max_width(self, w: f64) -> ModalSpec<'a>

pub fn closable(self, v: bool) -> ModalSpec<'a>

pub fn dismiss_on_scrim(self, v: bool) -> ModalSpec<'a>

pub fn close_hovered(self, v: bool) -> ModalSpec<'a>

pub fn close_focused(self, v: bool) -> ModalSpec<'a>

pub fn anchor(self, anchor: Option<Rect>) -> ModalSpec<'a>

Trait Implementations

impl<'a> Clone for ModalSpec<'a>

fn clone(&self) -> ModalSpec<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ModalSpec<'a>

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

Formats the value using the given formatter.

impl Default for ModalSpec<'_>

fn default() -> ModalSpec<'_>

Returns the “default value” for a type.