Skip to main content

SpanStyle

Struct SpanStyle 

Source
pub struct SpanStyle {
Show 18 fields pub color: Option<Color>, pub brush: Option<Brush>, pub alpha: Option<f32>, pub font_size: TextUnit, pub font_weight: Option<FontWeight>, pub font_style: Option<FontStyle>, pub font_synthesis: Option<FontSynthesis>, pub font_family: Option<FontFamily>, pub font_feature_settings: Option<Arc<str>>, pub letter_spacing: TextUnit, pub baseline_shift: Option<BaselineShift>, pub text_geometric_transform: Option<TextGeometricTransform>, pub locale_list: Option<LocaleList>, pub background: Option<Color>, pub text_decoration: Option<TextDecoration>, pub shadow: Option<Shadow>, pub platform_style: Option<PlatformSpanStyle>, pub draw_style: Option<TextDrawStyle>,
}
Expand description

Style of a span of characters: color, font, spacing and decoration. Compose’s SpanStyle. A field left unset (None or Unspecified) keeps the inherited value when styles merge.

Fields§

§color: Option<Color>

Text color.

§brush: Option<Brush>

Brush that paints the glyphs, for example a gradient. Merging a style that sets color clears an inherited brush, and the reverse.

§alpha: Option<f32>

Opacity from 0.0 to 1.0, multiplied into the color or brush. None leaves it unchanged.

§font_size: TextUnit

Font size in Sp or as a multiple of the default size with Em.

§font_weight: Option<FontWeight>

Weight of the font.

§font_style: Option<FontStyle>

Upright or italic glyphs.

§font_synthesis: Option<FontSynthesis>

Which missing bold or italic faces may be faked. None allows both.

§font_family: Option<FontFamily>

Font family.

§font_feature_settings: Option<Arc<str>>

OpenType feature settings in CSS font-feature-settings syntax, such as smcp, liga 0.

§letter_spacing: TextUnit

Extra space added after each character, in Sp or as a multiple of the font size.

§baseline_shift: Option<BaselineShift>

Vertical shift of the glyphs from the baseline.

§text_geometric_transform: Option<TextGeometricTransform>

Horizontal scale and skew of the glyphs. Text rendering does not apply it yet.

§locale_list: Option<LocaleList>

Languages of the text, which select language-specific glyph forms and hyphenation rules.

§background: Option<Color>

Color drawn behind the glyphs.

§text_decoration: Option<TextDecoration>

Underline and line through.

§shadow: Option<Shadow>

Shadow drawn behind the glyphs.

§platform_style: Option<PlatformSpanStyle>

Platform-specific settings.

§draw_style: Option<TextDrawStyle>

Fill or stroke. None fills the glyphs.

Implementations§

Source§

impl SpanStyle

Source

pub fn merge(&self, other: &SpanStyle) -> SpanStyle

Returns a style where each field set in other replaces the one in self. Fields unset in other keep the value of self.

Source

pub fn plus(&self, other: &SpanStyle) -> SpanStyle

Same as SpanStyle::merge. Compose’s SpanStyle.plus.

Source

pub fn resolve_font_size(&self, default_size: f32) -> f32

Returns the font size in sp. An Sp size is used as is, an Em size multiplies default_size, and an unspecified, non-positive or non-finite size gives default_size. A default_size that is not positive and finite counts as 14.0.

Source

pub fn resolve_foreground_color(&self, default_color: Color) -> Color

Returns color, else the color of a solid brush, else default_color, with alpha multiplied into the result’s alpha channel.

Source

pub fn render_hash(&self) -> u64

Hash of every field that changes how the text looks, as renderers use it to key caches.

Trait Implementations§

Source§

impl Clone for SpanStyle

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SpanStyle

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SpanStyle

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for SpanStyle

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for SpanStyle

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> AnyEq for T
where T: Any + PartialEq,

Source§

fn equals(&self, other: &(dyn Any + 'static)) -> bool

Source§

fn as_any(&self) -> &(dyn Any + 'static)

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

Source§

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

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> LayoutData for T
where T: Any + Debug + PartialEq,

Source§

fn same_as(&self, other: &(dyn LayoutData + 'static)) -> bool

Whether other holds the same data, so a parent can keep its last measure.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

The data as Any, to read it by its type.
Source§

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

Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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.