Struct pango::GlyphItemIter

source ·
pub struct GlyphItemIter<'item> { /* private fields */ }
Expand description

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§

source§

impl<'item> GlyphItemIter<'item>

source

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

source

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

source

pub fn next_cluster(&mut self) -> bool

source

pub fn prev_cluster(&mut self) -> bool

source

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

source

pub fn text(&self) -> &GStr

source

pub fn start_glyph(&self) -> i32

source

pub fn start_index(&self) -> i32

source

pub fn start_char(&self) -> i32

source

pub fn end_glyph(&self) -> i32

source

pub fn end_index(&self) -> i32

source

pub fn end_char(&self) -> i32

Trait Implementations§

source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
source§

impl<'item> StaticType for GlyphItemIter<'item>

source§

fn static_type() -> Type

Returns the type identifier of Self.

Auto Trait Implementations§

§

impl<'item> Freeze for GlyphItemIter<'item>

§

impl<'item> RefUnwindSafe for GlyphItemIter<'item>

§

impl<'item> !Send for GlyphItemIter<'item>

§

impl<'item> !Sync for GlyphItemIter<'item>

§

impl<'item> Unpin for GlyphItemIter<'item>

§

impl<'item> UnwindSafe for GlyphItemIter<'item>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> StaticTypeExt for T
where T: StaticType,

source§

fn ensure_type()

Ensures that the type has been registered with the type system.
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.