:right-sidebar: True

FontMap
===================================================================

.. currentmodule:: gi.repository.PangoCairo


.. versionadded:: 1.10




.. class:: FontMap(*args, **kwargs)
   :no-contents-entry:






``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
-------

.. rst-class:: interim-class

.. class:: FontMap
   :no-index:


   .. classmethod:: get_default() -> ~gi.repository.Pango.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
      :obj:`~gi.repository.PangoCairo.FontMap.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.


      .. versionadded:: 1.10








   .. method:: get_font_type() -> ~gi.repository.cairo.FontType

      Gets the type of Cairo font backend that ``fontmap`` uses.


      .. versionadded:: 1.18








   .. method:: get_resolution() -> float

      Gets the resolution for the fontmap.

      See :obj:`~gi.repository.PangoCairo.FontMap.set_resolution`\.


      .. versionadded:: 1.10








   .. classmethod:: new() -> ~gi.repository.Pango.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.


      .. versionadded:: 1.10








   .. classmethod:: new_for_font_type() -> ~gi.repository.Pango.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 :obj:`~gi.repository.PangoCairo.FontMap.new`\, or
      in fact in most of those cases, just use :obj:`~gi.repository.PangoCairo.FontMap.get_default`\.


      .. versionadded:: 1.18








   .. method:: 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 :obj:`~gi.repository.PangoCairo.FontMap.new`\.

      A value of :const:`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 :obj:`~gi.repository.PangoCairo.FontMap.new`\.


      .. versionadded:: 1.22








   .. method:: 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).


      .. versionadded:: 1.10





      :param dpi: the resolution in "dots per inch". (Physical inches aren't actually
           involved; the terminology is conventional.)