Pango.LayoutLine

Fields

Name	Type	Access	Description
is_paragraph_start	int	r/w	True if this is the first line of the paragraph
layout	Pango.Layout	r/w	the layout this line belongs to, might be None
length	int	r/w	length of line in bytes
resolved_dir	int	r/w	#Resolved Pango.Direction of line
runs	[Pango.GlyphItem]	r/w	list of runs in the line, from left to right
start_index	int	r/w	start of line as byte index into layout->text

Methods

	get_extents ()
	get_height ()
	get_length ()
	get_pixel_extents ()
	get_resolved_direction ()
	get_start_index ()
	get_x_ranges (start_index, end_index)
	index_to_x (index_, trailing)
	ref ()
	unref ()
	x_to_index (x_pos)

Details

class Pango.LayoutLine

A PangoLayoutLine represents one of the lines resulting from laying out a paragraph via PangoLayout.

PangoLayoutLine structures are obtained by calling [method`Pango`.Layout.get_line] and are only valid until the text, attributes, or settings of the parent PangoLayout are modified.

get_extents()

Returns:

ink_rect:

rectangle used to store the extents of the glyph string as drawn

logical_rect:

rectangle used to store the logical extents of the glyph string

Return type:

(ink_rect: Pango.Rectangle, logical_rect: Pango.Rectangle)

Computes the logical and ink extents of a layout line.

See [method`Pango`.Font.get_glyph_extents] for details about the interpretation of the rectangles.

get_height()

Returns:

return location for the line height

Return type:

height: int

Computes the height of the line, as the maximum of the heights of fonts used in this line.

Note that the actual baseline-to-baseline distance between lines of text is influenced by other factors, such as [method`Pango`.Layout.set_spacing] and [method`Pango`.Layout.set_line_spacing].

New in version 1.44.

get_length()

Returns:

the length of the line

Return type:

int

Returns the length of the line, in bytes.

New in version 1.50.

get_pixel_extents()

Returns:

ink_rect:

rectangle used to store the extents of the glyph string as drawn

logical_rect:

rectangle used to store the logical extents of the glyph string

Return type:

(ink_rect: Pango.Rectangle, logical_rect: Pango.Rectangle)

Computes the logical and ink extents of self in device units.

This function just calls [method`Pango`.LayoutLine.get_extents] followed by two [func`extents_to_pixels`] calls, rounding ink_rect and logical_rect such that the rounded rectangles fully contain the unrounded one (that is, passes them as first argument to [func`extents_to_pixels`]).

get_resolved_direction()

Returns:

the resolved direction of the line

Return type:

Pango.Direction

Returns the resolved direction of the line.

New in version 1.50.

get_start_index()

Returns:

the start index of the line

Return type:

int

Returns the start index of the line, as byte index into the text of the layout.

New in version 1.50.

get_x_ranges(start_index, end_index)

Parameters:

• start_index (int) – Start byte index of the logical range. If this value is less than the start index for the line, then the first range will extend all the way to the leading edge of the layout. Otherwise, it will start at the leading edge of the first character.

• end_index (int) – Ending byte index of the logical range. If this value is greater than the end index for the line, then the last range will extend all the way to the trailing edge of the layout. Otherwise, it will end at the trailing edge of the last character.

Returns:

location to store a pointer to an array of ranges. The array will be of length 2*n_ranges, with each range starting at (*ranges)[2*n] and of width (*ranges)[2*n + 1] - (*ranges)[2*n]. This array must be freed with GLib.free(). The coordinates are relative to the layout and are in Pango units.

Return type:

ranges: [int]

Gets a list of visual ranges corresponding to a given logical range.

This list is not necessarily minimal - there may be consecutive ranges which are adjacent. The ranges will be sorted from left to right. The ranges are with respect to the left edge of the entire layout, not with respect to the line.

index_to_x(index_, trailing)

Parameters:

• index (int) – byte offset of a grapheme within the layout

• trailing (bool) – an integer indicating the edge of the grapheme to retrieve the position of. If > 0, the trailing edge of the grapheme, if 0, the leading of the grapheme

Returns:

location to store the x_offset (in Pango units)

Return type:

x_pos: int

Converts an index within a line to a X position.

ref()

Returns:

the line passed in.

Return type:

Pango.LayoutLine or None

Increase the reference count of a PangoLayoutLine by one.

New in version 1.10.

unref()

Decrease the reference count of a PangoLayoutLine by one.

If the result is zero, the line and all associated memory will be freed.

x_to_index(x_pos)

Parameters:

x_pos (int) – the X offset (in Pango units) from the left edge of the line.

Returns:

False if x_pos was outside the line, True if inside

index_:

location to store calculated byte index for the grapheme in which the user clicked

trailing:

location to store an integer indicating where in the grapheme the user clicked. It will either be zero, or the number of characters in the grapheme. 0 represents the leading edge of the grapheme.

Return type:

(bool, index_: int, trailing: int)

Converts from x offset to the byte index of the corresponding character within the text of the layout.

If x_pos is outside the line, index_ and trailing will point to the very first or very last position in the line. This determination is based on the resolved direction of the paragraph; for example, if the resolved direction is right-to-left, then an X position to the right of the line (after it) results in 0 being stored in index_ and trailing. An X position to the left of the line results in index_ pointing to the (logical) last grapheme in the line and trailing being set to the number of characters in that grapheme. The reverse is true for a left-to-right line.