Enum modalkit::editing::cursor::CursorState

pub enum CursorState {
    Location(Cursor),
    Selection(Cursor, Cursor, TargetShape),
}

Current position and selection state for a member of a cursor group.

Variants

Location(Cursor)

Current position of a cursor.

Selection(Cursor, Cursor, TargetShape)

The current position of a cursor, and the anchor and shape of its selection.

Implementations

impl CursorState

pub fn anchor(&self) -> &Cursor

Get a reference to the anchor of a selection.

pub fn cursor(&self) -> &Cursor

Get a reference to the cursor.

pub fn shape(&self) -> TargetShape

Get the shape of the selection.

pub fn unselect(&mut self)

Convert this to a CursorState::Location if it isn’t already.

pub fn is_selection(&self) -> bool

Indicates if this is a CursorState::Selection.

pub fn set(&mut self, update: CursorState)

Set fields in this CursorState using those in another.

pub fn set_cursor(&mut self, new: Cursor)

Set the cursor.

pub fn set_anchor(&mut self, anchor: Cursor)

Set the anchor for the selection.

The value will be converted to a CursorState::Selection if needed.

pub fn set_shape(&mut self, shape: TargetShape)

Set the shape of the selection.

The value will be converted to a CursorState::Selection if needed.

pub fn sorted(&self) -> (Cursor, Cursor)

Return a sorted pair of the cursor and anchor.

pub fn swap(&mut self)

Swap the cursor and anchor.

pub fn to_selection(&self) -> Option<Selection>

If this is a CursorState::Selection, return it as a Selection.

pub fn to_triple(&self) -> (Cursor, Cursor, TargetShape)

Return a triple of cursor, anchor, and shape.

pub fn len(&self, rope: &EditRope) -> usize

The number of characters contained by the selection.

pub fn direction(&self) -> MoveDir1D

Indicates the direction of the cursor relatie to the anchor.

pub fn start(&self) -> &Cursor

Returns the cursor or the anchor, depending on which comes earlier in the text.

pub fn end(&self) -> &Cursor

Returns the cursor or the anchor, depending on which comes later in the text.

pub fn overlaps(&self, other: &Self) -> bool

Returns the intersection of this selection with another.

pub fn intersect(&self, other: &Self) -> Self

Returns the intersection of this selection with another.

pub fn union(&self, other: &Self) -> Self

Returns the union of this selection with another.

pub fn merge( &self, other: &Self, style: &CursorMergeStyle, rope: &EditRope ) -> Self

Merge this selection with another.

Trait Implementations

impl Adjustable for CursorState

fn zero(&mut self)

Zero out the line and column of any contained cursors.

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

Apply a CursorAdjustment to any applicable cursors.

impl Clone for CursorState

fn clone(&self) -> CursorState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CursorState

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

Formats the value using the given formatter.

impl Default for CursorState

fn default() -> Self

Returns the “default value” for a type.

impl From<Cursor> for CursorState

fn from(cursor: Cursor) -> Self

Converts to this type from the input type.

impl Ord for CursorState

fn cmp(&self, other: &CursorState) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for CursorState

fn eq(&self, other: &CursorState) -> 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 PartialOrd for CursorState

fn partial_cmp(&self, other: &CursorState) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for CursorState

impl StructuralPartialEq for CursorState