Struct zellij_server::panes::Grid

pub struct Grid {
    pub should_render: bool,
    pub cursor_key_mode: bool,
    pub erasure_mode: bool,
    pub insert_mode: bool,
    pub disable_linewrap: bool,
    pub clear_viewport_before_rendering: bool,
    pub width: usize,
    pub height: usize,
    pub pending_messages_to_pty: Vec<Vec<u8>>,
    // some fields omitted
}

Fields

should_render: bool

cursor_key_mode: bool

erasure_mode: bool

insert_mode: bool

disable_linewrap: bool

clear_viewport_before_rendering: bool

width: usize

height: usize

pending_messages_to_pty: Vec<Vec<u8>>

Implementations

impl Grid

pub fn new(rows: usize, columns: usize, colors: Palette) -> Self

pub fn render_full_viewport(&mut self)

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

pub fn move_to_previous_tabstop(&mut self)

pub fn cursor_shape(&self) -> CursorShape

pub fn scroll_up_one_line(&mut self)

pub fn scroll_down_one_line(&mut self)

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) -> Vec<CharacterChunk>

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

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 insert_character_at_cursor_position(
    &mut self,
    terminal_character: TerminalCharacter
)

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

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

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(
    &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 clear_scroll_region(&mut self)

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: CharacterStyles
)

pub fn erase_characters(
    &mut self,
    count: usize,
    empty_char_style: CharacterStyles
)

pub fn mark_for_rerender(&mut self)

Trait Implementations

impl Clone for Grid

fn clone(&self) -> Grid

Returns a copy 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.