Struct TUI 

pub struct TUI {
    pub root: Container,
    /* private fields */
}

Fields

root: Container

The root container — all top-level children are added here. Overlays are also managed through Container’s overlay stack. Matches pi’s class TUI extends Container.

Implementations

impl TUI

pub fn new() -> Self

pub fn screen_mut(&mut self) -> &mut Screen

pub fn full_redraw_count(&self) -> usize

pub fn set_clear_on_shrink(&mut self, enabled: bool)

pub fn set_dimensions(&mut self, width: usize, height: usize)

pub fn get_dimensions(&self) -> (usize, usize)

pub fn request_render(&mut self)

pub fn is_dirty(&self) -> bool

pub fn show_overlay( &mut self, component: Box<dyn Component>, options: OverlayOptions, ) -> u64

pub fn hide_overlay(&mut self, id: u64)

pub fn pop_overlay(&mut self)

pub fn has_overlays(&self) -> bool

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

Route a keyboard event through the overlay input pipeline. Should be called BEFORE the application handles the key itself, so overlays get first crack at input.

pub fn route_paste(&mut self, text: &str) -> bool

Route a paste event to overlays or root.

pub fn render( &mut self, width: usize, height: usize, writer: &mut dyn Write, ) -> Result<()>

Render the root component tree (including composited overlays), then diff-render to screen via Screen.

pub fn finalize(&mut self, writer: &mut dyn Write) -> Result<()>

Move cursor to clean position on exit — past all content

Trait Implementations

impl Default for TUI

fn default() -> Self

Returns the “default value” for a type.