Struct BoxBorder 

pub struct BoxBorder { /* private fields */ }

A single-line box border drawn around a Rect.

The interior of the rectangle is not touched. area must be at least 2×2, or Widget::render is a no-op. style defaults to Style::new(); set it with BoxBorder::style.

Implementations

impl BoxBorder

pub fn new() -> Self

A plain box border; see BoxBorder::style to color it.

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

Set the border’s style.

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

Sets style to theme.border on theme.panel_bg.

The background is set explicitly rather than left at Style::new()’s default: an unset background isn’t “transparent” once a real backend draws it (a bare Color::Default cell paints as solid black behind the glyph, not whatever was there before – see retroglyph-software’s DEFAULT_BG), which would leave a visible black grid of border cells on a light Theme rather than a border blending into its surroundings. That means this widget has to assume something about what it’s drawn over, even though (unlike super::Panel, which also owns and fills its own interior) a standalone BoxBorder genuinely doesn’t know – theme.panel_bg is the closest default, matching what a themed super::Panel/super::Modal around it would use. Drawing this border directly on the raw screen background instead needs a manual BoxBorder::style override afterwards.

Call before any manual BoxBorder::style override you want to keep.

Trait Implementations

impl Clone for BoxBorder

fn clone(&self) -> BoxBorder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BoxBorder

impl Debug for BoxBorder

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

Formats the value using the given formatter.

impl Default for BoxBorder

fn default() -> BoxBorder

Returns the “default value” for a type.

impl<B: Backend> Widget<B> for BoxBorder

fn render(self, area: Rect, term: &mut Terminal<B>)

Draw this widget into area.