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![
    ListItem::new("Item 1"),
    ListItem::new("Item 2"),
];
let list = List::new(items);
let area = Rect::new(0, 0, 5, 5);
let mut frame = terminal.get_frame();
frame.render_stateful_widget(list, area, &mut state);

pub fn set_cursor(&mut self, x: u16, y: u16)

After drawing this frame, make the cursor visible and put it at the specified (x, y) coordinates. If this method is not called, the cursor will be hidden.

Note that this will interfere with calls to Terminal::hide_cursor(), Terminal::show_cursor(), and Terminal::set_cursor(). Pick one of the APIs and stick with it.