Struct CompositionCursor 

#[repr(C)]
pub struct CompositionCursor {
    pub begin: usize,
    pub end: usize,
}

Type-specific event data for text-input (editing) events.

Data carried by EventType::RawMouseMotion.

Raw motion is what a 3D viewport, a map orbit, an infinite-drag number scrubber and a first-person camera all need, and it is NOT the difference between two cursor positions. Absolute positions have already had the OS pointer-acceleration curve applied and are clamped to the screen, so differencing them gives accelerated motion that stops dead at the edge of the display. These deltas are pre-acceleration and unbounded. Where the caret sits INSIDE an open IME preedit.

Both offsets are into the preedit string, not into the document: the preedit is not committed text and has no position in the document until it is. An IME uses this to place its candidate window under the segment being edited, and a begin != end pair is a SELECTED segment - several IMEs (Japanese conversion especially) move a highlighted region through the preedit as the user cycles candidates.

A named struct rather than the (usize, usize) this used to be, because a non-empty tuple has no C representation - so the accessor could not be exposed at all and no binding could read an IME’s caret.

Fields

begin: usize

Start offset in the preedit, in bytes.

end: usize

End offset. Equal to begin for a caret with no selected segment.

Trait Implementations

impl Clone for CompositionCursor

fn clone(&self) -> CompositionCursor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CompositionCursor

impl Debug for CompositionCursor

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

Formats the value using the given formatter.

impl Default for CompositionCursor

fn default() -> CompositionCursor

Returns the “default value” for a type.

impl Eq for CompositionCursor

impl Hash for CompositionCursor

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for CompositionCursor

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

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for CompositionCursor

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for CompositionCursor

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl StructuralPartialEq for CompositionCursor