Skip to main content

TextLayoutState

Struct TextLayoutState 

Source
pub struct TextLayoutState { /* private fields */ }
Expand description

Shared text layout state used by text-based views.

This type owns the base layout plus any derived overflow layout used for wrapping, alignment, or ellipsis handling. It is intended to be shared by text-oriented views such as labels, rich text, and text inputs.

Implementations§

Source§

impl TextLayoutState

Source

pub fn new(view_id: Option<ViewId>) -> Self

Creates empty shared text-layout state.

Source

pub fn set_text( &mut self, text: &str, attrs_list: AttrsList, text_align: Option<Alignment>, )

Replaces the base text, attributes, and alignment for this state.

Source

pub fn set_text_overflow(&mut self, text_overflow: TextOverflow)

Sets the overflow behavior used when finalizing constrained layouts.

Source

pub fn text(&self) -> Option<&str>

Returns the current base text, if any.

Source

pub fn get_effective_text_layout(&self) -> Option<&TextLayout>

Returns the layout that should currently be painted.

This prefers a derived overflow/alignment layout when one is active.

Source

pub fn with_effective_text_layout<O>( &self, with: impl FnOnce(&TextLayout) -> O, ) -> O

Runs with on the effective layout, falling back to an empty layout.

Source

pub fn selection_rects_for_selection( &self, selection: &TextSelection, text_origin: Point, f: impl FnMut(Rect), )

Iterates selection rectangles for a Parley selection in view coordinates.

Source

pub fn selection_rects_for_byte_range( &self, start: usize, end: usize, text_origin: Point, f: impl FnMut(Rect), )

Iterates selection rectangles for a byte range in view coordinates.

Source

pub fn centered_text_origin(&self, content_rect: Rect) -> Point

Returns the origin that vertically centers the effective layout in content_rect.

Source

pub fn clear_overflow_state(&mut self)

Clears any cached derived overflow/alignment layout.

Source

pub fn get_text_layout(&self) -> Option<&TextLayout>

Returns the base text layout before overflow-specific derivation.

Source

pub fn compute_overflow_size( &mut self, width_constraint: Option<f32>, text_overflow: TextOverflow, ) -> Size

Computes the size the text would occupy under the given width constraint.

This does not mutate the currently visible effective layout.

Source

pub fn finalize_for_width(&mut self, final_width: f32)

Finalizes the effective layout for the given width.

This updates the cached derived layout used for painting and emits a TextOverflowChanged event when the overflowing state changes.

Source

pub fn create_taffy_layout_fn( layout_data: Rc<RefCell<Self>>, ) -> Box<dyn FnMut(Size<Option<f32>>, Size<AvailableSpace>, NodeId, &Style, &mut MeasureCx) -> Size<f32>>

Creates a Taffy measure function backed by this shared text-layout state.

Source

pub fn create_finalize_fn( layout_data: Rc<RefCell<Self>>, ) -> Box<dyn Fn(NodeId, &Layout)>

Creates a Taffy finalize function backed by this shared text-layout state.

Trait Implementations§

Source§

impl Clone for TextLayoutState

Source§

fn clone(&self) -> TextLayoutState

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

Auto Trait Implementations§

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
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more