GlyphItemIter

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.

class GlyphItemIter : Boxed {

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

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

void* cPtr(Flag!"Dup" dup);

static GType getGType();

GType gType [@property getter];

GlyphItemIter self();

pango.glyph_item.GlyphItem glyphItem [@property getter];

pango.glyph_item.GlyphItem glyphItem [@property setter];

string text [@property getter];

string text [@property setter];

int startGlyph [@property getter];

int startGlyph [@property setter];

int startIndex [@property getter];

int startIndex [@property setter];

int startChar [@property getter];

int startChar [@property setter];

int endGlyph [@property getter];

int endGlyph [@property setter];

int endIndex [@property getter];

int endIndex [@property setter];

int endChar [@property getter];

int endChar [@property setter];

pango.glyph_item_iter.GlyphItemIter copy();

bool initEnd(pango.glyph_item.GlyphItem glyphItem, string text);

bool initStart(pango.glyph_item.GlyphItem glyphItem, string text);

bool nextCluster();

bool prevCluster();

}

Constructors

this this(pango.glyph_item.GlyphItem glyphItem, string text, int startGlyph, int startIndex, int startChar, int endGlyph, int endIndex, int endChar): Create a glyph_item_iter.GlyphItemIter boxed type.
this this(void* ptr, Flag!"Take" take)

Members

Functions

cPtr void* cPtr(Flag!"Dup" dup)
copy pango.glyph_item_iter.GlyphItemIter copy(): Make a shallow copy of an existing pango.glyph_item_iter.GlyphItemIter structure.
initEnd bool initEnd(pango.glyph_item.GlyphItem glyphItem, string text): Initializes a pango.glyph_item_iter.GlyphItemIter structure to point to the last cluster in a glyph item.
initStart bool initStart(pango.glyph_item.GlyphItem glyphItem, string text): Initializes a pango.glyph_item_iter.GlyphItemIter structure to point to the first cluster in a glyph item.
nextCluster bool nextCluster(): Advances the iterator to the next cluster in the glyph item.
prevCluster bool prevCluster(): Moves the iterator to the preceding cluster in the glyph item. See pango.glyph_item_iter.GlyphItemIter for details of cluster orders.
self GlyphItemIter self(): Returns this, for use in with statements.

Properties

endChar int endChar [@property getter]
endChar int endChar [@property setter]
endGlyph int endGlyph [@property getter]
endGlyph int endGlyph [@property setter]
endIndex int endIndex [@property getter]
endIndex int endIndex [@property setter]
gType GType gType [@property getter]
glyphItem pango.glyph_item.GlyphItem glyphItem [@property getter]
glyphItem pango.glyph_item.GlyphItem glyphItem [@property setter]
startChar int startChar [@property getter]
startChar int startChar [@property setter]
startGlyph int startGlyph [@property getter]
startGlyph int startGlyph [@property setter]
startIndex int startIndex [@property getter]
startIndex int startIndex [@property setter]
text string text [@property getter]
text string text [@property setter]

Static functions

getGType GType getGType()

Inherited Members

From Boxed

cInstancePtr void* cInstancePtr;: Pointer to the C boxed value
getType GType getType(): Get the GType of this boxed type.
gType GType gType [@property getter]: Boxed GType property.
self Boxed self(): Convenience method to return this cast to a type. For use in D with statements.
copy_ void* copy_(): Make a copy of the wrapped C boxed data.
boxedCopy void* boxedCopy(void* cBoxed): Copy a C boxed value using g_boxed_copy.
boxedFree void boxedFree(void* cBoxed): Free a C boxed value using g_boxed_free.

pango glyph_item_iter classes

GlyphItemIter