Struct floem_cosmic_text::TextLayoutLine

source ·
pub struct TextLayoutLine { /* private fields */ }
Expand description

A line (or paragraph) of text that is shaped and laid out

Implementations§

source§

impl TextLayoutLine

source

pub fn new<T: Into<String>>( text: T, attrs_list: AttrsList, start_index: usize, tab_width: usize ) -> Self

Create a new line with the given text and attributes list Cached shaping and layout can be done using the Self::shape and Self::layout functions

source

pub fn text(&self) -> &str

Get current text

source

pub fn set_text<T: AsRef<str> + Into<String>>( &mut self, text: T, attrs_list: AttrsList ) -> bool

Set text and attributes list

Will reset shape and layout if it differs from current text and attributes list. Returns true if the line was reset

source

pub fn into_text(self) -> String

Consume this line, returning only its text contents as a String.

source

pub fn attrs_list(&self) -> &AttrsList

Get attributes list

source

pub fn set_attrs_list(&mut self, attrs_list: AttrsList) -> bool

Set attributes list

Will reset shape and layout if it differs from current attributes list. Returns true if the line was reset

source

pub fn wrap(&self) -> Wrap

Get wrapping setting (wrap by characters/words or no wrapping)

source

pub fn set_wrap(&mut self, wrap: Wrap) -> bool

Set wrapping setting (wrap by characters/words or no wrapping)

Will reset shape and layout if it differs from current wrapping setting. Returns true if the line was reset

source

pub fn align(&self) -> Option<Align>

Get the Text alignment

source

pub fn set_align(&mut self, align: Option<Align>) -> bool

Set the text alignment

Will reset shape and layout if it differs from current alignment. Setting to None will use Align::Right for RTL lines, and Align::Left for LTR lines. Returns true if the line was reset

source

pub fn start_index(&self) -> usize

The start index in the original overarching line.

source

pub fn append(&mut self, other: Self)

Append line at end of this line

The wrap setting of the appended line will be lost

source

pub fn split_off(&mut self, index: usize) -> Self

Split off new line at index

source

pub fn reset(&mut self)

Reset shaping and layout information

source

pub fn reset_layout(&mut self)

Reset only layout information

source

pub fn is_reset(&self) -> bool

Check if shaping and layout information is cleared

source

pub fn shape(&mut self) -> &ShapeLine

Shape line, will cache results

source

pub fn shape_opt(&self) -> &Option<ShapeLine>

Get line shaping cache

source

pub fn layout(&mut self, width: f32, wrap: Wrap) -> &[LayoutLine]

Layout line, will cache results

source

pub fn layout_opt(&self) -> &Option<Vec<LayoutLine>>

Get line layout cache

Trait Implementations§

source§

impl Clone for TextLayoutLine

source§

fn clone(&self) -> TextLayoutLine

Returns a copy of the value. Read more
1.0.0 · 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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

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

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

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> ToOwned for T
where T: Clone,

§

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>,

§

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>,

§

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<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

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
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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