class: PangoGlyphItemIter

[34:7] extends: object

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.

Members

handleObj
lib
retainedCallbacks
signalHandlerNames
signalSetterHandlers

Methods

PangoGlyphItemIter (Handle = null)

Creates a new GlyphItemIter 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.
copy ()

Make a shallow copy of an existing PangoGlyphItemIter structure.
- @r the newly allocated PangoGlyphItemIter.
free ()

Frees a PangoGlyphItemIter.
- @r None.
init_end (object glyph_item, string text)

Initializes a PangoGlyphItemIter structure to point to the last cluster in a glyph item. See PangoGlyphItemIter for details of cluster orders.
- @p glyph_item is the glyph item to iterate over.
- @p text is text corresponding to the glyph item.
- @r %FALSE if there are no clusters in the glyph item.
init_start (object glyph_item, string text)

Initializes a PangoGlyphItemIter structure to point to the first cluster in a glyph item. See PangoGlyphItemIter for details of cluster orders.
- @p glyph_item is the glyph item to iterate over.
- @p text is text corresponding to the glyph item.
- @r %FALSE if there are no clusters in the glyph item.
next_cluster ()

Advances the iterator to the next cluster in the glyph item. See PangoGlyphItemIter for details of cluster orders.
- @r %TRUE if the iterator was advanced, %FALSE if we were already on the last cluster..
prev_cluster ()

Moves the iterator to the preceding cluster in the glyph item. See PangoGlyphItemIter for details of cluster orders.
- @r %TRUE if the iterator was moved, %FALSE if we were already on the first cluster..