Struct Term

pub struct Term {
    pub dirty: bool,
    pub visual_bell: VisualBell,
    pub next_is_urgent: Option<bool>,
    /* private fields */
}

Fields

dirty: bool

visual_bell: VisualBell

next_is_urgent: Option<bool>

Implementations

impl Term

pub fn selection(&self) -> &Option<Selection>

pub fn selection_mut(&mut self) -> &mut Option<Selection>

pub fn get_next_title(&mut self) -> Option<String>

pub fn scroll_display(&mut self, scroll: Scroll)

pub fn get_next_mouse_cursor(&mut self) -> Option<MouseCursor>

pub fn new(size: SizeInfo) -> Term

pub fn needs_draw(&self) -> bool

pub fn selection_to_string(&self) -> Option<String>

pub fn pixels_to_coords(&self, x: usize, y: usize) -> Option<Point>

Convert the given pixel values to a grid coordinate

The mouse coordinates are expected to be relative to the top left. The line and column returned are also relative to the top left.

Returns None if the coordinates are outside the screen

pub fn grid(&self) -> &Grid<Cell>

Access to the raw grid data structure

This is a bit of a hack; when the window is closed, the event processor serializes the grid state to a file.

pub fn renderable_cells(&self) -> RenderableCellsIter<'_>

Iterate over the renderable cells in the terminal

A renderable cell is any cell which has content other than the default background color. Cells with an alternate background color are considered renderable as are cells with any text content.

pub fn resize(&mut self, size: &SizeInfo)

Resize terminal to new dimensions

pub fn size_info(&self) -> &SizeInfo

pub fn mode(&self) -> &TermMode

pub fn cursor(&self) -> &Cursor

pub fn swap_alt(&mut self)

pub fn exit(&mut self)

pub fn should_exit(&self) -> bool

Trait Implementations

impl Dimensions for Term

fn dimensions(&self) -> Point

Get the size of the area

impl Handler for Term

fn set_title(&mut self, title: &str)

Set the window title

fn set_mouse_cursor(&mut self, cursor: MouseCursor)

Set the mouse cursor

fn input(&mut self, c: char)

A character to be displayed

fn backspace(&mut self)

Backspace count characters

fn carriage_return(&mut self)

Carriage return

fn linefeed(&mut self)

Linefeed

fn bell(&mut self)

Set current position as a tabstop

fn newline(&mut self)

Run LF/NL

LF/NL mode has some interesting history. According to ECMA-48 4th edition, in LINE FEED mode,

The execution of the formatter functions LINE FEED (LF), FORM FEED (FF), LINE TABULATION (VT) cause only movement of the active position in the direction of the line progression.

In NEW LINE mode,

The execution of the formatter functions LINE FEED (LF), FORM FEED (FF), LINE TABULATION (VT) cause movement to the line home position on the following line, the following form, etc. In the case of LF this is referred to as the New index::Line (NL) option.

Additionally, ECMA-48 4th edition says that this option is deprecated. ECMA-48 5th edition only mentions this option (without explanation) saying that it’s been removed.

As an emulator, we need to support it since applications may still rely on it.

fn terminal_attribute(&mut self, attr: Attr)

set a terminal attribute

fn set_clipboard(&mut self, _string: &str)

Set the clipboard

fn set_cursor_style(&mut self, style: Option<CursorStyle>)

Set the cursor style

fn goto(&mut self, line: Line, col: Column)

Set cursor to position

fn goto_line(&mut self, line: Line)

Set cursor to specific row

fn goto_col(&mut self, col: Column)

Set cursor to specific column

fn insert_blank(&mut self, count: Column)

Insert blank characters in current line starting from cursor

fn move_up(&mut self, lines: Line)

Move cursor up rows

fn move_down(&mut self, lines: Line)

Move cursor down rows

fn identify_terminal<W: Write>(&mut self, writer: &mut W)

Identify the terminal (should write back to the pty stream)

fn device_status<W: Write>(&mut self, writer: &mut W, arg: usize)

fn move_forward(&mut self, cols: Column)

Move cursor forward cols

fn move_backward(&mut self, cols: Column)

Move cursor backward cols

fn move_down_and_cr(&mut self, lines: Line)

Move cursor down rows and set to column 1

fn move_up_and_cr(&mut self, lines: Line)

Move cursor up rows and set to column 1

fn put_tab(&mut self, count: i64)

Put count tabs

fn substitute(&mut self)

Substitute char under cursor

fn set_horizontal_tabstop(&mut self)

Set current position as a tabstop

fn scroll_up(&mut self, lines: Line)

Scroll up rows rows

fn scroll_down(&mut self, lines: Line)

Scroll down rows rows

fn insert_blank_lines(&mut self, lines: Line)

Insert count blank lines

fn delete_lines(&mut self, lines: Line)

Delete count lines

fn erase_chars(&mut self, count: Column)

Erase count chars in current line following cursor

fn delete_chars(&mut self, count: Column)

Delete count chars

fn move_backward_tabs(&mut self, count: i64)

Move backward count tabs

fn move_forward_tabs(&mut self, count: i64)

Move forward count tabs

fn save_cursor_position(&mut self)

Save current cursor position

fn restore_cursor_position(&mut self)

Restore cursor position

fn clear_line(&mut self, mode: LineClearMode)

Clear current line

fn clear_screen(&mut self, mode: ClearMode)

Clear screen

fn clear_tabs(&mut self, mode: TabulationClearMode)

Clear tab stops

fn reset_state(&mut self)

Reset terminal state

fn reverse_index(&mut self)

Reverse Index

fn set_mode(&mut self, mode: Mode)

Set mode

fn unset_mode(&mut self, mode: Mode)

Unset mode

fn set_scrolling_region(&mut self, region: Range<Line>)

DECSTBM - Set the terminal scrolling region

fn set_keypad_application_mode(&mut self)

DECKPAM - Set keypad to applications mode (ESCape instead of digits)

fn unset_keypad_application_mode(&mut self)

DECKPNM - Set keypad to numeric mode (digits instead of ESCape seq)

fn set_active_charset(&mut self, index: CharsetIndex)

Set one of the graphic character sets, G0 to G3, as the active charset.

fn configure_charset(&mut self, index: CharsetIndex, charset: StandardCharset)

Assign a graphic character set to G0, G1, G2 or G3

fn dectest(&mut self)

Run the dectest routine

fn set_color(&mut self, _: usize, _: Rgb)

Set an indexed color value

fn reset_color(&mut self, _: usize)

Reset an indexed color to original value

impl Search for Term

fn semantic_search_left(&self, point: Point<usize>) -> Point<usize>

Find the nearest semantic boundary to the left of provided point.

fn semantic_search_right(&self, point: Point<usize>) -> Point<usize>

Find the nearest semantic boundary to the point of provided point.

fn url_search(&self, _: Point<usize>) -> Option<String>

Find the nearest URL boundary in both directions.

impl TermInfo for Term

fn lines(&self) -> Line

fn cols(&self) -> Column