Trait zellij_server::tab::Pane

source ·
pub trait Pane {
Show 120 methods // Required methods fn x(&self) -> usize; fn y(&self) -> usize; fn rows(&self) -> usize; fn cols(&self) -> usize; fn get_content_x(&self) -> usize; fn get_content_y(&self) -> usize; fn get_content_columns(&self) -> usize; fn get_content_rows(&self) -> usize; fn reset_size_and_position_override(&mut self); fn set_geom(&mut self, position_and_size: PaneGeom); fn set_geom_override(&mut self, pane_geom: PaneGeom); fn cursor_coordinates(&self) -> Option<(usize, usize)>; fn position_and_size(&self) -> PaneGeom; fn current_geom(&self) -> PaneGeom; fn geom_override(&self) -> Option<PaneGeom>; fn should_render(&self) -> bool; fn set_should_render(&mut self, should_render: bool); fn selectable(&self) -> bool; fn set_selectable(&mut self, selectable: bool); fn render( &mut self, client_id: Option<ClientId> ) -> Result<Option<(Vec<CharacterChunk>, Option<String>, Vec<SixelImageChunk>)>>; fn render_frame( &mut self, client_id: ClientId, frame_params: FrameParams, input_mode: InputMode ) -> Result<Option<(Vec<CharacterChunk>, Option<String>)>>; fn render_fake_cursor( &mut self, cursor_color: PaletteColor, text_color: PaletteColor ) -> Option<String>; fn render_terminal_title(&mut self, _input_mode: InputMode) -> String; fn update_name(&mut self, name: &str); fn pid(&self) -> PaneId; fn reduce_height(&mut self, percent: f64); fn increase_height(&mut self, percent: f64); fn reduce_width(&mut self, percent: f64); fn increase_width(&mut self, percent: f64); fn push_down(&mut self, count: usize); fn push_right(&mut self, count: usize); fn pull_left(&mut self, count: usize); fn pull_up(&mut self, count: usize); fn clear_screen(&mut self); fn scroll_up(&mut self, count: usize, client_id: ClientId); fn scroll_down(&mut self, count: usize, client_id: ClientId); fn clear_scroll(&mut self); fn is_scrolled(&self) -> bool; fn active_at(&self) -> Instant; fn set_active_at(&mut self, instant: Instant); fn set_frame(&mut self, frame: bool); fn set_content_offset(&mut self, offset: Offset); fn store_pane_name(&mut self); fn load_pane_name(&mut self); fn set_borderless(&mut self, borderless: bool); fn borderless(&self) -> bool; fn set_exclude_from_sync(&mut self, exclude_from_sync: bool); fn exclude_from_sync(&self) -> bool; fn add_red_pane_frame_color_override(&mut self, _error_text: Option<String>); fn clear_pane_frame_color_override(&mut self); fn frame_color_override(&self) -> Option<PaletteColor>; fn invoked_with(&self) -> &Option<Run>; fn set_title(&mut self, title: String); fn current_title(&self) -> String; fn custom_title(&self) -> Option<String>; // Provided methods fn handle_pty_bytes(&mut self, _bytes: Vec<u8>) { ... } fn handle_plugin_bytes(&mut self, _client_id: ClientId, _bytes: Vec<u8>) { ... } fn adjust_input_to_terminal( &mut self, _input_bytes: Vec<u8> ) -> Option<AdjustedInput> { ... } fn set_should_render_boundaries(&mut self, _should_render: bool) { ... } fn request_permissions_from_user( &mut self, _permissions: Option<PluginPermission> ) { ... } fn dump_screen(&mut self, _client_id: ClientId, _full: bool) -> String { ... } fn cursor_shape_csi(&self) -> String { ... } fn contains(&self, position: &Position) -> bool { ... } fn start_selection(&mut self, _start: &Position, _client_id: ClientId) { ... } fn update_selection(&mut self, _position: &Position, _client_id: ClientId) { ... } fn end_selection(&mut self, _end: &Position, _client_id: ClientId) { ... } fn reset_selection(&mut self) { ... } fn get_selected_text(&self) -> Option<String> { ... } fn right_boundary_x_coords(&self) -> usize { ... } fn bottom_boundary_y_coords(&self) -> usize { ... } fn is_right_of(&self, other: &dyn Pane) -> bool { ... } fn is_directly_right_of(&self, other: &dyn Pane) -> bool { ... } fn is_left_of(&self, other: &dyn Pane) -> bool { ... } fn is_directly_left_of(&self, other: &dyn Pane) -> bool { ... } fn is_below(&self, other: &dyn Pane) -> bool { ... } fn is_directly_below(&self, other: &dyn Pane) -> bool { ... } fn is_above(&self, other: &dyn Pane) -> bool { ... } fn is_directly_above(&self, other: &dyn Pane) -> bool { ... } fn horizontally_overlaps_with(&self, other: &dyn Pane) -> bool { ... } fn get_horizontal_overlap_with(&self, other: &dyn Pane) -> usize { ... } fn vertically_overlaps_with(&self, other: &dyn Pane) -> bool { ... } fn get_vertical_overlap_with(&self, other: &dyn Pane) -> usize { ... } fn can_reduce_height_by(&self, reduce_by: usize) -> bool { ... } fn can_reduce_width_by(&self, reduce_by: usize) -> bool { ... } fn min_width(&self) -> usize { ... } fn min_height(&self) -> usize { ... } fn drain_messages_to_pty(&mut self) -> Vec<Vec<u8>> { ... } fn drain_clipboard_update(&mut self) -> Option<String> { ... } fn render_full_viewport(&mut self) { ... } fn relative_position(&self, position_on_screen: &Position) -> Position { ... } fn position_is_on_frame(&self, position: &Position) -> bool { ... } fn handle_right_click(&mut self, _to: &Position, _client_id: ClientId) { ... } fn mouse_left_click( &self, _position: &Position, _is_held: bool ) -> Option<String> { ... } fn mouse_left_click_release(&self, _position: &Position) -> Option<String> { ... } fn mouse_right_click( &self, _position: &Position, _is_held: bool ) -> Option<String> { ... } fn mouse_right_click_release(&self, _position: &Position) -> Option<String> { ... } fn mouse_middle_click( &self, _position: &Position, _is_held: bool ) -> Option<String> { ... } fn mouse_middle_click_release(&self, _position: &Position) -> Option<String> { ... } fn mouse_scroll_up(&self, _position: &Position) -> Option<String> { ... } fn mouse_scroll_down(&self, _position: &Position) -> Option<String> { ... } fn focus_event(&self) -> Option<String> { ... } fn unfocus_event(&self) -> Option<String> { ... } fn get_line_number(&self) -> Option<usize> { ... } fn update_search_term(&mut self, _needle: &str) { ... } fn search_down(&mut self) { ... } fn search_up(&mut self) { ... } fn toggle_search_case_sensitivity(&mut self) { ... } fn toggle_search_whole_words(&mut self) { ... } fn toggle_search_wrap(&mut self) { ... } fn clear_search(&mut self) { ... } fn is_alternate_mode_active(&self) -> bool { ... } fn hold( &mut self, _exit_status: Option<i32>, _is_first_run: bool, _run_command: RunCommand ) { ... } fn update_loading_indication( &mut self, _loading_indication: LoadingIndication ) { ... } fn start_loading_indication( &mut self, _loading_indication: LoadingIndication ) { ... } fn progress_animation_offset(&mut self) { ... } fn is_held(&self) -> bool { ... } fn exited(&self) -> bool { ... } fn exit_status(&self) -> Option<i32> { ... } fn rename(&mut self, _buf: Vec<u8>) { ... } fn serialize( &self, _scrollback_lines_to_serialize: Option<usize> ) -> Option<String> { ... }
}

Required Methods§

source

fn x(&self) -> usize

source

fn y(&self) -> usize

source

fn rows(&self) -> usize

source

fn cols(&self) -> usize

source

fn get_content_x(&self) -> usize

source

fn get_content_y(&self) -> usize

source

fn get_content_columns(&self) -> usize

source

fn get_content_rows(&self) -> usize

source

fn reset_size_and_position_override(&mut self)

source

fn set_geom(&mut self, position_and_size: PaneGeom)

source

fn set_geom_override(&mut self, pane_geom: PaneGeom)

source

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

source

fn position_and_size(&self) -> PaneGeom

source

fn current_geom(&self) -> PaneGeom

source

fn geom_override(&self) -> Option<PaneGeom>

source

fn should_render(&self) -> bool

source

fn set_should_render(&mut self, should_render: bool)

source

fn selectable(&self) -> bool

source

fn set_selectable(&mut self, selectable: bool)

source

fn render( &mut self, client_id: Option<ClientId> ) -> Result<Option<(Vec<CharacterChunk>, Option<String>, Vec<SixelImageChunk>)>>

source

fn render_frame( &mut self, client_id: ClientId, frame_params: FrameParams, input_mode: InputMode ) -> Result<Option<(Vec<CharacterChunk>, Option<String>)>>

source

fn render_fake_cursor( &mut self, cursor_color: PaletteColor, text_color: PaletteColor ) -> Option<String>

source

fn render_terminal_title(&mut self, _input_mode: InputMode) -> String

source

fn update_name(&mut self, name: &str)

source

fn pid(&self) -> PaneId

source

fn reduce_height(&mut self, percent: f64)

source

fn increase_height(&mut self, percent: f64)

source

fn reduce_width(&mut self, percent: f64)

source

fn increase_width(&mut self, percent: f64)

source

fn push_down(&mut self, count: usize)

source

fn push_right(&mut self, count: usize)

source

fn pull_left(&mut self, count: usize)

source

fn pull_up(&mut self, count: usize)

source

fn clear_screen(&mut self)

source

fn scroll_up(&mut self, count: usize, client_id: ClientId)

source

fn scroll_down(&mut self, count: usize, client_id: ClientId)

source

fn clear_scroll(&mut self)

source

fn is_scrolled(&self) -> bool

source

fn active_at(&self) -> Instant

source

fn set_active_at(&mut self, instant: Instant)

source

fn set_frame(&mut self, frame: bool)

source

fn set_content_offset(&mut self, offset: Offset)

source

fn store_pane_name(&mut self)

source

fn load_pane_name(&mut self)

source

fn set_borderless(&mut self, borderless: bool)

source

fn borderless(&self) -> bool

source

fn set_exclude_from_sync(&mut self, exclude_from_sync: bool)

source

fn exclude_from_sync(&self) -> bool

source

fn add_red_pane_frame_color_override(&mut self, _error_text: Option<String>)

source

fn clear_pane_frame_color_override(&mut self)

source

fn frame_color_override(&self) -> Option<PaletteColor>

source

fn invoked_with(&self) -> &Option<Run>

source

fn set_title(&mut self, title: String)

source

fn current_title(&self) -> String

source

fn custom_title(&self) -> Option<String>

Provided Methods§

source

fn handle_pty_bytes(&mut self, _bytes: Vec<u8>)

source

fn handle_plugin_bytes(&mut self, _client_id: ClientId, _bytes: Vec<u8>)

source

fn adjust_input_to_terminal( &mut self, _input_bytes: Vec<u8> ) -> Option<AdjustedInput>

source

fn set_should_render_boundaries(&mut self, _should_render: bool)

source

fn request_permissions_from_user( &mut self, _permissions: Option<PluginPermission> )

source

fn dump_screen(&mut self, _client_id: ClientId, _full: bool) -> String

source

fn cursor_shape_csi(&self) -> String

source

fn contains(&self, position: &Position) -> bool

source

fn start_selection(&mut self, _start: &Position, _client_id: ClientId)

source

fn update_selection(&mut self, _position: &Position, _client_id: ClientId)

source

fn end_selection(&mut self, _end: &Position, _client_id: ClientId)

source

fn reset_selection(&mut self)

source

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

source

fn right_boundary_x_coords(&self) -> usize

source

fn bottom_boundary_y_coords(&self) -> usize

source

fn is_right_of(&self, other: &dyn Pane) -> bool

source

fn is_directly_right_of(&self, other: &dyn Pane) -> bool

source

fn is_left_of(&self, other: &dyn Pane) -> bool

source

fn is_directly_left_of(&self, other: &dyn Pane) -> bool

source

fn is_below(&self, other: &dyn Pane) -> bool

source

fn is_directly_below(&self, other: &dyn Pane) -> bool

source

fn is_above(&self, other: &dyn Pane) -> bool

source

fn is_directly_above(&self, other: &dyn Pane) -> bool

source

fn horizontally_overlaps_with(&self, other: &dyn Pane) -> bool

source

fn get_horizontal_overlap_with(&self, other: &dyn Pane) -> usize

source

fn vertically_overlaps_with(&self, other: &dyn Pane) -> bool

source

fn get_vertical_overlap_with(&self, other: &dyn Pane) -> usize

source

fn can_reduce_height_by(&self, reduce_by: usize) -> bool

source

fn can_reduce_width_by(&self, reduce_by: usize) -> bool

source

fn min_width(&self) -> usize

source

fn min_height(&self) -> usize

source

fn drain_messages_to_pty(&mut self) -> Vec<Vec<u8>>

source

fn drain_clipboard_update(&mut self) -> Option<String>

source

fn render_full_viewport(&mut self)

source

fn relative_position(&self, position_on_screen: &Position) -> Position

source

fn position_is_on_frame(&self, position: &Position) -> bool

source

fn handle_right_click(&mut self, _to: &Position, _client_id: ClientId)

source

fn mouse_left_click( &self, _position: &Position, _is_held: bool ) -> Option<String>

source

fn mouse_left_click_release(&self, _position: &Position) -> Option<String>

source

fn mouse_right_click( &self, _position: &Position, _is_held: bool ) -> Option<String>

source

fn mouse_right_click_release(&self, _position: &Position) -> Option<String>

source

fn mouse_middle_click( &self, _position: &Position, _is_held: bool ) -> Option<String>

source

fn mouse_middle_click_release(&self, _position: &Position) -> Option<String>

source

fn mouse_scroll_up(&self, _position: &Position) -> Option<String>

source

fn mouse_scroll_down(&self, _position: &Position) -> Option<String>

source

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

source

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

source

fn get_line_number(&self) -> Option<usize>

source

fn update_search_term(&mut self, _needle: &str)

source

fn search_down(&mut self)

source

fn search_up(&mut self)

source

fn toggle_search_case_sensitivity(&mut self)

source

fn toggle_search_whole_words(&mut self)

source

fn toggle_search_wrap(&mut self)

source

fn is_alternate_mode_active(&self) -> bool

source

fn hold( &mut self, _exit_status: Option<i32>, _is_first_run: bool, _run_command: RunCommand )

source

fn update_loading_indication(&mut self, _loading_indication: LoadingIndication)

source

fn start_loading_indication(&mut self, _loading_indication: LoadingIndication)

source

fn progress_animation_offset(&mut self)

source

fn is_held(&self) -> bool

source

fn exited(&self) -> bool

source

fn exit_status(&self) -> Option<i32>

source

fn rename(&mut self, _buf: Vec<u8>)

source

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

Implementors§