Struct cosmic_text::Cursor

pub struct Cursor {
    pub line: usize,
    pub index: usize,
    pub affinity: Affinity,
    pub color: Option<Color>,
}

Current cursor location

Fields

line: usize

Text line the cursor is on

index: usize

First-byte-index of glyph at cursor (will insert behind this glyph)

affinity: Affinity

Whether to associate the cursor with the run before it or the run after it if placed at the boundary between two runs

color: Option<Color>

Cursor color

Implementations

impl Cursor

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

Create a new cursor

pub const fn new_with_affinity( line: usize, index: usize, affinity: Affinity ) -> Self

Create a new cursor, specifying the affinity

pub const fn new_with_color(line: usize, index: usize, color: Color) -> Self

Create a new cursor, specifying the color

Trait Implementations

impl Clone for Cursor

fn clone(&self) -> Cursor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cursor

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

Formats the value using the given formatter.

impl Default for Cursor

fn default() -> Cursor

Returns the “default value” for a type.

impl Ord for Cursor

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Cursor

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

fn partial_cmp(&self, other: &Cursor) -> 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 Copy for Cursor

impl Eq for Cursor

impl StructuralEq for Cursor

impl StructuralPartialEq for Cursor