Struct kas_text::fonts::Database

pub struct Database { /* fields omitted */ }

Manages the list of available fonts and font selection

This database exists as a singleton, accessible through the fonts function.

After initialisation font loading and alias adjustment is disabled. The reason for this is that font selection uses multiple caches and there is no mechanism for forcing fresh lookups everywhere.

Implementations

impl Database

pub fn db(&self) -> &Database

Access the database

pub fn families_upper(&self) -> impl Iterator<Item = &str>

Access the list of discovered font families

All family names are uppercase.

pub fn alias_keys(&self) -> impl Iterator<Item = &str>

List all font family alias keys

All family names are uppercase.

pub fn aliases_of(&self, family: &str) -> Option<impl Iterator<Item = &str>>

List all aliases for the given family

The family parameter must be upper case (or no matches will be found). All returned family names are uppercase.

pub fn font_family_from_alias(&self, family: &str) -> Option<String>

Resolve the substituted font family name for this family

The input must be upper case. The output will be the loaded font’s case. Example: SANS-SERIF

pub fn add_aliases<I>(
    &mut self,
    family: Cow<'static, str>,
    aliases: I,
    mode: AddMode
) where
    I: Iterator<Item = Cow<'static, str>>, 

Add font aliases for family

When searching for family, all aliases will be searched too. Both the family parameter and all aliases are converted to upper case.

This method may only be used before init; if used afterwards, only a warning will be issued.

pub fn set_load_system_fonts(&mut self, load: bool)

Control whether system fonts will be loaded on init

Default value: true

pub fn load_font_data(&mut self, data: Vec<u8>)

Loads a font data into the Database.

Will load all font faces in case of a font collection.

This method may only be used before init; if used afterwards, only a warning will be issued. By default, system fonts are loaded on init.

pub fn load_font_file<P: AsRef<Path>>(&mut self, path: P) -> Result<(), Error>

Loads a font file into the Database.

Will load all font faces in case of a font collection.

This method may only be used before init; if used afterwards, only a warning will be issued. By default, system fonts are loaded on init.

pub fn load_fonts_dir<P: AsRef<Path>>(&mut self, dir: P)

Loads font files from the selected directory into the Database.

This method will scan directories recursively.

Will load ttf, otf, ttc and otc fonts.

Unlike other load_* methods, this one doesn’t return an error. It will simply skip malformed fonts and will print a warning into the log for each of them.

This method may only be used before init; if used afterwards, only a warning will be issued. By default, system fonts are loaded on init.