pango/org.gtkkn.bindings.pango/LayoutIter

LayoutIter

class LayoutIter(pointer: <Error class: unknown class><<Error class: unknown class>>)

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.

Skipped during bindings generation

  • parameter y0_: y0_: Out parameter is not supported

  • method get_run: Return type LayoutRun is unsupported

  • method get_run_readonly: Return type LayoutRun is unsupported

Constructors

Link copied to clipboard
constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val pangoLayoutIterPointer: <Error class: unknown class><<Error class: unknown class>>

Functions

Link copied to clipboard
fun atLastLine(): Boolean

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

Link copied to clipboard
fun copy(): LayoutIter?

Copies a PangoLayoutIter.

Link copied to clipboard
fun free()

Frees an iterator that's no longer in use.

Link copied to clipboard
fun getBaseline(): Int

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

Link copied to clipboard
fun getCharExtents(logicalRect: Rectangle)

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

Link copied to clipboard
fun getClusterExtents(inkRect: Rectangle?, logicalRect: Rectangle?)

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

Link copied to clipboard
fun getIndex(): Int

Gets the current byte index.

Link copied to clipboard
fun getLayout(): Layout

Gets the layout associated with a PangoLayoutIter.

Link copied to clipboard
fun getLayoutExtents(inkRect: Rectangle?, logicalRect: Rectangle?)

Obtains the extents of the PangoLayout being iterated over.

Link copied to clipboard
fun getLine(): LayoutLine

Gets the current line.

Link copied to clipboard
fun getLineExtents(inkRect: Rectangle?, logicalRect: Rectangle?)

Obtains the extents of the current line.

Link copied to clipboard
fun getLineReadonly(): LayoutLine

Gets the current line for read-only access.

Link copied to clipboard
fun getRunBaseline(): Int

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

Link copied to clipboard
fun getRunExtents(inkRect: Rectangle?, logicalRect: Rectangle?)

Gets the extents of the current run in layout coordinates.

Link copied to clipboard
fun nextChar(): Boolean

Moves @iter forward to the next character in visual order.

Link copied to clipboard
fun nextCluster(): Boolean

Moves @iter forward to the next cluster in visual order.

Link copied to clipboard
fun nextLine(): Boolean

Moves @iter forward to the start of the next line.

Link copied to clipboard
fun nextRun(): Boolean

Moves @iter forward to the next run in visual order.