Struct TextStyle 

pub struct TextStyle {

    pub color: Hsla,
    pub font_family: SharedString,
    pub font_features: FontFeatures,
    pub font_fallbacks: Option<FontFallbacks>,
    pub font_size: AbsoluteLength,
    pub line_height: DefiniteLength,
    pub font_weight: FontWeight,
    pub font_style: FontStyle,
    pub background_color: Option<Hsla>,
    pub underline: Option<UnderlineStyle>,
    pub strikethrough: Option<StrikethroughStyle>,
    pub white_space: WhiteSpace,
    pub text_overflow: Option<TextOverflow>,
    pub text_align: TextAlign,
    pub line_clamp: Option<usize>,
    pub letter_spacing: Option<Pixels>,
    pub text_transform: Option<TextTransform>,
}

The properties that can be used to style text in GPUI

Fields

color: Hsla

The color of the text

font_family: SharedString

The font family to use

font_features: FontFeatures

The font features to use

font_fallbacks: Option<FontFallbacks>

The fallback fonts to use

font_size: AbsoluteLength

The font size to use, in pixels or rems.

line_height: DefiniteLength

The line height to use, in pixels or fractions

font_weight: FontWeight

The font weight, e.g. bold

font_style: FontStyle

The font style, e.g. italic

background_color: Option<Hsla>

The background color of the text

underline: Option<UnderlineStyle>

The underline style of the text

strikethrough: Option<StrikethroughStyle>

The strikethrough style of the text

white_space: WhiteSpace

How to handle whitespace in the text

text_overflow: Option<TextOverflow>

The text should be truncated if it overflows the width of the element

text_align: TextAlign

How the text should be aligned within the element

line_clamp: Option<usize>

The number of lines to display before truncating the text

letter_spacing: Option<Pixels>

Letter spacing added between characters, in pixels (positive widens, negative tightens).

The platform text stack may clamp values outside the range it supports.

text_transform: Option<TextTransform>

Case transformation applied at layout time.

Implementations

impl TextStyle

pub fn highlight(self, style: impl Into<HighlightStyle>) -> Self

Create a new text style with the given highlighting applied.

pub fn font(&self) -> Font

Get the font configured for this text style.

pub fn line_height_in_pixels(&self, rem_size: Pixels) -> Pixels

Returns the rounded line height in pixels.

pub fn to_run(&self, len: usize) -> TextRun

Convert this text style into a TextRun, for the given length of the text.

Trait Implementations

impl Clone for TextStyle

fn clone(&self) -> TextStyle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextStyle

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

Formats the value using the given formatter.

impl Default for TextStyle

fn default() -> Self

Returns the “default value” for a type.

impl From<&TextStyle> for HighlightStyle

fn from(other: &TextStyle) -> Self

Converts to this type from the input type.

impl From<TextStyle> for HighlightStyle

fn from(other: TextStyle) -> Self

Converts to this type from the input type.

impl From<TextStyleRefinement> for TextStyle

where Option<Hsla>: Clone, Option<SharedString>: Clone, Option<FontFeatures>: Clone, Option<FontFallbacks>: Clone, Option<AbsoluteLength>: Clone, Option<DefiniteLength>: Clone, Option<FontWeight>: Clone, Option<FontStyle>: Clone, Option<UnderlineStyle>: Clone, Option<StrikethroughStyle>: Clone, Option<WhiteSpace>: Clone, Option<TextOverflow>: Clone, Option<TextAlign>: Clone, Option<usize>: Clone, Option<Pixels>: Clone, Option<TextTransform>: Clone,

fn from(value: TextStyleRefinement) -> Self

Converts to this type from the input type.

impl PartialEq for TextStyle

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

Equality operator ==.

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

Inequality operator !=.

impl Refineable for TextStyle

where Option<Hsla>: Clone, Option<SharedString>: Clone, Option<FontFeatures>: Clone, Option<FontFallbacks>: Clone, Option<AbsoluteLength>: Clone, Option<DefiniteLength>: Clone, Option<FontWeight>: Clone, Option<FontStyle>: Clone, Option<UnderlineStyle>: Clone, Option<StrikethroughStyle>: Clone, Option<WhiteSpace>: Clone, Option<TextOverflow>: Clone, Option<TextAlign>: Clone, Option<usize>: Clone, Option<Pixels>: Clone, Option<TextTransform>: Clone,

type Refinement = TextStyleRefinement

fn refine(&mut self, refinement: &Self::Refinement)

Applies the given refinement to this instance, modifying it in place.

fn refined(self, refinement: Self::Refinement) -> Self

Returns a new instance with the refinement applied, equivalent to cloning self and calling refine on it.

fn is_superset_of(&self, refinement: &Self::Refinement) -> bool

Returns true if this instance would contain all values from the refinement.

fn subtract(&self, refinement: &Self::Refinement) -> Self::Refinement

Returns a refinement that represents the difference between this instance and the given refinement.

fn from_cascade(cascade: &Cascade<Self>) -> Self

where Self: Sized + Default,

Creates an instance from a cascade by merging all refinements atop the default value.

impl StructuralPartialEq for TextStyle