Struct FONTS

pub struct FONTS;

Font loading, custom fonts and app font configuration.

Implementations

impl FONTS

pub fn refresh(&self)

Clear cache and notify Refresh in FONT_CHANGED_EVENT.

See the event documentation for more information.

pub fn prune(&self)

Remove all unused fonts from cache.

pub fn generics(&self) -> &'static GenericFonts

Actual name of generic fonts.

pub fn register( &self, custom_font: CustomFont, ) -> ReadOnlyVar<Response<Result<FontFace, FontLoadingError>>, ArcVar<Response<Result<FontFace, FontLoadingError>>>>

Load and register a custom font.

If the font loads correctly a FONT_CHANGED_EVENT notification is scheduled. Fonts sourced from a file are not monitored for changes, you can reload the font by calling register again with the same font name.

The returned response will update once when the font finishes loading with the new font. At minimum the new font will be available on the next update.

pub fn unregister( &self, custom_family: FontName, ) -> ReadOnlyVar<Response<bool>, ArcVar<Response<bool>>>

Removes a custom font family. If the font faces are not in use it is also unloaded.

Returns a response var that updates once with a value that indicates if any custom font was removed.

pub fn list( &self, families: &[FontName], style: FontStyle, weight: FontWeight, stretch: FontStretch, lang: &Lang, ) -> ReadOnlyVar<Response<FontFaceList>, ArcVar<Response<FontFaceList>>>

Gets a font list that best matches the query.

pub fn find( &self, family: &FontName, style: FontStyle, weight: FontWeight, stretch: FontStretch, lang: &Lang, ) -> ReadOnlyVar<Response<Option<FontFace>>, ArcVar<Response<Option<FontFace>>>>

Find a single font face that best matches the query.

pub fn normal( &self, family: &FontName, lang: &Lang, ) -> ReadOnlyVar<Response<Option<FontFace>>, ArcVar<Response<Option<FontFace>>>>

Find a single font face with all normal properties.

pub fn italic( &self, family: &FontName, lang: &Lang, ) -> ReadOnlyVar<Response<Option<FontFace>>, ArcVar<Response<Option<FontFace>>>>

Find a single font face with italic style, normal weight and stretch.

pub fn bold( &self, family: &FontName, lang: &Lang, ) -> ReadOnlyVar<Response<Option<FontFace>>, ArcVar<Response<Option<FontFace>>>>

Find a single font face with bold weight, normal style and stretch.

pub fn custom_fonts(&self) -> Vec<FontName>

Gets all registered font families.

pub fn system_fonts( &self, ) -> ReadOnlyVar<Response<Vec<FontName>>, ArcVar<Response<Vec<FontName>>>>

Query all font families available in the system.

Note that the variable will only update once with the query result, this is not a live view.

pub fn system_font_aa(&self) -> impl Var<FontAntiAliasing>

Gets the system font anti-aliasing config as a read-only var.

The variable updates when the system config changes.