Struct GlyphItemIter

pub struct GlyphItemIter<'item> { /* private fields */ }

A GlyphItemIter is an iterator over the clusters in a 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_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 GlyphItemIter should be modified manually.

Implementations

impl<'item> GlyphItemIter<'item>

pub fn new_start( glyph_item: &'item GlyphItem, text: &str, ) -> Result<Self, BoolError>

pub fn new_end( glyph_item: &'item GlyphItem, text: &str, ) -> Result<Self, BoolError>

pub fn next_cluster(&mut self) -> bool

pub fn prev_cluster(&mut self) -> bool

pub fn glyph_item(&self) -> &'item GlyphItem

pub fn text(&self) -> &GStr

pub fn start_glyph(&self) -> i32

pub fn start_index(&self) -> i32

pub fn start_char(&self) -> i32

pub fn end_glyph(&self) -> i32

pub fn end_index(&self) -> i32

pub fn end_char(&self) -> i32

Trait Implementations

impl<'item> Clone for GlyphItemIter<'item>

fn clone(&self) -> GlyphItemIter<'item>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'item> Debug for GlyphItemIter<'item>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'item> IntoIterator for GlyphItemIter<'item>

type Item = (i32, i32, i32, i32, i32, i32)

The type of the elements being iterated over.

type IntoIter = GlyphItemIntoIter<'item>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl StaticType for GlyphItemIter<'_>

fn static_type() -> Type

Returns the type identifier of Self.