Struct Grid

pub struct Grid {

    pub changed_colors: Option<[Option<AnsiCode>; 256]>,
    pub should_render: bool,
    pub lock_renders: bool,
    pub cursor_key_mode: bool,
    pub bracketed_paste_mode: bool,
    pub erasure_mode: bool,
    pub sixel_scrolling: bool,
    pub insert_mode: bool,
    pub disable_linewrap: bool,
    pub new_line_mode: bool,
    pub clear_viewport_before_rendering: bool,
    pub width: usize,
    pub height: usize,
    pub pending_messages_to_pty: Vec<Vec<u8>>,
    pub selection: Selection,
    pub title: Option<String>,
    pub is_scrolled: bool,
    pub link_handler: Rc<RefCell<LinkHandler>>,
    pub ring_bell: bool,
    pub mouse_mode: MouseMode,
    pub mouse_tracking: MouseTracking,
    pub focus_event_tracking: bool,
    pub search_results: SearchResult,
    pub pending_clipboard_update: Option<String>,
    pub supports_kitty_keyboard_protocol: bool,
    /* private fields */
}

Fields

changed_colors: Option<[Option<AnsiCode>; 256]>

should_render: bool

lock_renders: bool

cursor_key_mode: bool

bracketed_paste_mode: bool

erasure_mode: bool

sixel_scrolling: bool

insert_mode: bool

disable_linewrap: bool

new_line_mode: bool

clear_viewport_before_rendering: bool

width: usize

height: usize

pending_messages_to_pty: Vec<Vec<u8>>

selection: Selection

title: Option<String>

is_scrolled: bool

link_handler: Rc<RefCell<LinkHandler>>

ring_bell: bool

mouse_mode: MouseMode

mouse_tracking: MouseTracking

focus_event_tracking: bool

search_results: SearchResult

pending_clipboard_update: Option<String>

supports_kitty_keyboard_protocol: bool

Implementations

impl Grid

pub fn new( rows: usize, columns: usize, terminal_emulator_colors: Rc<RefCell<Palette>>, terminal_emulator_color_codes: Rc<RefCell<HashMap<usize, String>>>, link_handler: Rc<RefCell<LinkHandler>>, character_cell_size: Rc<RefCell<Option<SizeInPixels>>>, sixel_image_store: Rc<RefCell<SixelImageStore>>, style: Style, debug: bool, arrow_fonts: bool, styled_underlines: bool, explicitly_disable_kitty_keyboard_protocol: bool, ) -> Self

pub fn render_full_viewport(&mut self)

pub fn update_line_for_rendering(&mut self, line_index: usize)

pub fn advance_to_next_tabstop(&mut self, styles: RcCharacterStyles)

pub fn move_to_previous_tabstop(&mut self)

pub fn cursor_shape(&self) -> CursorShape

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

pub fn scroll_up_one_line(&mut self) -> bool

pub fn scroll_down_one_line(&mut self) -> bool

pub fn force_change_size(&mut self, new_rows: usize, new_columns: usize)

pub fn change_size(&mut self, new_rows: usize, new_columns: usize)

pub fn as_character_lines(&self) -> Vec<Vec<TerminalCharacter>>

pub fn read_changes( &mut self, x_offset: usize, y_offset: usize, ) -> (Vec<CharacterChunk>, Vec<SixelImageChunk>)

pub fn serialize( &self, scrollback_lines_to_serialize: Option<usize>, ) -> Option<String>

pub fn render( &mut self, content_x: usize, content_y: usize, style: &Style, ) -> Result<Option<(Vec<CharacterChunk>, Option<String>, Vec<SixelImageChunk>)>>

pub fn cursor_coordinates(&self) -> Option<(usize, usize)>

pub fn is_mid_frame(&self) -> bool

pub fn clear_screen(&mut self)

Clears all buffers with text for a current screen

pub fn dump_screen(&self, full: bool) -> String

Dumps all lines above terminal vieport and the viewport itself to a string

pub fn move_viewport_up(&mut self, count: usize)

pub fn move_viewport_down(&mut self, count: usize)

pub fn reset_viewport(&mut self)

pub fn rotate_scroll_region_up(&mut self, count: usize)

pub fn rotate_scroll_region_down(&mut self, count: usize)

pub fn fill_viewport(&mut self, character: TerminalCharacter)

pub fn add_canonical_line(&mut self)

pub fn move_cursor_to_beginning_of_line(&mut self)

pub fn add_character_at_cursor_position( &mut self, terminal_character: TerminalCharacter, should_insert_character: bool, )

pub fn add_character(&mut self, terminal_character: TerminalCharacter)

pub fn get_character_under_cursor(&self) -> Option<TerminalCharacter>

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

pub fn move_cursor_forward_until_edge(&mut self, count: usize)

pub fn replace_characters_in_line_after_cursor( &mut self, replace_with: TerminalCharacter, )

pub fn replace_characters_in_line_before_cursor( &mut self, replace_with: TerminalCharacter, )

pub fn clear_all_after_cursor(&mut self, replace_with: TerminalCharacter)

pub fn clear_all_before_cursor(&mut self, replace_with: TerminalCharacter)

pub fn clear_cursor_line(&mut self)

pub fn clear_all(&mut self, replace_with: TerminalCharacter)

pub fn move_cursor_to( &mut self, x: usize, y: usize, pad_character: TerminalCharacter, )

pub fn move_cursor_up(&mut self, count: usize)

pub fn move_cursor_up_with_scrolling(&mut self, count: usize)

pub fn move_cursor_down_until_edge_of_screen( &mut self, count: usize, pad_character: TerminalCharacter, )

pub fn move_cursor_back(&mut self, count: usize)

pub fn hide_cursor(&mut self)

pub fn show_cursor(&mut self)

pub fn set_scroll_region( &mut self, top_line_index: usize, bottom_line_index: Option<usize>, )

pub fn set_scroll_region_to_viewport_size(&mut self)

pub fn delete_lines_in_scroll_region( &mut self, count: usize, pad_character: TerminalCharacter, )

pub fn add_empty_lines_in_scroll_region( &mut self, count: usize, pad_character: TerminalCharacter, )

pub fn move_cursor_to_column(&mut self, column: usize)

pub fn move_cursor_to_line( &mut self, line: usize, pad_character: TerminalCharacter, )

pub fn replace_with_empty_chars( &mut self, count: usize, empty_char_style: RcCharacterStyles, )

pub fn mark_for_rerender(&mut self)

pub fn reset_terminal_state(&mut self)

pub fn start_selection(&mut self, start: &Position)

pub fn update_selection(&mut self, to: &Position)

pub fn end_selection(&mut self, end: &Position)

pub fn reset_selection(&mut self)

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

pub fn absolute_position_in_scrollback(&self) -> usize

pub fn last_index_in_line(&self, position: &Position) -> Option<usize>

pub fn word_around_position( &self, position: &Position, ) -> Option<(Position, Position)>

pub fn canonical_line_around_position( &self, position: &Position, ) -> Option<(Position, Position)>

pub fn mouse_event_signal(&self, event: &MouseEvent) -> Option<String>

pub fn mouse_left_click_signal( &self, position: &Position, is_held: bool, ) -> Option<String>

pub fn mouse_left_click_release_signal( &self, position: &Position, ) -> Option<String>

pub fn mouse_right_click_signal( &self, position: &Position, is_held: bool, ) -> Option<String>

pub fn mouse_right_click_release_signal( &self, position: &Position, ) -> Option<String>

pub fn mouse_middle_click_signal( &self, position: &Position, is_held: bool, ) -> Option<String>

pub fn mouse_middle_click_release_signal( &self, position: &Position, ) -> Option<String>

pub fn mouse_scroll_up_signal(&self, position: &Position) -> Option<String>

pub fn mouse_scroll_down_signal(&self, position: &Position) -> Option<String>

pub fn is_alternate_mode_active(&self) -> bool

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

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

pub fn delete_viewport_and_scroll(&mut self)

pub fn reset_cursor_position(&mut self)

pub fn lock_renders(&mut self)

pub fn unlock_renders(&mut self)

pub fn update_theme(&mut self, theme: Styling)

pub fn update_arrow_fonts(&mut self, should_support_arrow_fonts: bool)

pub fn has_selection(&self) -> bool

impl Grid

pub fn search_down(&mut self)

pub fn search_up(&mut self)

pub fn clear_search(&mut self)

pub fn set_search_string(&mut self, needle: &str)

pub fn search_viewport(&mut self)

pub fn toggle_search_case_sensitivity(&mut self)

pub fn toggle_search_wrap(&mut self)

pub fn toggle_search_whole_words(&mut self)

Trait Implementations

impl Clone for Grid

fn clone(&self) -> Grid

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Grid

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

Formats the value using the given formatter.

impl Perform for Grid

fn print(&mut self, c: char)

Draw a character to the screen and update states.

fn execute(&mut self, byte: u8)

Execute a C0 or C1 control function.

fn hook( &mut self, params: &Params, intermediates: &[u8], _ignore: bool, c: char, )

Invoked when a final character arrives in first part of device control string.

fn put(&mut self, byte: u8)

Pass bytes as part of a device control string to the handle chosen in hook. C0 controls will also be passed to the handler.

fn unhook(&mut self)

Called when a device control string is terminated.

fn osc_dispatch(&mut self, params: &[&[u8]], bell_terminated: bool)

Dispatch an operating system command.

fn csi_dispatch( &mut self, params: &Params, intermediates: &[u8], _ignore: bool, c: char, )

A final character has arrived for a CSI sequence

fn esc_dispatch(&mut self, intermediates: &[u8], _ignore: bool, byte: u8)

The final character of an escape sequence has arrived.