Pango.FontMetrics

Fields

Name

Type

Access

Description

approximate_char_width

int

r

approximate_digit_width

int

r

ascent

int

r

descent

int

r

height

int

r

ref_count

int

r

strikethrough_position

int

r

strikethrough_thickness

int

r

underline_position

int

r

underline_thickness

int

r

Methods

get_approximate_char_width ()

get_approximate_digit_width ()

get_ascent ()

get_descent ()

get_height ()

get_strikethrough_position ()

get_strikethrough_thickness ()

get_underline_position ()

get_underline_thickness ()

ref ()

unref ()

Details

class Pango.FontMetrics

A PangoFontMetrics structure holds the overall metric information for a font.

The information in a PangoFontMetrics structure may be restricted to a script. The fields of this structure are private to implementations of a font backend. See the documentation of the corresponding getters for documentation of their meaning.

For an overview of the most important metrics, see:

<picture> <source srcset=”fontmetrics-dark.png” media=”(prefers-color-scheme: dark)”> <img alt=”Font metrics” src=”fontmetrics-light.png”> </picture>

get_approximate_char_width()[source]
Returns:

the character width, in Pango units.

Return type:

int

Gets the approximate character width for a font metrics structure.

This is merely a representative value useful, for example, for determining the initial size for a window. Actual characters in text will be wider and narrower than this.

get_approximate_digit_width()[source]
Returns:

the digit width, in Pango units.

Return type:

int

Gets the approximate digit width for a font metrics structure.

This is merely a representative value useful, for example, for determining the initial size for a window. Actual digits in text can be wider or narrower than this, though this value is generally somewhat more accurate than the result of Pango.FontMetrics.get_approximate_char_width() for digits.

get_ascent()[source]
Returns:

the ascent, in Pango units.

Return type:

int

Gets the ascent from a font metrics structure.

The ascent is the distance from the baseline to the logical top of a line of text. (The logical top may be above or below the top of the actual drawn ink. It is necessary to lay out the text to figure where the ink will be.)

get_descent()[source]
Returns:

the descent, in Pango units.

Return type:

int

Gets the descent from a font metrics structure.

The descent is the distance from the baseline to the logical bottom of a line of text. (The logical bottom may be above or below the bottom of the actual drawn ink. It is necessary to lay out the text to figure where the ink will be.)

get_height()[source]
Returns:

the height, in Pango units

Return type:

int

Gets the line height from a font metrics structure.

The line height is the recommended distance between successive baselines in wrapped text using this font.

If the line height is not available, 0 is returned.

New in version 1.44.

get_strikethrough_position()[source]
Returns:

the suggested strikethrough position, in Pango units.

Return type:

int

Gets the suggested position to draw the strikethrough.

The value returned is the distance *above* the baseline of the top of the strikethrough.

New in version 1.6.

get_strikethrough_thickness()[source]
Returns:

the suggested strikethrough thickness, in Pango units.

Return type:

int

Gets the suggested thickness to draw for the strikethrough.

New in version 1.6.

get_underline_position()[source]
Returns:

the suggested underline position, in Pango units.

Return type:

int

Gets the suggested position to draw the underline.

The value returned is the distance *above* the baseline of the top of the underline. Since most fonts have underline positions beneath the baseline, this value is typically negative.

New in version 1.6.

get_underline_thickness()[source]
Returns:

the suggested underline thickness, in Pango units.

Return type:

int

Gets the suggested thickness to draw for the underline.

New in version 1.6.

ref()[source]
Returns:

self

Return type:

Pango.FontMetrics or None

Increase the reference count of a font metrics structure by one.

unref()[source]

Decrease the reference count of a font metrics structure by one.

If the result is zero, frees the structure and any associated memory.