Struct pango::AttrIterator

#[repr(transparent)]
pub struct AttrIterator { /* private fields */ }

A AttrIterator is used to iterate through a AttrList.

A new iterator is created with AttrList::iterator(). Once the iterator is created, it can be advanced through the style changes in the text using next(). At each style change, the range of the current style segment and the attributes currently in effect can be queried.

Implementations

impl AttrIterator

pub fn get(&mut self, type_: AttrType) -> Option<Attribute>

Find the current attribute of a particular type at the iterator location.

When multiple attributes of the same type overlap, the attribute whose range starts closest to the current location is used.

type_

the type of attribute to find

Returns

the current attribute of the given type, or None if no attribute of that type applies to the current location.

pub fn attrs(&mut self) -> Vec<Attribute>

Gets a list of all attributes at the current position of the iterator.

Returns

a list of all attributes for the current range. To free this value, call Pango::Attribute::destroy() on each value and g_slist_free() on the list.

pub fn next(&mut self) -> bool

Advance the iterator until the next change of style.

Returns

false if the iterator is at the end of the list, otherwise true

pub fn range(&mut self) -> (i32, i32)

Get the range of the current segment.

Note that the stored return values are signed, not unsigned like the values in Attribute. To deal with this API oversight, stored return values that wouldn’t fit into a signed integer are clamped to G_MAXINT.

Returns

start

location to store the start of the range

end

location to store the end of the range

impl AttrIterator

pub fn font( &mut self, desc: &mut FontDescription, language: Option<&Language>, extra_attrs: &[&Attribute] )

Get the font and other attributes at the current iterator position.

desc

a FontDescription to fill in with the current values. The family name in this structure will be set using Pango::FontDescription::set_family_static() using values from an attribute in the AttrList associated with the iterator, so if you plan to keep it around, you must call: pango_font_description_set_family (desc, pango_font_description_get_family (desc)).

Returns

language

location to store language tag for item, or None if none is found.

extra_attrs

location in which to store a list of non-font attributes at the the current position; only the highest priority value of each attribute will be added to this list. In order to free this value, you must call Pango::Attribute::destroy() on each member.

Trait Implementations

impl Clone for AttrIterator

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AttrIterator

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

Formats the value using the given formatter.

impl Hash for AttrIterator

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for AttrIterator

fn cmp(&self, other: &AttrIterator) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<AttrIterator> for AttrIterator

fn eq(&self, other: &AttrIterator) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<AttrIterator> for AttrIterator

fn partial_cmp(&self, other: &AttrIterator) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for AttrIterator

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for AttrIterator

impl StructuralEq for AttrIterator

impl StructuralPartialEq for AttrIterator