Skip to main content

TextGeometry

Struct TextGeometry 

Source
pub struct TextGeometry<'a> { /* private fields */ }
Expand description

Shared text geometry context for measurement, hit-testing, caret positioning, and selection rectangles.

This is intentionally a thin value over the existing cosmic-text-backed helpers: callers spell the text/style/wrap inputs once, then ask the same context for the geometry operation they need. Keeping these calls together matters for widgets like text_input, text_area, and selectable text, where measurement, hit-testing, caret placement, and selection bands must agree on font, wrap width, and line metrics.

Implementations§

Source§

impl<'a> TextGeometry<'a>

Source

pub fn new( text: &'a str, size: f32, weight: FontWeight, mono: bool, wrap: TextWrap, available_width: Option<f32>, ) -> Self

Source

pub fn new_with_family( text: &'a str, size: f32, family: FontFamily, weight: FontWeight, mono: bool, wrap: TextWrap, available_width: Option<f32>, ) -> Self

Source

pub fn text(&self) -> &'a str

Source

pub fn layout(&self) -> &TextLayout

Source

pub fn measured(&self) -> MeasuredText

Source

pub fn line_height(&self) -> f32

Source

pub fn width(&self) -> f32

Source

pub fn height(&self) -> f32

Source

pub fn hit(&self, x: f32, y: f32) -> Option<TextHit>

Source

pub fn hit_byte(&self, x: f32, y: f32) -> Option<usize>

Hit-test and convert the result to a global byte offset in self.text. This is the shape most widgets want; cosmic-text’s cursor reports (line, byte-in-line) and hard line breaks need to be folded back into the original string.

Source

pub fn caret_xy(&self, byte_index: usize) -> (f32, f32)

Source

pub fn prefix_width(&self, byte_index: usize) -> f32

X position of the caret at byte_index. For single-line text this replaces ad-hoc substring measurement and preserves shaping/kerning decisions made by the text engine.

Source

pub fn selection_rects(&self, lo: usize, hi: usize) -> Vec<(f32, f32, f32, f32)>

Trait Implementations§

Source§

impl<'a> Clone for TextGeometry<'a>

Source§

fn clone(&self) -> TextGeometry<'a>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for TextGeometry<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a> PartialEq for TextGeometry<'a>

Source§

fn eq(&self, other: &TextGeometry<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl<'a> StructuralPartialEq for TextGeometry<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for TextGeometry<'a>

§

impl<'a> RefUnwindSafe for TextGeometry<'a>

§

impl<'a> Send for TextGeometry<'a>

§

impl<'a> Sync for TextGeometry<'a>

§

impl<'a> Unpin for TextGeometry<'a>

§

impl<'a> UnsafeUnpin for TextGeometry<'a>

§

impl<'a> UnwindSafe for TextGeometry<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,