Struct CopyModeState 

pub struct CopyModeState {
    pub active: bool,
    pub cursor: CopyModeCursor,
    pub selection: Option<Selection>,
    pub selection_mode: SelectionMode,
    pub viewport_offset: i32,
}

Copy mode state tracking active mode, cursor, and selection

Fields

active: bool

Whether copy mode is currently active

cursor: CopyModeCursor

Current cursor position

selection: Option<Selection>

Active selection, if any

selection_mode: SelectionMode

Current selection mode

viewport_offset: i32

Viewport offset (lines scrolled from bottom)

Implementations

impl CopyModeState

pub fn new() -> Self

Create a new inactive copy mode state

pub fn activate(&mut self, cursor: CopyModeCursor)

Activate copy mode at the current cursor position

pub fn deactivate(&mut self)

Deactivate copy mode and clear selection

pub fn start_selection(&mut self, mode: SelectionMode)

Start a selection at the current cursor position

pub fn clear_selection(&mut self)

Clear the current selection

pub fn update_selection(&mut self)

Update the active end of the selection to the current cursor

pub fn toggle_selection(&mut self, mode: SelectionMode)

Toggle selection mode on/off

pub fn swap_selection_ends(&mut self)

Swap the anchor and active ends of the selection

pub fn move_left(&mut self)

Move cursor left, clamping at column 0

pub fn move_right(&mut self, max_cols: u16)

Move cursor right, clamping at max_cols

pub fn move_up(&mut self, min_y: i32)

Move cursor up, clamping at scrollback top

pub fn move_down(&mut self, max_y: i32)

Move cursor down, clamping at screen bottom

pub fn move_to_line_start(&mut self)

Move cursor to column 0 (start of line)

pub fn move_to_line_end(&mut self, line_length: u16)

Move cursor to end of line

pub fn move_to_top(&mut self, min_y: i32)

Move cursor to top of scrollback

pub fn move_to_bottom(&mut self, max_y: i32)

Move cursor to bottom of screen

pub fn toggle_cell_selection(&mut self)

Toggle cell selection mode

pub fn toggle_line_selection(&mut self)

Toggle line selection mode

pub fn toggle_block_selection(&mut self)

Toggle block selection mode

pub fn toggle_word_selection(&mut self)

Toggle word selection mode

pub fn get_selection_text<F>(&self, get_line: F) -> Option<String>

where F: Fn(i32) -> Option<String>,

Get the selected text using a callback to retrieve line content

The callback function should take a line number (y coordinate) and return the line content as a String, or None if the line doesn’t exist.

Trait Implementations

impl Clone for CopyModeState

fn clone(&self) -> CopyModeState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CopyModeState

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

Formats the value using the given formatter.

impl Default for CopyModeState

fn default() -> CopyModeState

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CopyModeState

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CopyModeState

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.