Struct tui::terminal::Frame

pub struct Frame<'a, B: 'a> where
    B: Backend,  { /* fields omitted */ }

Represents a consistent terminal interface for rendering.

Implementations

impl<'a, B> Frame<'a, B> where
    B: Backend, 

pub fn size(&self) -> Rect

Terminal size, guaranteed not to change when rendering.

pub fn render_widget<W>(&mut self, widget: W, area: Rect) where
    W: Widget, 

Render a Widget to the current buffer using Widget::render.

Examples

let block = Block::default();
let area = Rect::new(0, 0, 5, 5);
let mut frame = terminal.get_frame();
frame.render_widget(block, area);

pub fn render_stateful_widget<W>(
    &mut self,
    widget: W,
    area: Rect,
    state: &mut W::State
) where
    W: StatefulWidget, 

Render a StatefulWidget to the current buffer using StatefulWidget::render.

The last argument should be an instance of the StatefulWidget::State associated to the given StatefulWidget.

Examples

let mut state = ListState::default();
state.select(Some(1));
let items = vec![Text::raw("Item 1"), Text::raw("Item 2")];
let list = List::new(items.into_iter());
let area = Rect::new(0, 0, 5, 5);
let mut frame = terminal.get_frame();
frame.render_stateful_widget(list, area, &mut state);