Struct TextStyle 

pub struct TextStyle {
    pub size: f32,
    pub line_height: f32,
    pub color: Option<Color>,
    pub family: FontFamily,
    pub wrap: TextWrap,
    pub max_lines: u32,
    pub ellipsis: bool,
    pub features: FontFeatures,
    pub underline: bool,
    pub underline_color: Option<Color>,
    pub underline_style: UnderlineStyle,
    pub strikethrough: bool,
}

Fields

size: f32

line_height: f32

color: Option<Color>

None is “the theme’s foreground” — which is what the schema has always said this row means (“default foreground when omitted”) and, since ADR 0019, what it does. Filled in as the text enters the tree, so nothing downstream of that ever sees a None.

family: FontFamily

wrap: TextWrap

max_lines: u32

At most this many lines are laid out; 0 = unlimited.

ellipsis: bool

End the last line with “…” when the text was cut off. Alone it means a single line (max_lines 1); with max_lines it clamps.

features: FontFeatures

OpenType features for the shaper; none by default, which is the font’s own defaults (ligatures on, where it has them).

underline: bool

A line under every glyph, where the face puts its underline (backlog C22). Paint only: not part of what the text is shaped as.

underline_color: Option<Color>

The underline’s own colour; None is the text’s (backlog K4).

underline_style: UnderlineStyle

The underline’s shape: a line, a wave, dots (backlog K4).

strikethrough: bool

A line through every glyph, where the face puts its strikeout.

Implementations

impl TextStyle

pub fn new(size: f32) -> TextStyle

pub fn underline(self) -> TextStyle

pub fn underline_color(self, c: Color) -> TextStyle

An underline in its own colour rather than the text’s — a diagnostic’s red under keyword-coloured text (backlog K4). Turns the underline on.

pub fn underline_style(self, s: UnderlineStyle) -> TextStyle

An underline of this shape (backlog K4). Turns the underline on.

pub fn strikethrough(self) -> TextStyle

pub fn features(self, f: FontFeatures) -> TextStyle

OpenType features for the shaper; see FontFeatures.

pub fn family(self, f: FontFamily) -> TextStyle

pub fn mono(self) -> TextStyle

pub fn font(self, id: FontId) -> TextStyle

Shape with a registered font (see FontFamily::Custom).

pub fn line_height(self, lh: f32) -> TextStyle

pub fn wrap(self, wrap: TextWrap) -> TextStyle

pub fn nowrap(self) -> TextStyle

One line per paragraph, clipped to the node (TextWrap::None).

pub fn max_lines(self, n: u32) -> TextStyle

Lay out at most n lines (0 = unlimited).

pub fn ellipsis(self) -> TextStyle

Truncate with “…” instead of overflowing: a single line unless max_lines says otherwise.

pub fn color(self, c: Color) -> TextStyle

pub fn or_fg(self, fg: Color) -> TextStyle

This style with fg where it named no colour of its own: what the core stamps on as the text enters the tree, so the shaping caches, the display list and every binding see a resolved colour and never the question mark (ADR 0019).

pub fn color_or_default(&self) -> Color

The colour this style paints in, falling back to what kui painted before there were themes. For the handful of places that hold a style the core never stamped.

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 Copy for TextStyle

impl Debug for TextStyle

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

Formats the value using the given formatter.

impl Default for TextStyle

fn default() -> TextStyle

Returns the “default value” for a type.

impl PartialEq for TextStyle

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TextStyle