package ocgtk

  1. Overview
  2. Docs
OCaml bindings for GTK 4

Install 

dune-project
 Dependency

github.com Edit opam file Versions (2)

Authors

  1. C
    Chris Armstrong

Maintainers

  1. H
    hello@chrisarmstrong.dev

Sources

v0.1-preview2.tar.gz
sha256=4e50fdb5093136a10fc8ffbe388e44cbcb70d52f8afdd48863ec7e22580ff054

doc/ocgtk.pango/Ocgtk_pango/Pango/Wrappers/Glyph_item_iter/index.html

Module Wrappers.Glyph_item_iter

type t = [ `glyph_item_iter ] Gobject.obj

A `PangoGlyphItemIter` is an iterator over the clusters in a `PangoGlyphItem`.

The *forward direction* of the iterator is the logical direction of text. That is, with increasing @start_index and @start_char values. If @glyph_item is right-to-left (that is, if `glyph_item->item->analysis.level` is odd), then @start_glyph decreases as the iterator moves forward. Moreover, in right-to-left cases, @start_glyph is greater than @end_glyph.

An iterator should be initialized using either pango_glyph_item_iter_init_start() or pango_glyph_item_iter_init_end(), for forward and backward iteration respectively, and walked over using any desired mixture of pango_glyph_item_iter_next_cluster() and pango_glyph_item_iter_prev_cluster().

A common idiom for doing a forward iteration over the clusters is:

``` PangoGlyphItemIter cluster_iter; gboolean have_cluster;

for (have_cluster = pango_glyph_item_iter_init_start (&cluster_iter, glyph_item, text); have_cluster; have_cluster = pango_glyph_item_iter_next_cluster (&cluster_iter)) ... ```

Note that @text is the start of the text for layout, which is then indexed by `glyph_item->item->offset` to get to the text of @glyph_item. The @start_index and @end_index values can directly index into @text. The @start_glyph, @end_glyph, @start_char, and @end_char values however are zero-based for the @glyph_item. For each cluster, the item pointed at by the start variables is included in the cluster while the one pointed at by end variables is not.

None of the members of a `PangoGlyphItemIter` should be modified manually.

val prev_cluster : t -> bool

Moves the iterator to the preceding cluster in the glyph item. See `PangoGlyphItemIter` for details of cluster orders.

val next_cluster : t -> bool

Advances the iterator to the next cluster in the glyph item.

See `PangoGlyphItemIter` for details of cluster orders.

val init_start : t -> [ `glyph_item ] Gobject.obj -> string -> bool

Initializes a `PangoGlyphItemIter` structure to point to the first cluster in a glyph item.

See `PangoGlyphItemIter` for details of cluster orders.

val init_end : t -> [ `glyph_item ] Gobject.obj -> string -> bool

Initializes a `PangoGlyphItemIter` structure to point to the last cluster in a glyph item.

See `PangoGlyphItemIter` for details of cluster orders.

val get_type : unit -> Gobject.Type.t