Functions

context_get_font_options (context)

context_get_resolution (context)

context_set_font_options (context, options)

context_set_resolution (context, dpi)

context_set_shape_renderer (context, func, *data)

create_context (cr)

create_layout (cr)

error_underline_path (cr, x, y, width, height)

font_map_get_default ()

font_map_new ()

font_map_new_for_font_type (fonttype)

glyph_string_path (cr, font, glyphs)

layout_line_path (cr, line)

layout_path (cr, layout)

show_error_underline (cr, x, y, width, height)

show_glyph_item (cr, text, glyph_item)

show_glyph_string (cr, font, glyphs)

show_layout (cr, layout)

show_layout_line (cr, line)

update_context (cr, context)

update_layout (cr, layout)

Details

PangoCairo.context_get_font_options(context)[source]
Parameters:

context (Pango.Context) – a PangoContext, from a pangocairo font map

Returns:

the font options previously set on the context, or None if no options have been set. This value is owned by the context and must not be modified or freed.

Return type:

cairo.FontOptions or None

Retrieves any font rendering options previously set with [func`PangoCairo`.context_set_font_options].

This function does not report options that are derived from the target surface by [func`update_context`].

New in version 1.10.

PangoCairo.context_get_resolution(context)[source]
Parameters:

context (Pango.Context) – a PangoContext, from a pangocairo font map

Returns:

the resolution in “dots per inch”. A negative value will be returned if no resolution has previously been set.

Return type:

float

Gets the resolution for the context.

See [func`PangoCairo`.context_set_resolution]

New in version 1.10.

PangoCairo.context_set_font_options(context, options)[source]
Parameters:

  • context (Pango.Context) – a PangoContext, from a pangocairo font map

  • options (cairo.FontOptions or None) – a cairo_font_options_t, or None to unset any previously set options. A copy is made.

Sets the font options used when rendering text with this context.

These options override any options that [func`update_context`] derives from the target surface.

New in version 1.10.

PangoCairo.context_set_resolution(context, dpi)[source]
Parameters:

  • context (Pango.Context) – a PangoContext, from a pangocairo font map

  • dpi (float) – the resolution in “dots per inch”. (Physical inches aren’t actually involved; the terminology is conventional.) A 0 or negative value means to use the resolution from the font map.

Sets the resolution for the context.

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

New in version 1.10.

PangoCairo.context_set_shape_renderer(context, func, *data)[source]
Parameters:

Sets callback function for context to use for rendering attributes of type Pango.AttrType.SHAPE.

See PangoCairoShapeRendererFunc for details.

New in version 1.18.

PangoCairo.create_context(cr)[source]
Parameters:

cr (cairo.Context) – a Cairo context

Returns:

the newly created PangoContext

Return type:

Pango.Context

Creates a context object set up to match the current transformation and target surface of the Cairo context.

This context can then be used to create a layout using [ctor`Pango`.Layout.new].

This function is a convenience function that creates a context using the default font map, then updates it to cr. If you just need to create a layout for use with cr and do not need to access PangoContext directly, you can use [func`create_layout`] instead.

New in version 1.22.

PangoCairo.create_layout(cr)[source]
Parameters:

cr (cairo.Context) – a Cairo context

Returns:

the newly created PangoLayout

Return type:

Pango.Layout

Creates a layout object set up to match the current transformation and target surface of the Cairo context.

This layout can then be used for text measurement with functions like [method`Pango`.Layout.get_size] or drawing with functions like [func`show_layout`]. If you change the transformation or target surface for cr, you need to call [func`update_layout`].

This function is the most convenient way to use Cairo with Pango, however it is slightly inefficient since it creates a separate PangoContext object for each layout. This might matter in an application that was laying out large amounts of text.

New in version 1.10.

PangoCairo.error_underline_path(cr, x, y, width, height)[source]
Parameters:

  • cr (cairo.Context) – a Cairo context

  • x (float) – The X coordinate of one corner of the rectangle

  • y (float) – The Y coordinate of one corner of the rectangle

  • width (float) – Non-negative width of the rectangle

  • height (float) – Non-negative height of the rectangle

Add a squiggly line to the current path in the specified cairo context that approximately covers the given rectangle in the style of an underline used to indicate a spelling error.

The width of the underline is rounded to an integer number of up/down segments and the resulting rectangle is centered in the original rectangle.

New in version 1.14.

PangoCairo.font_map_get_default()[source]
Returns:

the default PangoCairo fontmap for the current thread. This object is owned by Pango and must not be freed.

Return type:

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 [method`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.

New in version 1.10.

PangoCairo.font_map_new()[source]
Returns:

the newly allocated PangoFontMap, which should be freed with GObject.Object.unref().

Return type:

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, None is returned. Ie. this is only useful for testing, when at least two backends are compiled in.

New in version 1.10.

PangoCairo.font_map_new_for_font_type(fonttype)[source]
Parameters:

fonttype (cairo.FontType) – desired cairo.FontType

Returns:

the newly allocated PangoFontMap of suitable type which should be freed with GObject.Object.unref(), or None if the requested cairo font backend is not supported / compiled in.

Return type:

Pango.FontMap or 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 [func`PangoCairo`.FontMap.new], or in fact in most of those cases, just use [func`PangoCairo`.FontMap.get_default].

New in version 1.18.

PangoCairo.glyph_string_path(cr, font, glyphs)[source]
Parameters:

Adds the glyphs in glyphs to the current path in the specified cairo context.

The origin of the glyphs (the left edge of the baseline) will be at the current point of the cairo context.

New in version 1.10.

PangoCairo.layout_line_path(cr, line)[source]
Parameters:

Adds the text in PangoLayoutLine to the current path in the specified cairo context.

The origin of the glyphs (the left edge of the line) will be at the current point of the cairo context.

New in version 1.10.

PangoCairo.layout_path(cr, layout)[source]
Parameters:

Adds the text in a PangoLayout to the current path in the specified cairo context.

The top-left corner of the PangoLayout will be at the current point of the cairo context.

New in version 1.10.

PangoCairo.show_error_underline(cr, x, y, width, height)[source]
Parameters:

  • cr (cairo.Context) – a Cairo context

  • x (float) – The X coordinate of one corner of the rectangle

  • y (float) – The Y coordinate of one corner of the rectangle

  • width (float) – Non-negative width of the rectangle

  • height (float) – Non-negative height of the rectangle

Draw a squiggly line in the specified cairo context that approximately covers the given rectangle in the style of an underline used to indicate a spelling error.

The width of the underline is rounded to an integer number of up/down segments and the resulting rectangle is centered in the original rectangle.

New in version 1.14.

PangoCairo.show_glyph_item(cr, text, glyph_item)[source]
Parameters:

Draws the glyphs in glyph_item in the specified cairo context,

embedding the text associated with the glyphs in the output if the output format supports it (PDF for example), otherwise it acts similar to [func`show_glyph_string`].

The origin of the glyphs (the left edge of the baseline) will be drawn at the current point of the cairo context.

Note that text is the start of the text for layout, which is then indexed by glyph_item->item->offset.

New in version 1.22.

PangoCairo.show_glyph_string(cr, font, glyphs)[source]
Parameters:

Draws the glyphs in glyphs in the specified cairo context.

The origin of the glyphs (the left edge of the baseline) will be drawn at the current point of the cairo context.

New in version 1.10.

PangoCairo.show_layout(cr, layout)[source]
Parameters:

Draws a PangoLayout in the specified cairo context.

The top-left corner of the PangoLayout will be drawn at the current point of the cairo context.

New in version 1.10.

PangoCairo.show_layout_line(cr, line)[source]
Parameters:

Draws a PangoLayoutLine in the specified cairo context.

The origin of the glyphs (the left edge of the line) will be drawn at the current point of the cairo context.

New in version 1.10.

PangoCairo.update_context(cr, context)[source]
Parameters:

Updates a PangoContext previously created for use with Cairo to match the current transformation and target surface of a Cairo context.

If any layouts have been created for the context, it’s necessary to call [method`Pango`.Layout.context_changed] on those layouts.

New in version 1.10.

PangoCairo.update_layout(cr, layout)[source]
Parameters:

Updates the private PangoContext of a PangoLayout created with [func`create_layout`] to match the current transformation and target surface of a Cairo context.

New in version 1.10.