pango.layout_iter

Module for [LayoutIter] class

class LayoutIter

Types 1

classLayoutIter : gobject.boxed.Boxed

A [pango.layout_iter.LayoutIter] can be used to iterate over the visual extents of a [pango.layout.Layout].

To obtain a [pango.layout_iter.LayoutIter], use [pango.layout.Layout.getIter].

The [pango.layout_iter.LayoutIter] structure is opaque, and has no user-visible fields.

Methods

void * _cPtr(Flag!"Dup" dup = No.Dup)

GType _getGType()

GType _gType() @property

LayoutIter self()Returns `this`, for use in `with` statements.

bool atLastLine()Determines whether iter is on the last line of the layout. Returns: true if iter is on the last line

pango.layout_iter.LayoutIter copy()Copies a [pango.layoutiter.LayoutIter]. Returns: the newly allocated [pango.layoutiter.LayoutIter]

int getBaseline()Gets the Y position of the current line's baseline, in layout coordinates.

void getCharExtents(out pango.types.Rectangle logicalRect)Gets the extents of the current character, in layout coordinates.

void getClusterExtents(out pango.types.Rectangle inkRect, out pango.types.Rectangle logicalRect)Gets the extents of the current cluster, in layout coordinates.

int getIndex()Gets the current byte index.

pango.layout.Layout getLayout()Gets the layout associated with a [pango.layout_iter.LayoutIter]. Returns: the layout associated with iter

void getLayoutExtents(out pango.types.Rectangle inkRect, out pango.types.Rectangle logicalRect)Obtains the extents of the [pango.layout.Layout] being iterated over.

pango.layout_line.LayoutLine getLine()Gets the current line.

void getLineExtents(out pango.types.Rectangle inkRect, out pango.types.Rectangle logicalRect)Obtains the extents of the current line.

pango.layout_line.LayoutLine getLineReadonly()Gets the current line for read-only access.

void getLineYrange(out int y0, out int y1)Divides the vertical space in the [pango.layout.Layout] being iterated over between the lines in the layout, and returns the space belonging to the current line.

pango.types.LayoutRun getRun()Gets the current run.

int getRunBaseline()Gets the Y position of the current run's baseline, in layout coordinates.

void getRunExtents(out pango.types.Rectangle inkRect, out pango.types.Rectangle logicalRect)Gets the extents of the current run in layout coordinates.

pango.types.LayoutRun getRunReadonly()Gets the current run for read-only access.

bool nextChar()Moves iter forward to the next character in visual order.

bool nextCluster()Moves iter forward to the next cluster in visual order.

bool nextLine()Moves iter forward to the start of the next line.

bool nextRun()Moves iter forward to the next run in visual order.

Constructors

this(void * ptr, Flag!"Take" take)