Skip to main content

Modal

Struct Modal 

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

A modal dialog widget with title, body, border, and optional dim background.

Renders as a bordered box with a title in the top border and body content inside. Use Modal::to_overlay_config to create an overlay config for use with crate::overlay::ScreenStack.

Implementations§

Source§

impl Modal

Source

pub fn new(title: impl Into<String>, width: u16, height: u16) -> Self

Create a new modal with the given title and dimensions.

Source

pub fn with_body(self, lines: Vec<Vec<Segment>>) -> Self

Set the body content lines.

Source

pub fn with_style(self, style: Style) -> Self

Set the style for the modal border and text.

Source

pub fn with_border(self, border: BorderStyle) -> Self

Set the border style.

Source

pub fn render_to_lines(&self) -> Vec<Vec<Segment>>

Render the modal to lines ready for the compositor.

Produces a bordered box with the title in the top border line and body content inside. Lines are padded to the modal’s width.

Source

pub fn to_overlay_config(&self) -> OverlayConfig

Create an overlay config for this modal (centered, with dim background).

Trait Implementations§

Source§

impl Clone for Modal

Source§

fn clone(&self) -> Modal

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Modal

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Modal

§

impl RefUnwindSafe for Modal

§

impl Send for Modal

§

impl Sync for Modal

§

impl Unpin for Modal

§

impl UnwindSafe for Modal

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.