Struct tui::widgets::Clear

pub struct Clear;

A widget to to clear/reset a certain area to allow overdrawing (e.g. for popups)

Examples

fn draw_on_clear<B: Backend>(f: &mut Frame<B>, area: Rect) {
    let block = Block::default().title("Block").borders(Borders::ALL);
    f.render_widget(Clear, area); // <- this will clear/reset the area first
    f.render_widget(block, area); // now render the block widget
}

Popup Example

For a more complete example how to utilize Clear to realize popups see the example examples/popup.rs

Trait Implementations

impl Clone for Clear

fn clone(&self) -> Clear

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Clear

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

Formats the value using the given formatter.

impl Widget for Clear

fn render(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.