Struct Screen 

pub struct Screen { /* private fields */ }

Represents the overall terminal state.

Implementations

impl Screen

pub fn get_selected_text( &self, low_x: i32, low_y: i32, high_x: i32, high_y: i32, ) -> String

Available on crate feature termtui only.

pub fn size(&self) -> Size

Available on crate feature termtui only.

Returns the current size of the terminal.

The return value will be (rows, cols).

pub fn scrollback(&self) -> usize

Available on crate feature termtui only.

Returns the current position in the scrollback.

This position indicates the offset from the top of the screen, and is 0 when the normal screen is in view.

pub fn scrollback_len(&self) -> usize

Available on crate feature termtui only.

pub fn set_scrollback(&mut self, rows: usize)

Available on crate feature termtui only.

pub fn scroll_screen_up(&mut self, n: usize)

Available on crate feature termtui only.

pub fn scroll_screen_down(&mut self, n: usize)

Available on crate feature termtui only.

pub fn cursor_position(&self) -> (u16, u16)

Available on crate feature termtui only.

Returns the current cursor position of the terminal.

The return value will be (row, col).

pub fn cell(&self, row: u16, col: u16) -> Option<&Cell>

Available on crate feature termtui only.

Returns the Cell object at the given location in the terminal, if it exists.

pub fn cursor_style(&self) -> CursorStyle

Available on crate feature termtui only.

pub fn application_cursor(&self) -> bool

Available on crate feature termtui only.

Returns whether the terminal should be in application cursor mode.

pub fn hide_cursor(&self) -> bool

Available on crate feature termtui only.

Returns whether the terminal should be in hide cursor mode.

pub fn mouse_protocol_mode(&self) -> MouseProtocolMode

Available on crate feature termtui only.

Returns the currently active MouseProtocolMode

impl Screen

pub fn process(&mut self, data: &[u8], events: &mut Vec<VtEvent>)

Available on crate feature termtui only.

https://man7.org/linux/man-pages/man4/console_codes.4.html https://en.wikipedia.org/wiki/ANSI_escape_code https://terminalguide.namepad.de/seq/ https://vt100.net/docs/vt510-rm/contents.html https://xtermjs.org/docs/api/vtfeatures/ https://learn.microsoft.com/en-us/windows/console/console-virtual-terminal-sequences https://bjh21.me.uk/all-escapes/all-escapes.txt

Trait Implementations

impl Clone for Screen

fn clone(&self) -> Screen

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Screen

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

Formats the value using the given formatter.