Struct druid::text::RichText

pub struct RichText { /* private fields */ }

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)

pub fn main() {
    // describe the main window
    let main_window = WindowDesc::new(build_root_widget())
        .title(WINDOW_TITLE)
        .window_size((400.0, 600.0));

    let text = RichText::new(TEXT.into())
        .with_attribute(0..9, Attribute::text_color(Color::rgb(1.0, 0.2, 0.1)))
        .with_attribute(0..9, Attribute::size(24.0))
        .with_attribute(0..9, Attribute::font_family(FontFamily::SERIF))
        .with_attribute(194..239, Attribute::weight(FontWeight::BOLD))
        .with_attribute(764.., Attribute::size(12.0))
        .with_attribute(764.., Attribute::style(FontStyle::Italic));

    // create the initial app state
    let initial_state = AppState {
        line_break_mode: LineBreaking::Clip,
        alignment: Default::default(),
        text,
    };

    // start the application
    AppLauncher::with_window(main_window)
        .log_to_console()
        .launch(initial_state)
        .expect("Failed to launch application");
}

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)

pub fn main() {
    // describe the main window
    let main_window = WindowDesc::new(build_root_widget())
        .title(WINDOW_TITLE)
        .window_size((400.0, 600.0));

    let text = RichText::new(TEXT.into())
        .with_attribute(0..9, Attribute::text_color(Color::rgb(1.0, 0.2, 0.1)))
        .with_attribute(0..9, Attribute::size(24.0))
        .with_attribute(0..9, Attribute::font_family(FontFamily::SERIF))
        .with_attribute(194..239, Attribute::weight(FontWeight::BOLD))
        .with_attribute(764.., Attribute::size(12.0))
        .with_attribute(764.., Attribute::style(FontStyle::Italic));

    // create the initial app state
    let initial_state = AppState {
        line_break_mode: LineBreaking::Clip,
        alignment: Default::default(),
        text,
    };

    // start the application
    AppLauncher::with_window(main_window)
        .log_to_console()
        .launch(initial_state)
        .expect("Failed to launch application");
}

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 copy of the value.

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

Performs copy-assignment from source.

impl Data for RichText

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

Determine whether two values are the same.

impl Debug for RichText

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

Formats the value using the given formatter.

impl TextStorage for RichText

fn as_str(&self) -> &str

Return the underlying text as a contiguous buffer.

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.