Trait requestty_ui::widgets::Widget

pub trait Widget {
    fn render<B: Backend>(
        &mut self,
        layout: &mut Layout,
        backend: &mut B
    ) -> Result<()>;
    fn height(&mut self, layout: &mut Layout) -> u16;
    fn cursor_pos(&mut self, layout: Layout) -> (u16, u16);
    fn handle_key(&mut self, key: KeyEvent) -> bool;
}

A trait to represent renderable objects.

There are 2 purposes of a widget.

1. Rendering to the screen.
2. Handling input events.

Render Cycle

Rendering happens in a 3 step process.

1. First, the height is calculated with the height function.
2. Then, the render function is called which is where the actual drawing happens. The cursor should end at the position reflected by the layout.
3. Finally, the cursor position which the user needs should see is calculated with the cursor_pos function.

While it is not a guarantee that the terminal will be in raw mode, it is highly recommended that those implementing the render cycle call render while in raw mode.

Required Methods

fn render<B: Backend>(
    &mut self,
    layout: &mut Layout,
    backend: &mut B
) -> Result<()>

Render to a given backend.

The widget is responsible for updating the layout to reflect the space that it has used.

fn height(&mut self, layout: &mut Layout) -> u16

The number of rows of the terminal the widget will take when rendered.

The widget is responsible for updating the layout to reflect the space that it will use.

fn cursor_pos(&mut self, layout: Layout) -> (u16, u16)

The position of the cursor to be placed at after render. The returned value should be in the form of (x, y), with (0, 0) being the top left of the screen.

For example, if you want the cursor to be at the first character that could be printed, cursor_pos would be (layout.offset_x + layout.line_offset, layout.offset_y). Also see Layout::offset_cursor.

fn handle_key(&mut self, key: KeyEvent) -> bool

Handle a key input. It should return whether key was handled.

Implementors

impl<F> Widget for CharInput<F> where
    F: Fn(char) -> Option<char>, 

impl<F> Widget for StringInput<F> where
    F: Fn(char) -> Option<char>, 

impl<L: List> Widget for Select<L>

impl<M: AsRef<str>, H: AsRef<str>> Widget for Prompt<M, H>

impl<S: AsRef<str>> Widget for Text<S>

impl<T: Deref<Target = str> + ?Sized> Widget for T