Struct Cursor 

pub struct Cursor { /* private fields */ }

Defines a position with a text layout.

Implementations

impl Cursor

pub fn from_byte_index<B>( layout: &Layout<B>, index: usize, affinity: Affinity, ) -> Cursor

where B: Brush,

Creates a new cursor from the given byte index and affinity.

pub fn from_point<B>(layout: &Layout<B>, x: f32, y: f32) -> Cursor

where B: Brush,

Creates a new cursor from the given coordinates.

pub fn index(&self) -> usize

Returns the logical text index of the cursor.

pub fn affinity(&self) -> Affinity

Returns the affinity of the cursor.

This defines the direction from which the cursor entered its current position and affects the visual location of the rendered cursor.

pub fn refresh<B>(&self, layout: &Layout<B>) -> Cursor

where B: Brush,

Returns a new cursor that is guaranteed to be within the bounds of the given layout.

pub fn previous_visual<B>(&self, layout: &Layout<B>) -> Cursor

where B: Brush,

Returns a new cursor that is positioned at the previous cluster boundary in visual order.

pub fn next_visual<B>(&self, layout: &Layout<B>) -> Cursor

where B: Brush,

Returns a new cursor that is positioned at the next cluster boundary in visual order.

pub fn next_visual_word<B>(&self, layout: &Layout<B>) -> Cursor

where B: Brush,

Returns a new cursor that is positioned at the next word boundary in visual order.

pub fn previous_visual_word<B>(&self, layout: &Layout<B>) -> Cursor

where B: Brush,

Returns a new cursor that is positioned at the previous word boundary in visual order.

pub fn next_logical_word<B>(&self, layout: &Layout<B>) -> Cursor

where B: Brush,

Returns a new cursor that is positioned at the next word boundary in logical order.

pub fn previous_logical_word<B>(&self, layout: &Layout<B>) -> Cursor

where B: Brush,

Returns a new cursor that is positioned at the previous word boundary in logical order.

pub fn geometry<B>(&self, layout: &Layout<B>, width: f32) -> BoundingBox

where B: Brush,

Returns a rectangle that represents the visual geometry of the cursor in layout space.

The width parameter defines the width of the resulting rectangle.

pub fn logical_clusters<'a, B>( &self, layout: &'a Layout<B>, ) -> [Option<Cluster<'a, B>>; 2]

where B: Brush,

Returns the pair of clusters that logically bound the cursor position.

The order in the array is upstream followed by downstream.

pub fn visual_clusters<'a, B>( &self, layout: &'a Layout<B>, ) -> [Option<Cluster<'a, B>>; 2]

where B: Brush,

Returns the pair of clusters that visually bound the cursor position.

The order in the array is left followed by right.

Trait Implementations

impl Clone for Cursor

fn clone(&self) -> Cursor

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

impl Default for Cursor

fn default() -> Cursor

Returns the “default value” for a type.

impl From<Cursor> for Selection

fn from(value: Cursor) -> Selection

Converts to this type from the input type.

impl PartialEq for Cursor

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for Cursor

impl Eq for Cursor

impl StructuralPartialEq for Cursor