Skip to main content

Modal

Struct Modal 

Source
pub struct Modal<'a> { /* private fields */ }
Expand description

A bordered, filled box centered in a screen Rect.

Shorthand for a Panel sized width x height and centered via centered_rect. border_style/fill_style default to Style::new() and there is no title by default – set whichever a caller needs via Modal::border_style/Modal::fill_style/Modal::title, the same as Panel.

Modal::render returns the inner content Rect (inside the border, the same implicit one-cell inset Panel uses for its own interior) ready to hand to another widget (e.g. super::Log).

Draws only the box itself; everything outside it is left untouched (no dimming or backdrop fill – that would need to read and blend existing cells, a separate feature from this thin layout convenience). Not a Widget: Widget::render can’t return a value, and the inner content rect is part of this type’s contract.

Implementations§

Source§

impl<'a> Modal<'a>

Source

pub fn new(width: u16, height: u16) -> Self

A width x height modal in the default style, with no title.

Source

pub const fn title(self, title: &'a str) -> Self

Set the modal’s title.

Source

pub const fn title_align(self, align: Align) -> Self

Set how the title is aligned along the top border. Defaults to Align::Center, the same as Panel::title_align.

Source

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

Set the box outline and title’s style.

Source

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

Set the interior background’s style.

Source

pub fn theme(self, theme: Theme) -> Self

Applies theme’s named roles to this modal’s border and fill, the same mapping as Panel::theme (a Modal is just a centered Panel): border_style becomes theme.border on theme.title_bg, and fill_style becomes theme.panel_bg.

Call before any manual Modal::border_style/Modal::fill_style override you want to keep – whichever call comes last wins.

Source

pub fn theme_on(self, theme: Theme, bg: Color) -> Self

Same as Modal::theme, but fill_style is drawn on bg instead of theme.panel_bg – the same Panel::theme_on escape hatch, for a modal whose interior should read as a different surface than theme.panel_bg (border_style still uses theme.title_bg, unaffected by bg). Modal::theme is exactly theme_on(theme, theme.panel_bg).

Source

pub fn render<B: Backend>(self, screen: Rect, term: &mut Terminal<B>) -> Rect

Draw the modal centered in screen, returning its inner content Rect.

Trait Implementations§

Source§

impl<'a> Clone for Modal<'a>

Source§

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

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<'a> Copy for Modal<'a>

Source§

impl<'a> Debug for Modal<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for Modal<'a>

§

impl<'a> RefUnwindSafe for Modal<'a>

§

impl<'a> Send for Modal<'a>

§

impl<'a> Sync for Modal<'a>

§

impl<'a> Unpin for Modal<'a>

§

impl<'a> UnsafeUnpin for Modal<'a>

§

impl<'a> UnwindSafe for Modal<'a>

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.
Source§

impl<C> WithAlpha for C
where C: Copy,

Source§

fn with_alpha_first<A>(self, alpha: A) -> AlphaFirst<A, Self>

Wraps self with alpha, storing alpha before the color in memory (see AlphaFirst).
Source§

fn with_alpha_last<A>(self, alpha: A) -> AlphaLast<A, Self>

Wraps self with alpha, storing alpha after the color in memory (see AlphaLast).