Struct gpg_tui::term::tui::Tui

pub struct Tui<B: Backend> {
    pub events: EventHandler,
    pub paused: bool,
    /* private fields */
}

Text-based user interface.

Tui is responsible for setting up the terminal and initializing the interface. Terminal event handler can be accessed via events field.

Fields

events: EventHandler

Terminal event handler.

paused: bool

Is the interface paused?

Implementations

impl<B: Backend> Tui<B>

pub fn new(terminal: Terminal<B>, events: EventHandler) -> Self

Constructs a new instance of Tui.

pub fn init(&mut self) -> Result<()>

Initializes the terminal interface.

It enables the raw mode and sets terminal properties.

pub fn toggle_pause(&mut self) -> Result<()>

Toggles the paused state of interface.

It disables the key input and exits the terminal interface on pause (and vice-versa).

pub fn enable_mouse_capture(&mut self) -> Result<()>

Enables the mouse capture.

pub fn disable_mouse_capture(&mut self) -> Result<()>

Disables the mouse capture.

pub fn draw(&mut self, app: &mut App<'_>) -> Result<()>

Draw the terminal interface by rendering the widgets.

pub fn reset() -> Result<()>

Reset the terminal interface.

It disables the raw mode and reverts back the terminal properties.

Trait Implementations

impl<B: Debug + Backend> Debug for Tui<B>

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

Formats the value using the given formatter.