Memory-managed wrapper type.

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

Copies a LayoutIter.

Since: 1.20

Frees an iterator that's no longer in use.

Gets the Y position of the current line's baseline, in layout coordinates (origin at top left of the entire layout).

Gets the extents of the current character, in layout coordinates (origin is 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.

Gets the extents of the current cluster, in layout coordinates (origin is the top left of the entire layout).

Gets the current byte index. Note that iterating forward by char 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 Nothing run (see layoutIterGetRun).

Gets the layout associated with a LayoutIter.

Since: 1.20

Obtains the extents of the Layout being iterated over. inkRect or logicalRect can be Nothing if you aren't interested in them.

Gets the current line.

Use the faster layoutIterGetLineReadonly if you do not plan to modify the contents of the line (glyphs, glyph widths, etc.).

Obtains the extents of the current line. inkRect or logicalRect can be Nothing if you aren't interested in them. Extents are in layout coordinates (origin is the top-left corner of the entire Layout). 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 layoutLineGetExtents.

Gets the current line for read-only access.

This is a faster alternative to layoutIterGetLine, but the user is not expected to modify the contents of the line (glyphs, glyph widths, etc.).

Since: 1.16

Divides the vertical space in the Layout 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 layoutSetSpacing 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.

Gets the current run. When iterating by run, at the end of each line, there's a position with a Nothing run, so this function can return Nothing. The Nothing 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 layoutIterGetRunReadonly if you do not plan to modify the contents of the run (glyphs, glyph widths, etc.).

Gets the extents of the current run in layout coordinates (origin is the top left of the entire layout).

Gets the current run. When iterating by run, at the end of each line, there's a position with a Nothing run, so this function can return Nothing. The Nothing 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 layoutIterGetRun, but the user is not expected to modify the contents of the run (glyphs, glyph widths, etc.).

Since: 1.16

Moves iter forward to the next character in visual order. If iter was already at the end of the layout, returns False.

Moves iter forward to the next cluster in visual order. If iter was already at the end of the layout, returns False.

Moves iter forward to the start of the next line. If iter is already on the last line, returns False.

Moves iter forward to the next run in visual order. If iter was already at the end of the layout, returns False.