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) nothrow

GType _getGType() static nothrow

GType _gType() @property nothrow

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

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

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

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

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

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

int getIndex() nothrowGets the current byte index.

pango.layout.Layout getLayout() nothrowGets 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) nothrowObtains the extents of the [pango.layout.Layout] being iterated over.

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

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

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

void getLineYrange(out int y0, out int y1) nothrowDivides 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() nothrowGets the current run.

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

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

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

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

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

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

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

Constructors

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