Pango.GlyphItemIter

Fields

Name	Type	Access	Description
end_char	int	r/w
end_glyph	int	r/w
end_index	int	r/w
glyph_item	Pango.GlyphItem	r/w
start_char	int	r/w
start_glyph	int	r/w
start_index	int	r/w
text	str	r/w

Methods

	copy ()
	free ()
	init_end (glyph_item, text)
	init_start (glyph_item, text)
	next_cluster ()
	prev_cluster ()

Details

class Pango.GlyphItemIter

A Pango.GlyphItemIter is an iterator over the clusters in a Pango.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 of Pango.GlyphItemIter.init_start() and Pango.GlyphItemIter.init_end(), for forward and backward iteration respectively, and walked over using any desired mixture of Pango.GlyphItemIter.next_cluster() and Pango.GlyphItemIter.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 Pango.GlyphItemIter should be modified manually.

New in version 1.22.

copy()

Returns:the newly allocated Pango.GlyphItemIter, which should be freed with Pango.GlyphItemIter.free(), or None if self was None. Return type:Pango.GlyphItemIter or None

Make a shallow copy of an existing Pango.GlyphItemIter structure.

New in version 1.22.

free()

Frees a Pango.GlyphItemIter created by Pango.GlyphItemIter.copy().

New in version 1.22.

init_end(glyph_item, text)

Parameters:

• glyph_item (Pango.GlyphItem) – the glyph item to iterate over
• text (str) – text corresponding to the glyph item

Returns:

False if there are no clusters in the glyph item

Return type:

bool

Initializes a Pango.GlyphItemIter structure to point to the last cluster in a glyph item. See Pango.GlyphItemIter for details of cluster orders.

New in version 1.22.

init_start(glyph_item, text)

Parameters:

• glyph_item (Pango.GlyphItem) – the glyph item to iterate over
• text (str) – text corresponding to the glyph item

Returns:

False if there are no clusters in the glyph item

Return type:

bool

Initializes a Pango.GlyphItemIter structure to point to the first cluster in a glyph item. See Pango.GlyphItemIter for details of cluster orders.

New in version 1.22.

next_cluster()

Returns:True if the iterator was advanced, False if we were already on the last cluster. Return type:bool

Advances the iterator to the next cluster in the glyph item. See Pango.GlyphItemIter for details of cluster orders.

New in version 1.22.

prev_cluster()

Returns:True if the iterator was moved, False if we were already on the first cluster. Return type:bool

Moves the iterator to the preceding cluster in the glyph item. See Pango.GlyphItemIter for details of cluster orders.

New in version 1.22.