Struct RichText

pub struct RichText { /* private fields */ }

Text and optional style choices for it.

The style choices (font, color) are applied to the entire text. For more detailed control, use crate::text::LayoutJob instead.

A RichText can be used in most widgets and helper functions, e.g. Ui::label and Ui::button.

Example

use egui::{RichText, Color32};

RichText::new("Plain");
RichText::new("colored").color(Color32::RED);
RichText::new("Large and underlined").size(20.0).underline();

Implementations

impl RichText

pub fn new(text: impl Into<String>) -> RichText

pub fn is_empty(&self) -> bool

pub fn text(&self) -> &str

pub fn size(self, size: f32) -> RichText

Select the font size (in points). This overrides the value from Self::text_style.

pub fn extra_letter_spacing(self, extra_letter_spacing: f32) -> RichText

Extra spacing between letters, in points.

Default: 0.0.

For even text it is recommended you round this to an even number of pixels, e.g. using crate::Painter::round_to_pixel.

pub fn line_height(self, line_height: Option<f32>) -> RichText

Explicit line height of the text in points.

This is the distance between the bottom row of two subsequent lines of text.

If None (the default), the line height is determined by the font.

For even text it is recommended you round this to an even number of pixels, e.g. using crate::Painter::round_to_pixel.

pub fn family(self, family: FontFamily) -> RichText

Select the font family.

This overrides the value from Self::text_style.

Only the families available in crate::FontDefinitions::families may be used.

pub fn font(self, font_id: FontId) -> RichText

Select the font and size. This overrides the value from Self::text_style.

pub fn text_style(self, text_style: TextStyle) -> RichText

Override the TextStyle.

pub fn fallback_text_style(self, text_style: TextStyle) -> RichText

Set the TextStyle unless it has already been set

pub fn heading(self) -> RichText

Use TextStyle::Heading.

pub fn monospace(self) -> RichText

Use TextStyle::Monospace.

pub fn code(self) -> RichText

Monospace label with different background color.

pub fn strong(self) -> RichText

Extra strong text (stronger color).

pub fn weak(self) -> RichText

Extra weak text (fainter color).

pub fn underline(self) -> RichText

Draw a line under the text.

If you want to control the line color, use LayoutJob instead.

pub fn strikethrough(self) -> RichText

Draw a line through the text, crossing it out.

If you want to control the strikethrough line color, use LayoutJob instead.

pub fn italics(self) -> RichText

Tilt the characters to the right.

pub fn small(self) -> RichText

Smaller text.

pub fn small_raised(self) -> RichText

For e.g. exponents.

pub fn raised(self) -> RichText

Align text to top. Only applicable together with Self::small().

pub fn background_color(self, background_color: impl Into<Color32>) -> RichText

Fill-color behind the text.

pub fn color(self, color: impl Into<Color32>) -> RichText

Override text color.

pub fn font_height(&self, fonts: &Fonts, style: &Style) -> f32

Read the font height of the selected text style.

pub fn append_to( self, layout_job: &mut LayoutJob, style: &Style, fallback_font: FontSelection, default_valign: Align, )

Append to an existing LayoutJob

Note that the color of the RichText must be set, or may default to an undesirable color.

Example

use egui::{Style, RichText, text::LayoutJob, Color32, FontSelection, Align};

let style = Style::default();
let mut layout_job = LayoutJob::default();
RichText::new("Normal")
    .color(style.visuals.text_color())
    .append_to(
        &mut layout_job,
        &style,
        FontSelection::Default,
        Align::Center,
    );
RichText::new("Large and underlined")
    .color(style.visuals.text_color())
    .size(20.0)
    .underline()
    .append_to(
        &mut layout_job,
        &style,
        FontSelection::Default,
        Align::Center,
    );

Trait Implementations

impl Clone for RichText

fn clone(&self) -> RichText

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for RichText

fn default() -> RichText

Returns the “default value” for a type.

impl From<&String> for RichText

fn from(text: &String) -> RichText

Converts to this type from the input type.

impl From<&mut String> for RichText

fn from(text: &mut String) -> RichText

Converts to this type from the input type.

impl From<&str> for RichText

fn from(text: &str) -> RichText

Converts to this type from the input type.

impl From<Cow<'_, str>> for RichText

fn from(text: Cow<'_, str>) -> RichText

Converts to this type from the input type.

impl From<RichText> for WidgetText

fn from(rich_text: RichText) -> WidgetText

Converts to this type from the input type.

impl From<String> for RichText

fn from(text: String) -> RichText

Converts to this type from the input type.

impl PartialEq for RichText

fn eq(&self, other: &RichText) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for RichText