Struct modalkit::editing::cursor::CursorGroup

pub struct CursorGroup {
    pub members: Vec<CursorState>,
    pub leader: CursorState,
}

A group of cursors, where one of them has on-screen focus.

Fields

members: Vec<CursorState>

The members of the cursor group which do not have have on-screen focus.

leader: CursorState

The main cursor, which has on-screen focus.

Implementations

impl CursorGroup

pub fn new(leader: CursorState, members: Vec<CursorState>) -> Self

Create a new CursorGroup with the given leader and followers.

pub fn sort(&mut self)

Ensure that the member cursor states are sorted by their cursors.

pub fn iter_mut(&mut self) -> CursorGroupIterMut<'_>

Iterate over mutable references to the CursorState values in this group, in cursor order.

pub fn iter(&self) -> CursorGroupIter<'_>

Iterate over references to the CursorState values in this group, in cursor order.

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

Clone each cursor in the group n times.

pub fn close(&mut self, target: &CursorCloseTarget)

Close some of the cursors in this cursor group.

pub fn rotate(&mut self, dir: MoveDir1D, offset: usize)

Rotate the cursor leader forwards or backwards n times.

pub fn combine( &self, other: &Self, style: &CursorGroupCombineStyle, rope: &EditRope ) -> Result<Self, CursorGroupCombineError>

Combine this cursor group with another.

pub fn merge(&mut self)

Merge any overlapping selections.

Trait Implementations

impl Adjustable for CursorGroup

fn zero(&mut self)

Zero out the line and column of any contained cursors.

fn adjust(&mut self, adjs: &[CursorAdjustment])

Apply a CursorAdjustment to any applicable cursors.

impl Clone for CursorGroup

fn clone(&self) -> CursorGroup

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CursorGroup

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

Formats the value using the given formatter.

impl Default for CursorGroup

fn default() -> CursorGroup

Returns the “default value” for a type.

impl PartialEq for CursorGroup

fn eq(&self, other: &CursorGroup) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for CursorGroup

impl StructuralPartialEq for CursorGroup