Struct tui::widgets::Block

pub struct Block<'a> { /* fields omitted */ }

Base widget to be used with all upper level ones. It may be used to display a box border around the widget and/or add a title.

Examples

Block::default()
    .title("Block")
    .title_style(Style::default().fg(Color::Red))
    .borders(Borders::LEFT | Borders::RIGHT)
    .border_style(Style::default().fg(Color::White))
    .style(Style::default().bg(Color::Black));

Methods

impl<'a> Block<'a>

pub fn title(self, title: &'a str) -> Block<'a>

pub fn title_style(self, style: Style) -> Block<'a>

pub fn border_style(self, style: Style) -> Block<'a>

pub fn style(self, style: Style) -> Block<'a>

pub fn borders(self, flag: Borders) -> Block<'a>

pub fn inner(&self, area: &Rect) -> Rect

Compute the inner area of a block based on its border visibility rules.

Trait Implementations

impl<'a> Clone for Block<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for Block<'a>

impl<'a> Default for Block<'a>

fn default() -> Block<'a>

Returns the "default value" for a type.

impl<'a> Widget for Block<'a>

fn draw(&mut self, area: &Rect, buf: &mut Buffer)

Draws the current state of the widget in the given buffer. That the only method required to implement a custom widget.

fn background(&self, area: &Rect, buf: &mut Buffer, color: Color)

Helper method to quickly set the background of all cells inside the specified area.

fn render<B>(&mut self, t: &mut Terminal<B>, area: &Rect) where
    Self: Sized,
    B: Backend, 

Helper method that can be chained with a widget's builder methods to render it.