Pango.LayoutIter¶

Fields¶

None

Methods¶

	`at_last_line` ()
	`copy` ()
	`free` ()
	`get_baseline` ()
	`get_char_extents` ()
	`get_cluster_extents` ()
	`get_index` ()
	`get_layout` ()
	`get_layout_extents` ()
	`get_line` ()
	`get_line_extents` ()
	`get_line_readonly` ()
	`get_line_yrange` ()
	`get_run` ()
	`get_run_baseline` ()
	`get_run_extents` ()
	`get_run_readonly` ()
	`next_char` ()
	`next_cluster` ()
	`next_line` ()
	`next_run` ()

Details¶

class Pango.LayoutIter¶

A PangoLayoutIter can be used to iterate over the visual extents of a PangoLayout.

To obtain a PangoLayoutIter, use [method`Pango`.Layout.get_iter].

The PangoLayoutIter structure is opaque, and has no user-visible fields.

at_last_line()[source]¶

Returns:: True if self is on the last line
Return type:: bool

Determines whether self is on the last line of the layout.

copy()[source]¶

Returns:: the newly allocated PangoLayoutIter
Return type:: Pango.LayoutIter or None

Copies a PangoLayoutIter.

New in version 1.20.

free()[source]¶: Frees an iterator that’s no longer in use.

get_baseline()[source]¶

Returns:: baseline of current line
Return type:: int

Gets the Y position of the current line’s baseline, in layout coordinates.

Layout coordinates have the origin at the top left of the entire layout.

get_char_extents()[source]¶

Returns:: rectangle to fill with logical extents
Return type:: logical_rect: Pango.Rectangle

Gets the extents of the current character, in layout coordinates.

Layout coordinates have the origin at the top left of the entire layout.

Only logical extents can sensibly be obtained for characters; ink extents make sense only down to the level of clusters.

get_cluster_extents()[source]¶

Returns:

ink_rect:: rectangle to fill with ink extents
logical_rect:: rectangle to fill with logical extents

Return type:

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

Gets the extents of the current cluster, in layout coordinates.

Layout coordinates have the origin at the top left of the entire layout.

get_index()[source]¶

Returns:: current byte index
Return type:: int

Gets the current byte index.

Note that iterating forward by str moves in visual order, not logical order, so indexes may not be sequential. Also, the index may be equal to the length of the text in the layout, if on the None run (see [method`Pango`.LayoutIter.get_run]).

get_layout()[source]¶

Returns:: the layout associated with self
Return type:: Pango.Layout or None

Gets the layout associated with a PangoLayoutIter.

New in version 1.20.

get_layout_extents()[source]¶

Returns:

ink_rect:: rectangle to fill with ink extents
logical_rect:: rectangle to fill with logical extents

Return type:

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

Obtains the extents of the PangoLayout being iterated over.

get_line()[source]¶

Returns:: the current line
Return type:: Pango.LayoutLine or None

Gets the current line.

Use the faster [method`Pango`.LayoutIter.get_line_readonly] if you do not plan to modify the contents of the line (glyphs, glyph widths, etc.).

get_line_extents()[source]¶

Returns:

ink_rect:: rectangle to fill with ink extents
logical_rect:: rectangle to fill with logical extents

Return type:

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

Obtains the extents of the current line.

Extents are in layout coordinates (origin is the top-left corner of the entire PangoLayout). Thus the extents returned by this function will be the same width/height but not at the same x/y as the extents returned from [method`Pango`.LayoutLine.get_extents].

get_line_readonly()[source]¶

Returns:: the current line, that should not be modified
Return type:: Pango.LayoutLine or None

Gets the current line for read-only access.

This is a faster alternative to [method`Pango`.LayoutIter.get_line], but the user is not expected to modify the contents of the line (glyphs, glyph widths, etc.).

New in version 1.16.

get_line_yrange()[source]¶

Returns:

y0_:: start of line
y1_:: end of line

Return type:

(y0_: int, y1_: int)

Divides the vertical space in the PangoLayout being iterated over between the lines in the layout, and returns the space belonging to the current line.

A line’s range includes the line’s logical extents. plus half of the spacing above and below the line, if [method`Pango`.Layout.set_spacing] has been called to set layout spacing. The Y positions are in layout coordinates (origin at top left of the entire layout).

Note: Since 1.44, Pango uses line heights for placing lines, and there may be gaps between the ranges returned by this function.

get_run()[source]¶

Returns:: the current run
Return type:: Pango.GlyphItem or None

Gets the current run.

When iterating by run, at the end of each line, there’s a position with a None run, so this function can return None. The None run at the end of each line ensures that all lines have at least one run, even lines consisting of only a newline.

Use the faster [method`Pango`.LayoutIter.get_run_readonly] if you do not plan to modify the contents of the run (glyphs, glyph widths, etc.).

get_run_baseline()[source]¶

Return type:: int

Gets the Y position of the current run’s baseline, in layout coordinates.

Layout coordinates have the origin at the top left of the entire layout.

The run baseline can be different from the line baseline, for example due to superscript or subscript positioning.

New in version 1.50.

get_run_extents()[source]¶

Returns:

ink_rect:: rectangle to fill with ink extents
logical_rect:: rectangle to fill with logical extents

Return type:

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

Gets the extents of the current run in layout coordinates.

Layout coordinates have the origin at the top left of the entire layout.

get_run_readonly()[source]¶

Returns:: the current run, that should not be modified
Return type:: Pango.GlyphItem or None

Gets the current run for read-only access.

When iterating by run, at the end of each line, there’s a position with a None run, so this function can return None. The None run at the end of each line ensures that all lines have at least one run, even lines consisting of only a newline.

This is a faster alternative to [method`Pango`.LayoutIter.get_run], but the user is not expected to modify the contents of the run (glyphs, glyph widths, etc.).

New in version 1.16.

next_char()[source]¶

Returns:: whether motion was possible
Return type:: bool

Moves self forward to the next character in visual order.

If self was already at the end of the layout, returns False.

next_cluster()[source]¶

Returns:: whether motion was possible
Return type:: bool

Moves self forward to the next cluster in visual order.

If self was already at the end of the layout, returns False.

next_line()[source]¶

Returns:: whether motion was possible
Return type:: bool

Moves self forward to the start of the next line.

If self is already on the last line, returns False.

next_run()[source]¶

Returns:: whether motion was possible
Return type:: bool

Moves self forward to the next run in visual order.

If self was already at the end of the layout, returns False.