RichText

Struct RichText

pub struct RichText { /* private fields */ }

Expand description

Text with optional style spans.

Implementations§

impl RichText

pub fn new(buffer: ArcStr) -> Self

Create a new RichText object with the provided text.

Examples found in repository ?

examples/text.rs (line 89)

83pub fn main() {
84    // describe the main window
85    let main_window = WindowDesc::new(build_root_widget())
86        .title(WINDOW_TITLE)
87        .window_size((400.0, 600.0));
88
89    let text = RichText::new(TEXT.into())
90        .with_attribute(0..9, Attribute::text_color(Color::rgb(1.0, 0.2, 0.1)))
91        .with_attribute(0..9, Attribute::size(24.0))
92        .with_attribute(0..9, Attribute::font_family(FontFamily::SERIF))
93        .with_attribute(194..239, Attribute::weight(FontWeight::BOLD))
94        .with_attribute(764.., Attribute::size(12.0))
95        .with_attribute(764.., Attribute::style(FontStyle::Italic));
96
97    // create the initial app state
98    let initial_state = AppState {
99        line_break_mode: LineBreaking::Clip,
100        alignment: Default::default(),
101        text,
102    };
103
104    // start the application
105    AppLauncher::with_window(main_window)
106        .log_to_console()
107        .launch(initial_state)
108        .expect("Failed to launch application");
109}

pub fn new_with_attributes(buffer: ArcStr, attributes: AttributeSpans) -> Self

Create a new RichText, providing explicit attributes.

pub fn with_attribute( self, range: impl RangeBounds<usize>, attr: Attribute, ) -> Self

Builder-style method for adding an Attribute to a range of text.

Examples found in repository ?

examples/text.rs (line 90)

83pub fn main() {
84    // describe the main window
85    let main_window = WindowDesc::new(build_root_widget())
86        .title(WINDOW_TITLE)
87        .window_size((400.0, 600.0));
88
89    let text = RichText::new(TEXT.into())
90        .with_attribute(0..9, Attribute::text_color(Color::rgb(1.0, 0.2, 0.1)))
91        .with_attribute(0..9, Attribute::size(24.0))
92        .with_attribute(0..9, Attribute::font_family(FontFamily::SERIF))
93        .with_attribute(194..239, Attribute::weight(FontWeight::BOLD))
94        .with_attribute(764.., Attribute::size(12.0))
95        .with_attribute(764.., Attribute::style(FontStyle::Italic));
96
97    // create the initial app state
98    let initial_state = AppState {
99        line_break_mode: LineBreaking::Clip,
100        alignment: Default::default(),
101        text,
102    };
103
104    // start the application
105    AppLauncher::with_window(main_window)
106        .log_to_console()
107        .launch(initial_state)
108        .expect("Failed to launch application");
109}

pub fn len(&self) -> usize

The length of the buffer, in utf8 code units.

pub fn is_empty(&self) -> bool

Returns true if the underlying buffer is empty.

pub fn add_attribute(&mut self, range: impl RangeBounds<usize>, attr: Attribute)

Add an Attribute to the provided range of text.

Trait Implementations§

impl Clone for RichText

fn clone(&self) -> RichText

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Data for RichText

fn same(&self, other: &Self) -> bool

Determine whether two values are the same. Read more

impl Debug for RichText

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

Formats the value using the given formatter. Read more

impl TextStorage for RichText

fn as_str(&self) -> &str

Return the underlying text as a contiguous buffer. Read more

impl TextStorage for RichText

fn add_attributes( &self, builder: PietTextLayoutBuilder, env: &Env, ) -> PietTextLayoutBuilder

If this TextStorage object manages style spans, it should implement this method and update the provided builder with its spans, as required.

fn env_update(&self, ctx: &EnvUpdateCtx<'_, '_>) -> bool

This is called whenever the Env changes and should return true if the layout should be rebuilt.

fn links(&self) -> &[Link]

Any additional Link attributes on this text. Read more

Auto Trait Implementations§

impl Freeze for RichText

impl !RefUnwindSafe for RichText

impl !Send for RichText

impl !Sync for RichText

impl Unpin for RichText

impl !UnwindSafe for RichText

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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> From<T> for T

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> RoundFrom<T> for T

fn round_from(x: T) -> T

Performs the conversion.

impl<T, U> RoundInto<U> for T
where U: RoundFrom<T>,

fn round_into(self) -> U

Performs the conversion.

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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.

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

Performs the conversion.

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