Skip to main content

CursorState

Struct CursorState 

Source
pub struct CursorState {
    pub position: CursorPosition,
    pub selection: Option<Selection>,
    pub preferred_col: Option<usize>,
}
Expand description

The full cursor state for a text editing session.

Tracks the cursor position, optional selection, and the preferred column for vertical movement (so moving up/down through short lines returns to the original column).

Fields§

§position: CursorPosition

Current cursor position.

§selection: Option<Selection>

Active selection, if any.

§preferred_col: Option<usize>

Preferred column for vertical movement.

Implementations§

Source§

impl CursorState

Source

pub fn new(line: usize, col: usize) -> Self

Create a new cursor state at the given position.

Source

pub fn move_left(&mut self, buffer: &TextBuffer)

Move cursor left by one character, wrapping to the previous line.

Source

pub fn move_right(&mut self, buffer: &TextBuffer)

Move cursor right by one character, wrapping to the next line.

Source

pub fn move_up(&mut self, buffer: &TextBuffer)

Move cursor up by one line, preserving the preferred column.

Source

pub fn move_down(&mut self, buffer: &TextBuffer)

Move cursor down by one line, preserving the preferred column.

Source

pub fn move_to_line_start(&mut self)

Move cursor to the start of the current line.

Source

pub fn move_to_line_end(&mut self, buffer: &TextBuffer)

Move cursor to the end of the current line.

Source

pub fn move_to_buffer_start(&mut self)

Move cursor to the beginning of the buffer.

Source

pub fn move_to_buffer_end(&mut self, buffer: &TextBuffer)

Move cursor to the end of the buffer.

Source

pub fn start_selection(&mut self)

Start a selection at the current cursor position.

Source

pub fn extend_selection(&mut self)

Extend the selection to the current cursor position.

If no selection exists, this starts one from the current position.

Source

pub fn clear_selection(&mut self)

Clear the current selection.

Source

pub fn selected_text(&self, buffer: &TextBuffer) -> Option<String>

Get the text currently selected in the buffer.

Returns None if there is no selection or the selection is empty.

Trait Implementations§

Source§

impl Clone for CursorState

Source§

fn clone(&self) -> CursorState

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CursorState

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.