Struct rckive_genpdf::style::Style

pub struct Style { /* private fields */ }

A style annotation for a string.

The annotation consists of:

• a font family, see FontFamily (defaults to the FontCache default)
• a font size in points (defaults to 12)
• a line spacing factor, with 1 meaning single line spacing (defaults to 1)
• an outline color, see Color (defaults to black)
• a combination of text effects, see Effect (defaults to none)

All properties are optional. If they are not set, they can be inferred from parent styles or from the defaults.

Implementations

impl Style

pub fn new() -> Style

Creates a new style without settings.

pub fn merge(&mut self, style: impl Into<Style>)

Merges the given style into this style.

pub fn and(self, style: impl Into<Style>) -> Style

Combines this style and the given style and returns the result.

pub fn combine(left: impl Into<Style>, right: impl Into<Style>) -> Style

Creates a new style by combining the given styles.

pub fn color(&self) -> Option<Color>

Returns the outline color for this style, if set.

pub fn is_bold(&self) -> bool

Returns whether the bold text effect is set.

pub fn is_italic(&self) -> bool

Returns whether the italic text effect is set.

pub fn font_size(&self) -> u8

Returns the font size for this style in points, or 12 if no font size is set.

pub fn line_spacing(&self) -> f64

Returns the line spacing factor for this style, or 1 if no line spacing factor is set.

pub fn set_bold(&mut self)

Sets the bold effect for this style.

pub fn bold(self) -> Style

Sets the bold effect for this style and returns it.

pub fn set_italic(&mut self)

Sets the italic effect for this style.

pub fn italic(self) -> Style

Sets the italic effect for this style and returns it.

pub fn set_font_family(&mut self, font_family: FontFamily<Font>)

Sets the font family for this style.

pub fn with_font_family(self, font_family: FontFamily<Font>) -> Style

Sets the font family for this style and returns it.

pub fn set_line_spacing(&mut self, line_spacing: f64)

Sets the line spacing factor for this style.

pub fn with_line_spacing(self, line_spacing: f64) -> Style

Sets the line spacing factor for this style and returns it.

pub fn set_font_size(&mut self, font_size: u8)

Sets the font size in points for this style.

pub fn with_font_size(self, font_size: u8) -> Style

Sets the font size in points for this style and returns it.

pub fn set_color(&mut self, color: Color)

Sets the outline color for this style.

pub fn with_color(self, color: Color) -> Self

Sets the outline color for this style and returns it.

pub fn char_width(&self, font_cache: &FontCache, c: char) -> Mm

Calculates the width of the given character with this style using the data in the given font cache.

If the font family is set, it must have been created by the given FontCache.

pub fn char_left_side_bearing(&self, font_cache: &FontCache, c: char) -> Mm

Returns the width of the empty space between the origin of the glyph bounding box and the leftmost edge of the character, for this style using the given font cache.

If the font family is set, it must have been created by the given FontCache.

pub fn str_width(&self, font_cache: &FontCache, s: &str) -> Mm

Calculates the width of the given string with this style using the data in the given font cache.

If the font family is set, it must have been created by the given FontCache.

pub fn font_family(&self, font_cache: &FontCache) -> FontFamily<Font>

Returns the font family for this style or the default font family using the given font cache.

If the font family is set, it must have been created by the given FontCache.

pub fn font(&self, font_cache: &FontCache) -> Font

Returns the font for this style using the given font cache.

If the font family is set, it must have been created by the given FontCache.

pub fn line_height(&self, font_cache: &FontCache) -> Mm

Calculates the line height for strings with this style using the data in the given font cache.

If the font family is set, it must have been created by the given FontCache.

pub fn metrics(&self, font_cache: &FontCache) -> Metrics

Calculate the metrics of the font for this style using the data in the given font cache.

If the font family is set, it must have been created by the given FontCache.

Trait Implementations

impl Clone for Style

fn clone(&self) -> Style

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Style

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

Formats the value using the given formatter.

impl Default for Style

fn default() -> Style

Returns the “default value” for a type.

impl<T: Into<Style>> Extend<T> for Style

fn extend<I: IntoIterator<Item = T>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<Color> for Style

fn from(color: Color) -> Style

Converts to this type from the input type.

impl From<Effect> for Style

fn from(effect: Effect) -> Style

Converts to this type from the input type.

impl From<FontFamily<Font>> for Style

fn from(font_family: FontFamily<Font>) -> Style

Converts to this type from the input type.

impl<T: Into<Style>> FromIterator<T> for Style

fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Style

Creates a value from an iterator.

impl PartialEq<Style> for Style

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for Style

impl StructuralPartialEq for Style