LayoutIter
Object Hierarchy:
Description:
[ CCode ( copy_function = "g_boxed_copy" , free_function = "g_boxed_free" , type_id = "pango_layout_iter_get_type ()" ) ]
[ Compact ]
public class LayoutIter
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.
Content:
Methods:
- public bool at_last_line ()
Determines whether this is on the
last line of the layout.
- public LayoutIter? copy ()
Copies a `PangoLayoutIter`.
- public void free ()
Frees an iterator that's no longer in use.
- public int get_baseline ()
Gets the Y position of the current line's baseline, in layout
coordinates.
- public Rectangle get_char_extents ()
Gets the extents of the current character, in layout coordinates.
- public void get_cluster_extents (out Rectangle ink_rect, out Rectangle logical_rect)
Gets the extents of the current cluster, in layout coordinates.
- public int get_index ()
Gets the current byte index.
- public unowned Layout get_layout ()
Gets the layout associated with a `PangoLayoutIter`.
- public void get_layout_extents (out Rectangle ink_rect, out Rectangle logical_rect)
Obtains the extents of the `PangoLayout` being iterated over.
- public unowned LayoutLine get_line ()
Gets the current line.
- public void get_line_extents (out Rectangle ink_rect, out Rectangle logical_rect)
Obtains the extents of the current line.
- public unowned LayoutLine get_line_readonly ()
Gets the current line for read-only access.
- public void get_line_yrange (out int y0_, out int y1_)
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.
- public unowned LayoutRun? get_run ()
Gets the current run.
- public int get_run_baseline ()
Gets the Y position of the current run's baseline, in layout
coordinates.
- public void get_run_extents (out Rectangle ink_rect, out Rectangle logical_rect)
Gets the extents of the current run in layout coordinates.
- public unowned LayoutRun? get_run_readonly ()
Gets the current run for read-only access.
- public bool next_char ()
Moves this forward to the next
character in visual order.
- public bool next_cluster ()
Moves this forward to the next
cluster in visual order.
- public bool next_line ()
Moves this forward to the start of
the next line.
- public bool next_run ()
Moves this forward to the next run
in visual order.