pango.glyph_item_iter

Module for [GlyphItemIter] class

Types 1

classGlyphItemIter : gobject.boxed.Boxed

A pango.glyph_item_iter.GlyphItemIter is an iterator over the clusters in a pango.glyph_item.GlyphItem.

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.GlyphItemIter.initStart or pango.glyph_item_iter.GlyphItemIter.initEnd, for forward and backward iteration respectively, and walked over using any desired mixture of pango.glyph_item_iter.GlyphItemIter.nextCluster and pango.glyph_item_iter.GlyphItemIter.prevCluster.

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 pango.glyph_item_iter.GlyphItemIter should be modified manually.

Methods

void * _cPtr(Flag!"Dup" dup = No.Dup) nothrow

GType _getGType() static nothrow

GType _gType() @property nothrow

GlyphItemIter self() nothrowReturns `this`, for use in `with` statements.

pango.glyph_item.GlyphItem glyphItem() @property nothrow

void glyphItem(pango.glyph_item.GlyphItem propval) @property nothrow

string text() @property nothrow

void text(string propval) @property nothrow

int startGlyph() @property nothrow

void startGlyph(int propval) @property nothrow

int startIndex() @property nothrow

void startIndex(int propval) @property nothrow

int startChar() @property nothrow

void startChar(int propval) @property nothrow

int endGlyph() @property nothrow

void endGlyph(int propval) @property nothrow

int endIndex() @property nothrow

void endIndex(int propval) @property nothrow

int endChar() @property nothrow

void endChar(int propval) @property nothrow

pango.glyph_item_iter.GlyphItemIter copy() nothrowMake a shallow copy of an existing [pango.glyph_item_iter.GlyphItemIter] structure. Returns: the newly allocated [pango.glyph_item_iter.GlyphItemIter]

bool initEnd(pango.glyph_item.GlyphItem glyphItem, string text) nothrowInitializes a [pango.glyph_item_iter.GlyphItemIter] structure to point to the last cluster in a glyph item.

bool initStart(pango.glyph_item.GlyphItem glyphItem, string text) nothrowInitializes a [pango.glyph_item_iter.GlyphItemIter] structure to point to the first cluster in a glyph item.

bool nextCluster() nothrowAdvances the iterator to the next cluster in the glyph item.

bool prevCluster() nothrowMoves the iterator to the preceding cluster in the glyph item. See [pango.glyph_item_iter.GlyphItemIter] for details of cluster orders. Returns: true if the iterator was moved, false if we were alr...

Constructors

this(pango.glyph_item.GlyphItem glyphItem =  pango.glyph_item.GlyphItem.init,  string text =  string.init,  int  startGlyph =  int.init,  int  startIndex =  int.init,  int  startChar =  int.init,  int  endGlyph =  int.init,  int  endIndex =  int.init,  int  endChar =  int.init)

Create a `glyph_item_iter.GlyphItemIter` boxed type. Params: glyphItem = text = startGlyph = startIndex = startChar = endGlyph = endIndex = endChar =

this(void * ptr, Flag!"Take" take)