Struct tui::widgets::Block

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

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")
    .borders(Borders::LEFT | Borders::RIGHT)
    .border_style(Style::default().fg(Color::White))
    .border_type(BorderType::Rounded)
    .style(Style::default().bg(Color::Black));

Implementations

impl<'a> Block<'a>

pub fn title<T>(self, title: T) -> Block<'a> where
    T: Into<Spans<'a>>, 

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

👎 Deprecated since 0.10.0:

You should use styling capabilities of text::Spans given as argument of the title method to apply styling to the title.

pub fn title_alignment(self, alignment: Alignment) -> 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 border_type(self, border_type: BorderType) -> 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> Debug for Block<'a>

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

Formats the value using the given formatter.

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

fn default() -> Block<'a>

Returns the “default value” for a type.

impl<'a> PartialEq<Block<'a>> for Block<'a>

fn eq(&self, other: &Block<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Block<'a>) -> bool

This method tests for !=.

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

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

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

impl<'a> StructuralPartialEq for Block<'a>