PgGlyphItemIter

A #PangoGlyphItemIter is an iterator over the clusters in a #PangoGlyphItem. The <firstterm>forward direction</firstterm> 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 <literal>@glyph_item->item->analysis.level</literal> 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 of pango_glyph_item_iter_init_start() and 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: <programlisting> 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)) { ... } </programlisting>

Note that @text is the start of the text for layout, which is then indexed by <literal>@glyph_item->item->offset</literal> 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.

final

class PgGlyphItemIter {

protected

PangoGlyphItemIter* pangoGlyphItemIter;

protected

bool ownedRef;

PangoGlyphItemIter* getPgGlyphItemIterStruct(bool transferOwnership);

void* getStruct();

this(PangoGlyphItemIter* pangoGlyphItemIter, bool ownedRef);

~this();

PgGlyphItem glyphItem [@property getter];

PgGlyphItem 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];

static GType getType();

PgGlyphItemIter copy();

void free();

bool initEnd(PgGlyphItem glyphItem, string text);

bool initStart(PgGlyphItem glyphItem, string text);

bool nextCluster();

bool prevCluster();

}

Constructors

this this(PangoGlyphItemIter* pangoGlyphItemIter, bool ownedRef): Sets our main struct and passes it to the parent class.

Destructor

~this ~this(): Undocumented in source.

Members

Functions

copy PgGlyphItemIter copy(): Make a shallow copy of an existing #PangoGlyphItemIter structure.
free void free(): Frees a #PangoGlyphItemIter created by pango_glyph_item_iter_copy().
getPgGlyphItemIterStruct PangoGlyphItemIter* getPgGlyphItemIterStruct(bool transferOwnership): Get the main Gtk struct
getStruct void* getStruct(): the main Gtk struct as a void*
initEnd bool initEnd(PgGlyphItem glyphItem, string text): Initializes a #PangoGlyphItemIter structure to point to the last cluster in a glyph item. See #PangoGlyphItemIter for details of cluster orders.
initStart bool initStart(PgGlyphItem glyphItem, string text): Initializes a #PangoGlyphItemIter structure to point to the first cluster in a glyph item. See #PangoGlyphItemIter for details of cluster orders.
nextCluster bool nextCluster(): Advances the iterator to the next cluster in the glyph item. See #PangoGlyphItemIter for details of cluster orders.
prevCluster bool prevCluster(): Moves the iterator to the preceding cluster in the glyph item. See #PangoGlyphItemIter for details of cluster orders.

Properties

endChar int endChar [@property getter]
int endChar [@property setter]
endGlyph int endGlyph [@property getter]
int endGlyph [@property setter]
endIndex int endIndex [@property getter]
int endIndex [@property setter]
glyphItem PgGlyphItem glyphItem [@property getter]
PgGlyphItem glyphItem [@property setter]
startChar int startChar [@property getter]
int startChar [@property setter]
startGlyph int startGlyph [@property getter]
int startGlyph [@property setter]
startIndex int startIndex [@property getter]
int startIndex [@property setter]
text string text [@property getter]
string text [@property setter]

Static functions

getType GType getType()

Variables

ownedRef bool ownedRef;: Undocumented in source.
pangoGlyphItemIter PangoGlyphItemIter* pangoGlyphItemIter;: the main Gtk struct