class: PangoLayoutIter

[15:7] extends: object

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.

Members

handleObj
lib
retainedCallbacks
signalHandlerNames
signalSetterHandlers

Methods

PangoLayoutIter (Handle = null)

Creates a new LayoutIter by wrapping a native handle or another wrapper.
- @p Handle is the native handle or another wrapper whose handle to adopt.
toNativeHandle (Source)

Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.
- @p Source is the raw handle, raw buffer, wrapper, or null.
- @r A raw pointer carrier or null when no pointer is present.
getLib ()

Returns the opened native library for this generated wrapper.
- @r The opened native library.
handle ()

Returns the wrapped NativeHandle.
- @r The wrapped NativeHandle.
isNull ()

Returns true when the wrapped handle is null.
- @r A bool.
describe ()

Returns a small string for debugging generated wrappers.
- @r A string.
at_last_line ()

Determines whether @iter is on the last line of the layout.
- @r %TRUE if @iter is on the last line.
copy ()

Copies a PangoLayoutIter.
- @r the newly allocated PangoLayoutIter.
free ()

Frees an iterator that's no longer in use.
- @r None.
get_baseline ()

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.
- @r baseline of current line.
get_char_extents ()

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.
- @p logical_rect is rectangle to fill with logical extents.
- @r None.
get_cluster_extents ()

Gets the extents of the current cluster, in layout coordinates. Layout coordinates have the origin at the top left of the entire layout.
- @p ink_rect is rectangle to fill with ink extents.
- @p logical_rect is rectangle to fill with logical extents.
- @r None.
get_index ()

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 %NULL run (see [method@Pango.LayoutIter.get_run]).
- @r current byte index.
get_layout ()

Gets the layout associated with a PangoLayoutIter.
- @r the layout associated with @iter.
get_layout_extents ()

Obtains the extents of the PangoLayout being iterated over.
- @p ink_rect is rectangle to fill with ink extents.
- @p logical_rect is rectangle to fill with logical extents.
- @r None.
get_line ()

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.).
- @r the current line.
get_line_extents ()

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].
- @p ink_rect is rectangle to fill with ink extents.
- @p logical_rect is rectangle to fill with logical extents.
- @r None.
get_line_readonly ()

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.).
- @r the current line, that should not be modified.
get_line_yrange ()

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.
- @p y0_ is start of line.
- @p y1_ is end of line.
- @r None.
get_run_baseline ()

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.
get_run_extents ()

Gets the extents of the current run in layout coordinates. Layout coordinates have the origin at the top left of the entire layout.
- @p ink_rect is rectangle to fill with ink extents.
- @p logical_rect is rectangle to fill with logical extents.
- @r None.
next_char ()

Moves @iter forward to the next character in visual order. If @iter was already at the end of the layout, returns %FALSE.
- @r whether motion was possible.
next_cluster ()

Moves @iter forward to the next cluster in visual order. If @iter was already at the end of the layout, returns %FALSE.
- @r whether motion was possible.
next_line ()

Moves @iter forward to the start of the next line. If @iter is already on the last line, returns %FALSE.
- @r whether motion was possible.
next_run ()

Moves @iter forward to the next run in visual order. If @iter was already at the end of the layout, returns %FALSE.
- @r whether motion was possible.