FontMap

Added in version 1.10.

class FontMap(*args, **kwargs)

PangoCairoFontMap is an interface exported by font maps for use with Cairo.

The actual type of the font map will depend on the particular font technology Cairo was compiled to use.

Methods

class FontMap

get_default() → FontMap

Gets a default PangoCairoFontMap to use with Cairo.

Note that the type of the returned object will depend on the particular font backend Cairo was compiled to use; you generally should only use the PangoFontMap and PangoCairoFontMap interfaces on the returned object.

The default Cairo fontmap can be changed by using set_default. This can be used to change the Cairo font backend that the default fontmap uses for example.

Note that since Pango 1.32.6, the default fontmap is per-thread. Each thread gets its own default fontmap. In this way, PangoCairo can be used safely from multiple threads.

Added in version 1.10.

get_font_type() → FontType

Gets the type of Cairo font backend that fontmap uses.

Added in version 1.18.

get_resolution() → float

Gets the resolution for the fontmap.

See set_resolution.

Added in version 1.10.

new() → FontMap

Creates a new PangoCairoFontMap object.

A fontmap is used to cache information about available fonts, and holds certain global parameters such as the resolution. In most cases, you can use func``PangoCairo`.font_map_get_default] instead.

Note that the type of the returned object will depend on the particular font backend Cairo was compiled to use; You generally should only use the PangoFontMap and PangoCairoFontMap interfaces on the returned object.

You can override the type of backend returned by using an environment variable %PANGOCAIRO_BACKEND. Supported types, based on your build, are fc (fontconfig), win32, and coretext. If requested type is not available, NULL is returned. Ie. this is only useful for testing, when at least two backends are compiled in.

Added in version 1.10.

new_for_font_type(fonttype: FontType) → FontMap | None

Creates a new PangoCairoFontMap object of the type suitable to be used with cairo font backend of type fonttype.

In most cases one should simply use new, or in fact in most of those cases, just use get_default.

Added in version 1.18.

Parameters:

fonttype – desired FontType

set_default() → None

Sets a default PangoCairoFontMap to use with Cairo.

This can be used to change the Cairo font backend that the default fontmap uses for example. The old default font map is unreffed and the new font map referenced.

Note that since Pango 1.32.6, the default fontmap is per-thread. This function only changes the default fontmap for the current thread. Default fontmaps of existing threads are not changed. Default fontmaps of any new threads will still be created using new.

A value of None for fontmap will cause the current default font map to be released and a new default font map to be created on demand, using new.

Added in version 1.22.

set_resolution(dpi: float) → None

Sets the resolution for the fontmap.

This is a scale factor between points specified in a PangoFontDescription and Cairo units. The default value is 96, meaning that a 10 point font will be 13 units high. (10 * 96. / 72. = 13.3).

Added in version 1.10.

Parameters:

dpi – the resolution in “dots per inch”. (Physical inches aren’t actually involved; the terminology is conventional.)